From 5b211f1fde3990c5b3857d537be21984183ca3a6 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Tue, 27 Aug 2024 15:44:33 -0700 Subject: [PATCH] restructure of pages --- .../data-sources/create-data-source.md | 9 +++++++ docs/griptape-cloud/data-sources/index.md | 27 ------------------- .../data-sources/refresh-data.md | 17 ++++++++++++ docs/griptape-cloud/index.md | 4 +-- .../{index.md => accessing-data.md} | 22 +++++---------- .../knowledge-bases/create-knowledge-base.md | 7 +++++ .../structures/create-structure.md | 15 +++++++++++ .../structures/{index.md => run-structure.md} | 26 ++++-------------- mkdocs.yml | 9 ++++--- 9 files changed, 68 insertions(+), 68 deletions(-) create mode 100644 docs/griptape-cloud/data-sources/create-data-source.md delete mode 100644 docs/griptape-cloud/data-sources/index.md create mode 100644 docs/griptape-cloud/data-sources/refresh-data.md rename docs/griptape-cloud/knowledge-bases/{index.md => accessing-data.md} (62%) create mode 100644 docs/griptape-cloud/knowledge-bases/create-knowledge-base.md create mode 100644 docs/griptape-cloud/structures/create-structure.md rename docs/griptape-cloud/structures/{index.md => run-structure.md} (52%) diff --git a/docs/griptape-cloud/data-sources/create-data-source.md b/docs/griptape-cloud/data-sources/create-data-source.md new file mode 100644 index 000000000..f63a16ad5 --- /dev/null +++ b/docs/griptape-cloud/data-sources/create-data-source.md @@ -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 `hello@griptape.ai`. diff --git a/docs/griptape-cloud/data-sources/index.md b/docs/griptape-cloud/data-sources/index.md deleted file mode 100644 index 359428e4a..000000000 --- a/docs/griptape-cloud/data-sources/index.md +++ /dev/null @@ -1,27 +0,0 @@ -# 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/index.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 `hello@griptape.ai`. - -## Refresh a Data Source - -### Automatic Refresh - -By default your Data Source will not refresh automatically. You can enable automatic refresh and specify a [CRON expression](https://crontab.guru/) when creating a Data Source. 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= -export DATA_SOURCE_ID= -curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{}' https://cloud.griptape.ai/api/data-connectors/${DATA_SOURCE_ID}/data-jobs -``` diff --git a/docs/griptape-cloud/data-sources/refresh-data.md b/docs/griptape-cloud/data-sources/refresh-data.md new file mode 100644 index 000000000..bb2215a52 --- /dev/null +++ b/docs/griptape-cloud/data-sources/refresh-data.md @@ -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= +export DATA_SOURCE_ID= +curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{}' https://cloud.griptape.ai/api/data-connectors/${DATA_SOURCE_ID}/data-jobs +``` diff --git a/docs/griptape-cloud/index.md b/docs/griptape-cloud/index.md index 421d2a04b..db76ffadc 100644 --- a/docs/griptape-cloud/index.md +++ b/docs/griptape-cloud/index.md @@ -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. diff --git a/docs/griptape-cloud/knowledge-bases/index.md b/docs/griptape-cloud/knowledge-bases/accessing-data.md similarity index 62% rename from docs/griptape-cloud/knowledge-bases/index.md rename to docs/griptape-cloud/knowledge-bases/accessing-data.md index a388c4ad3..56ba8862f 100644 --- a/docs/griptape-cloud/knowledge-bases/index.md +++ b/docs/griptape-cloud/knowledge-bases/accessing-data.md @@ -1,26 +1,18 @@ -# 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= @@ -28,7 +20,7 @@ export KNOWLEDGE_BASE_ID= 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= @@ -36,6 +28,6 @@ export KNOWLEDGE_BASE_ID= 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. diff --git a/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md new file mode 100644 index 000000000..23a91c351 --- /dev/null +++ b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md @@ -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. diff --git a/docs/griptape-cloud/structures/create-structure.md b/docs/griptape-cloud/structures/create-structure.md new file mode 100644 index 000000000..5f48da6f6 --- /dev/null +++ b/docs/griptape-cloud/structures/create-structure.md @@ -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). diff --git a/docs/griptape-cloud/structures/index.md b/docs/griptape-cloud/structures/run-structure.md similarity index 52% rename from docs/griptape-cloud/structures/index.md rename to docs/griptape-cloud/structures/run-structure.md index 17eff5c98..86250b824 100644 --- a/docs/griptape-cloud/structures/index.md +++ b/docs/griptape-cloud/structures/run-structure.md @@ -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. @@ -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. @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 0d6d2fd26..35f1a74cd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: