Skip to content

Commit

Permalink
restructure of pages
Browse files Browse the repository at this point in the history
  • Loading branch information
emjay07 committed Aug 27, 2024
1 parent f1230dc commit 5b211f1
Show file tree
Hide file tree
Showing 9 changed files with 68 additions and 68 deletions.
9 changes: 9 additions & 0 deletions docs/griptape-cloud/data-sources/create-data-source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Data Sources

Use [Data Sources](https://cloud.griptape.ai/data-sources) to connect and ingest your own data for use with your AI applications via [Knowledge Bases](../knowledge-bases/create-knowledge-base.md).

## Create a Data Source

You can [Create a Data Source](https://cloud.griptape.ai/data-sources/create) by specifying the required configuration for your chosen Data Source.

If you do not see a data source configuration you'd wish to use, you can submit a request via [Discord](https://discord.gg/gnWRz88eym) or `[email protected]`.
27 changes: 0 additions & 27 deletions docs/griptape-cloud/data-sources/index.md

This file was deleted.

17 changes: 17 additions & 0 deletions docs/griptape-cloud/data-sources/refresh-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Refresh a Data Source

## Automatic Refresh

By default your Data Source will not refresh automatically. When creating a Data Source, you can enable automatic refresh and specify a [CRON expression](https://crontab.guru/). For example, if you wish your Data Source to refresh every day at midnight you can use the following expression: `0 0 * * *`.

## Manual Refresh

If you wish to manually refresh a data source you can do so either via the `Refresh` button on the UI or by API using the `Data Source ID` on the `Config` tab and a [Griptape Cloud API Key](https://cloud.griptape.ai/configuration/api-keys).

The following shell commands will create a new data refresh job. You will need to specify your API key and data source id.

```shell
export GT_CLOUD_API_KEY=<your API key here>
export DATA_SOURCE_ID=<your data source id here>
curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{}' https://cloud.griptape.ai/api/data-connectors/${DATA_SOURCE_ID}/data-jobs
```
4 changes: 2 additions & 2 deletions docs/griptape-cloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
[Griptape Cloud](https://cloud.griptape.ai/) provides managed services for your AI app stack. Deploy and scale end-to-end solutions, from LLM-powered data prep and retrieval to AI Agents, Pipelines and Workflows.

## Build Your Own RAG Pipeline
Connect to your data with our [Data Sources](data-sources/index.md) and prepare them for retrieval with [Knowledge Bases](knowledge-bases/index.md).
Connect to your data with our [Data Sources](data-sources/create-data-source.md) and prepare them for retrieval with [Knowledge Bases](knowledge-bases/create-knowledge-base.md).

## Host and Run Your Code
Have Griptape code? Have existing code with another LLM framework? You can host your python code using [Structures](structures/index.md) whether it uses the Griptape Framework or not.
Have Griptape code? Have existing code with another LLM framework? You can host your python code using [Structures](structures/create-structure.md) whether it uses the Griptape Framework or not.

## APIs
All of our features can be called via API with a [Griptape Cloud API Key](https://cloud.griptape.ai/configuration/api-keys). See the [API Reference](api/api-reference.md) for detailed information.
Original file line number Diff line number Diff line change
@@ -1,41 +1,33 @@
# Knowledge Bases
# Accessing Data in a Knowledge Base

Use [Knowledge Bases](https://cloud.griptape.ai/knowledge-bases) to prep your data ingested from [Data Sources](../data-sources/index.md) for retrieval.
You can `Search` or `Query` the Knowledge Base for information contained in your Data Sources. `Search` will return a natural language response while `Query` will return the individual entries. Use whichever one best fits your use case.

## Create a Knowledge Base

You can [create a Knowledge Base](https://cloud.griptape.ai/knowledge-bases/create) by specifying which Data Sources you wish to include.

## Search or Query a Knowledge Base

Once created you can `Search` or `Query` the Knowledge Base for information contained in your Data Sources. `Search` will return a natural language response while `Query` will return the individual entries. Use whichever one best fits your use case.

### From the UI
## From the UI

You can try out both actions from the UI on the `Test` tab of your Knowledge Base.

### From the API
## From the API

You can enact both `Query` and `Search` via the API by hitting their respective endpoints using a [Griptape Cloud API Key](https://cloud.griptape.ai/configuration/api-keys) and the Knowledge Base ID found on the `Config` tab of your Knowledge Base.

The following example commands will send the query string "test query string" and return the results from the Knowledge Base.

#### Query
### Query

```shell
export GT_CLOUD_API_KEY=<your API key here>
export KNOWLEDGE_BASE_ID=<your knowledge base id here>
curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"query": "test query string"}' https://cloud.griptape.ai/api/knowledge-bases/${KNOWLEDGE_BASE_ID}/query
```

#### Search
### Search

```shell
export GT_CLOUD_API_KEY=<your API key here>
export KNOWLEDGE_BASE_ID=<your knowledge base id here>
curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"query": "test query string"}' https://cloud.griptape.ai/api/knowledge-bases/${KNOWLEDGE_BASE_ID}/search
```

### Using the Griptape Framework
## Using the Griptape Framework

You can use [VectorStoreDrivers](../../griptape-framework/drivers/vector-store-drivers.md/#griptape-cloud-knowledge-base) to query your Knowledge Base with Griptape.
7 changes: 7 additions & 0 deletions docs/griptape-cloud/knowledge-bases/create-knowledge-base.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Knowledge Bases

Use [Knowledge Bases](https://cloud.griptape.ai/knowledge-bases) to prep your data ingested from [Data Sources](../data-sources/create-data-source.md) for retrieval.

## Create a Knowledge Base

You can [create a Knowledge Base](https://cloud.griptape.ai/knowledge-bases/create) by specifying which Data Sources you wish to include.
15 changes: 15 additions & 0 deletions docs/griptape-cloud/structures/create-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Structures

Use [Structures](https://cloud.griptape.ai/structures) to host any python code in the cloud.

## Create a Structure

1. [Connect Your GitHub Account](https://cloud.griptape.ai/account) in your Griptape Cloud account
1. Install the [Griptape Cloud GitHub app](https://github.com/apps/griptape-cloud/installations/new/) to any account or organization you'd like to pull code in from
- Be sure to allow the app access to `All Repositories` or select the specific repositories you need

You can now [create a Structure](https://cloud.griptape.ai/structures/create) by providing your GitHub repository information. Make sure that your repository has a [Structure Config YAML](structure-config.md).

### Quickstart With Samples and Templates

To get started with Structures in the Cloud, check out the [managed-structure-template](https://github.com/griptape-ai/managed-structure-template) or deploy one of the [griptape-sample-structures](https://github.com/griptape-ai/griptape-sample-structures/tree/main).
Original file line number Diff line number Diff line change
@@ -1,24 +1,8 @@
# Structures
# Running a Structure

Use [Structures](https://cloud.griptape.ai/structures) to host any python code in the cloud.
Once your Structure is created and deployed, you can run your Structure one of three ways outlined below. You view the output of any of your runs, no matter how you created them, you can view them in the `Runs` tab of your Structure.

## Create a Structure

1. [Connect Your GitHub Account](https://cloud.griptape.ai/account) in your Griptape Cloud account
1. Install the [Griptape Cloud GitHub app](https://github.com/apps/griptape-cloud/installations/new/) to any account or organization you'd like to pull code in from
- Be sure to allow the app access to `All Repositories` or select the specific repositories you need

You can now [create a Structure](https://cloud.griptape.ai/structures/create) by providing your GitHub repository information. Make sure that your repository has a [Structure Config YAML](structure-config.md).

### Quickstart With Samples and Templates

To get started with Structures in the Cloud, check out the [managed-structure-template](https://github.com/griptape-ai/managed-structure-template) or deploy one of the [griptape-sample-structures](https://github.com/griptape-ai/griptape-sample-structures/tree/main).

## Run a Structure

Once your Structure is created and deployed, you can run your Structure one of three ways outlined below. In order to view the output of any of your runs, no matter how you created them, you can view them in the `Runs` tab of your Structure.

### From the UI
## From the UI

In the UI, click on the name of the Structure you wish to run and then go to the `Test` tab. Here you can specify arguments to pass to your Structure run and any run-specific environment variables you need.

Expand All @@ -29,7 +13,7 @@ When passing arguments through the UI, pass each new argument on a new line. For
input_file.txt
```

### From the API
## From the API

You can run your Structure via the API using CURL or any other code that can make HTTP requests. You will need a [Griptape Cloud API Key](https://cloud.griptape.ai/configuration/api-keys) and the `Structure Invocation URL` which is located on the `Config` tab of your Structure.

Expand All @@ -43,6 +27,6 @@ curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"args": ["arg1"], "

For more information on other Structure run APIs, check out the [StructureRuns API docs](../api/api-reference.md/#/StructureRuns).

### Using the Griptape Framework
## Using the Griptape Framework

You can use [StructureRunDrivers](../../griptape-framework/drivers/structure-run-drivers.md/#griptape-cloud) to run your Structure with Griptape.
9 changes: 6 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,15 @@ nav:
- Cloud:
- Overview: "griptape-cloud/index.md"
- Data Sources:
- Overview: "griptape-cloud/data-sources/index.md"
- Create a Data Source: "griptape-cloud/data-sources/create-data-source.md"
- Refreshing Your Data: "griptape-cloud/data-sources/refresh-data.md"
- Knowledge Bases:
- Overview: "griptape-cloud/knowledge-bases/index.md"
- Create a Knowledge Base: "griptape-cloud/knowledge-bases/create-knowledge-base.md"
- Accessing Your Data: "griptape-cloud/knowledge-bases/accessing-data.md"
- Structures:
- Overview: "griptape-cloud/structures/index.md"
- Create a Structure: "griptape-cloud/structures/create-structure.md"
- Structure Config YAML: "griptape-cloud/structures/structure-config.md"
- Running Your Structure: "griptape-cloud/structures/run-structure.md"
- Cloud API:
- API Reference: "griptape-cloud/api/api-reference.md"
- Framework:
Expand Down

0 comments on commit 5b211f1

Please sign in to comment.