From 128d7d9814c9f169dc3b335b4eb8c1aabbd4f948 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Mon, 26 Aug 2024 15:27:56 -0700 Subject: [PATCH 01/10] initial cloud docs for data sources, knowledge bases, and structures --- docs/griptape-cloud/data-sources/index.md | 21 ++++++++++ docs/griptape-cloud/index.md | 11 ++++- docs/griptape-cloud/knowledge-bases/index.md | 35 ++++++++++++++++ docs/griptape-cloud/structures/index.md | 44 ++++++++++++++++++++ docs/index.md | 2 +- mkdocs.yml | 9 +++- 6 files changed, 117 insertions(+), 5 deletions(-) create mode 100644 docs/griptape-cloud/data-sources/index.md create mode 100644 docs/griptape-cloud/knowledge-bases/index.md create mode 100644 docs/griptape-cloud/structures/index.md diff --git a/docs/griptape-cloud/data-sources/index.md b/docs/griptape-cloud/data-sources/index.md new file mode 100644 index 000000000..a9807cb11 --- /dev/null +++ b/docs/griptape-cloud/data-sources/index.md @@ -0,0 +1,21 @@ +# Data Sources + +Use [Data Sources](https://cloud.griptape.ai/data-sources) to connect and ingest your own data for use with your AI code. + +## 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 coniguration you'd wish to use, you can submit a request via Discord or `hello@griptape.ai`. + +## Refresh a Data Source + +By default your Data Source will not refresh automatically. You can enable automatic refresh and specify a CRON expression 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 * * *`. + +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. You will need a [Griptape Cloud API Key](https://cloud.griptape.ai/configuration/api-keys) to make API calls. + +```shell +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 6c1c89b8b..054c09425 100644 --- a/docs/griptape-cloud/index.md +++ b/docs/griptape-cloud/index.md @@ -1,5 +1,12 @@ # Griptape Cloud -Griptape Cloud 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. +[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. -To get started with AI 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). \ No newline at end of file +## 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). + +## Host and Run Your Code +Have custom AI code? You can host your python code using [Structures](structures/index.md) whether it uses the Griptape Framework or not. + +## APIs +All of our features can be called via API. 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/index.md new file mode 100644 index 000000000..604014c56 --- /dev/null +++ b/docs/griptape-cloud/knowledge-bases/index.md @@ -0,0 +1,35 @@ +# Knowledge Bases + +Use [Knowledge Bases](https://cloud.griptape.ai/knowledge-bases) to prep your data ingested from [Data Sources](../data-sources/index.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. + +## 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 + +You can try out both actions from the UI on the `Test` tab of your Knowledge Base. + +### 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. + +#### Query + +```shell +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 + +```shell +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 + +You can use [VectorStoreDrivers](../../griptape-framework/drivers/vector-store-drivers/#griptape-cloud-knowledge-base) in the Griptape Framework to run your code. diff --git a/docs/griptape-cloud/structures/index.md b/docs/griptape-cloud/structures/index.md new file mode 100644 index 000000000..5978b19e9 --- /dev/null +++ b/docs/griptape-cloud/structures/index.md @@ -0,0 +1,44 @@ +# Structures + +Use [Structures](https://cloud.griptape.ai/structures) to host any python code in the cloud in seconds. + +## Create a Structure + +1. First [Connect Your GitHub Account](https://cloud.griptape.ai/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 + 1. Be sure to allow the app access to `All Repositories` or select the specific repositories you need + +You can then [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 + +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. + +When passing arguments through the UI, pass each new argument on a new line. For example if your local code could be ran with the inputs `-i input_file.txt` then the arguments you would pass in the cloud would be: + +``` +-i +input_file.txt +``` + +### 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. + +```shell +curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"args": ["arg1"], "env": {"var1":"value1"}}' ${INVOCATION_URL} +``` + +For more information on other Structure run APIs, check out the [StructureRuns API docs](api/api-reference/#/StructureRuns). + +### Using the Griptape Framework + +You can use [StructureRunDrivers](../../griptape-framework/drivers/structure-run-drivers/#griptape-cloud) in the Griptape Framework to run your code. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 5d22224e7..2c6ee5d50 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,7 @@ Griptape Topic Guides discuss key topics at a high level and provide useful back ### Griptape Cloud -[Griptape Cloud](griptape-cloud/api/api-reference.md) provides an overview of the APIs available in the managed cloud service. +[Griptape Cloud](griptape-cloud/index.md) provides an overview of the features in Griptape's cloud offering. ### Griptape Framework diff --git a/mkdocs.yml b/mkdocs.yml index 4207d2171..0d6d2fd26 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -77,10 +77,15 @@ nav: - Contributing: "contributing.md" - Cloud: - Overview: "griptape-cloud/index.md" + - Data Sources: + - Overview: "griptape-cloud/data-sources/index.md" + - Knowledge Bases: + - Overview: "griptape-cloud/knowledge-bases/index.md" + - Structures: + - Overview: "griptape-cloud/structures/index.md" + - Structure Config YAML: "griptape-cloud/structures/structure-config.md" - Cloud API: - API Reference: "griptape-cloud/api/api-reference.md" - - Structures: - - Structure Config: "griptape-cloud/structures/structure-config.md" - Framework: - Overview: "griptape-framework/index.md" - Structures: From f1230dcb6be10449e7143821b2b6ad3b31fbecec Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Tue, 27 Aug 2024 15:24:26 -0700 Subject: [PATCH 02/10] PR comments --- docs/griptape-cloud/data-sources/index.md | 20 +++++++++++++------- docs/griptape-cloud/index.md | 4 ++-- docs/griptape-cloud/knowledge-bases/index.md | 14 ++++++++++---- docs/griptape-cloud/structures/index.md | 18 +++++++++++------- 4 files changed, 36 insertions(+), 20 deletions(-) diff --git a/docs/griptape-cloud/data-sources/index.md b/docs/griptape-cloud/data-sources/index.md index a9807cb11..359428e4a 100644 --- a/docs/griptape-cloud/data-sources/index.md +++ b/docs/griptape-cloud/data-sources/index.md @@ -1,21 +1,27 @@ # Data Sources -Use [Data Sources](https://cloud.griptape.ai/data-sources) to connect and ingest your own data for use with your AI code. +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. +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 coniguration you'd wish to use, you can submit a request via Discord or `hello@griptape.ai`. +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 -By default your Data Source will not refresh automatically. You can enable automatic refresh and specify a CRON expression when creating a Data Source. +### Automatic Refresh -For example, if you wish your Data Source to refresh every day at midnight you can use the following expression: `0 0 * * *`. +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 * * *`. -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. You will need a [Griptape Cloud API Key](https://cloud.griptape.ai/configuration/api-keys) to make API calls. +### 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 -curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{}' https://cloud.griptape.ai/api/data-connectors/${data_source_id}/data-jobs +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 054c09425..421d2a04b 100644 --- a/docs/griptape-cloud/index.md +++ b/docs/griptape-cloud/index.md @@ -6,7 +6,7 @@ Connect to your data with our [Data Sources](data-sources/index.md) and prepare them for retrieval with [Knowledge Bases](knowledge-bases/index.md). ## Host and Run Your Code -Have custom AI code? 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/index.md) whether it uses the Griptape Framework or not. ## APIs -All of our features can be called via API. See the [API Reference](api/api-reference.md) for detailed information. +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/index.md index 604014c56..a388c4ad3 100644 --- a/docs/griptape-cloud/knowledge-bases/index.md +++ b/docs/griptape-cloud/knowledge-bases/index.md @@ -16,20 +16,26 @@ You can try out both actions from the UI on the `Test` tab of your Knowledge Bas ### 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. +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 ```shell -curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"query": "test query string"}' https://cloud.griptape.ai/api/knowledge-bases/${knowledge-base-id}/query +export GT_CLOUD_API_KEY= +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 ```shell -curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"query": "test query string"}' https://cloud.griptape.ai/api/knowledge-bases/${knowledge-base-id}/search +export GT_CLOUD_API_KEY= +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 -You can use [VectorStoreDrivers](../../griptape-framework/drivers/vector-store-drivers/#griptape-cloud-knowledge-base) in the Griptape Framework to run your code. +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/structures/index.md b/docs/griptape-cloud/structures/index.md index 5978b19e9..17eff5c98 100644 --- a/docs/griptape-cloud/structures/index.md +++ b/docs/griptape-cloud/structures/index.md @@ -1,14 +1,14 @@ # Structures -Use [Structures](https://cloud.griptape.ai/structures) to host any python code in the cloud in seconds. +Use [Structures](https://cloud.griptape.ai/structures) to host any python code in the cloud. ## Create a Structure -1. First [Connect Your GitHub Account](https://cloud.griptape.ai/account) +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 - 1. Be sure to allow the app access to `All Repositories` or select the specific repositories you need + - Be sure to allow the app access to `All Repositories` or select the specific repositories you need -You can then [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). +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 @@ -31,14 +31,18 @@ input_file.txt ### 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. +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. + +The example below will kick off a run with the args you pass as a json object. ```shell +export GT_CLOUD_API_KEY= +export INVOCATION_URL= curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"args": ["arg1"], "env": {"var1":"value1"}}' ${INVOCATION_URL} ``` -For more information on other Structure run APIs, check out the [StructureRuns API docs](api/api-reference/#/StructureRuns). +For more information on other Structure run APIs, check out the [StructureRuns API docs](../api/api-reference.md/#/StructureRuns). ### Using the Griptape Framework -You can use [StructureRunDrivers](../../griptape-framework/drivers/structure-run-drivers/#griptape-cloud) in the Griptape Framework to run your code. \ No newline at end of file +You can use [StructureRunDrivers](../../griptape-framework/drivers/structure-run-drivers.md/#griptape-cloud) to run your Structure with Griptape. From 5b211f1fde3990c5b3857d537be21984183ca3a6 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Tue, 27 Aug 2024 15:44:33 -0700 Subject: [PATCH 03/10] 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: From 2d0bdc5ef2cc7c2cfe1b3d664ccaea863d358ec0 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Tue, 27 Aug 2024 15:52:15 -0700 Subject: [PATCH 04/10] adding a bullet for config YAML --- docs/griptape-cloud/structures/create-structure.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/griptape-cloud/structures/create-structure.md b/docs/griptape-cloud/structures/create-structure.md index 5f48da6f6..1f5c7bcbe 100644 --- a/docs/griptape-cloud/structures/create-structure.md +++ b/docs/griptape-cloud/structures/create-structure.md @@ -7,8 +7,9 @@ Use [Structures](https://cloud.griptape.ai/structures) to host any python code i 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 +1. Create a [Structure Config YAML](structure-config.md) in your repository -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). +You can now [create a Structure](https://cloud.griptape.ai/structures/create) by providing your GitHub repository information. ### Quickstart With Samples and Templates From b2c652ba55bb1a4c5e7981c0672194a07d8033f3 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Wed, 28 Aug 2024 10:56:54 -0700 Subject: [PATCH 05/10] ALL THE PR COMMENTS --- .../data-sources/create-data-source.md | 18 +++++++++++++++--- .../data-sources/refresh-data.md | 6 +++--- .../knowledge-bases/accessing-data.md | 6 +++--- .../knowledge-bases/create-knowledge-base.md | 4 ++-- .../structures/create-structure.md | 2 +- .../griptape-cloud/structures/run-structure.md | 10 +++++----- 6 files changed, 29 insertions(+), 17 deletions(-) diff --git a/docs/griptape-cloud/data-sources/create-data-source.md b/docs/griptape-cloud/data-sources/create-data-source.md index f63a16ad5..40799230f 100644 --- a/docs/griptape-cloud/data-sources/create-data-source.md +++ b/docs/griptape-cloud/data-sources/create-data-source.md @@ -1,9 +1,21 @@ # 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). +Data Sources are the first step to Griptape's RAG pipeline. They allow you to bring your own data to ingest and transform 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. +You can [create a Data Source](https://cloud.griptape.ai/data-sources/create) by specifying the required configuration for your chosen Data Source in the cloud console. -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`. +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`. + +### Web Page + +You can scrape and ingest a single, public web page by providing a URL. If you wish to scrape multiple pages, you must create mutliple Data Sources. However, you can then add all of the pages to the same Knowledge Base if you wish to access all the pages together. + +### Google Drive + +You can ingest documents and spreadsheets stored in a Google Drive account. We support all standard file formats such as text, markdown, spreadsheets, and presentations. + +### Confluence + +You can connect to your personal or company Confluence by providing a domain, [Atlassian API Token](https://id.atlassian.com/manage-profile/security/api-tokens), and the email address for the token holder's account. Each Confluence Data Source is limited to a single space in Confluence. diff --git a/docs/griptape-cloud/data-sources/refresh-data.md b/docs/griptape-cloud/data-sources/refresh-data.md index bb2215a52..548745218 100644 --- a/docs/griptape-cloud/data-sources/refresh-data.md +++ b/docs/griptape-cloud/data-sources/refresh-data.md @@ -1,12 +1,12 @@ # Refresh a Data Source -## Automatic Refresh +## Scheduled 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 * * *`. +By default your Data Source will not refresh automatically. When creating a Data Source, you can enable scheduled refresh and specify a [CRON expression](https://crontab.guru/). For example, if you wish your Data Source to refresh every day at midnight PDT you can use the following expression: `0 7 * * *`. ## 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). +If you wish to manually refresh a Data Source you can do so either via the `Refresh` button in the cloud console 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. diff --git a/docs/griptape-cloud/knowledge-bases/accessing-data.md b/docs/griptape-cloud/knowledge-bases/accessing-data.md index 56ba8862f..f849b2742 100644 --- a/docs/griptape-cloud/knowledge-bases/accessing-data.md +++ b/docs/griptape-cloud/knowledge-bases/accessing-data.md @@ -2,9 +2,9 @@ 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 Cloud Console -You can try out both actions from the UI on the `Test` tab of your Knowledge Base. +You can try out both actions from the cloud console on the `Test` tab of your Knowledge Base. ## From the API @@ -30,4 +30,4 @@ curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"query": "test quer ## 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. +You can use the [GriptapeCloudKnowledgeBaseVectorStoreDriver](../../griptape-framework/drivers/vector-store-drivers.md/#griptape-cloud-knowledge-base) to query your Knowledge Base with Griptape and the [GriptapeCloudKnowledgeBaseTool](../../griptape-tools/official-tools/griptape-cloud-knowledge-base-tool.md) to search. diff --git a/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md index 23a91c351..3404f6f99 100644 --- a/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md +++ b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md @@ -1,7 +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. +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. You can specify multiple Data Sources per Knowledge Base in order to access data ingested from different sources all in one place. ## 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. +You can [create a Knowledge Base](https://cloud.griptape.ai/knowledge-bases/create) by specifying which Data Sources you wish to include. Once created, you can [access your data](accessing-data.md) instantly. diff --git a/docs/griptape-cloud/structures/create-structure.md b/docs/griptape-cloud/structures/create-structure.md index 1f5c7bcbe..028d58a88 100644 --- a/docs/griptape-cloud/structures/create-structure.md +++ b/docs/griptape-cloud/structures/create-structure.md @@ -1,6 +1,6 @@ # Structures -Use [Structures](https://cloud.griptape.ai/structures) to host any python code in the cloud. +Structures are the primary building block in the Griptape. ## Create a Structure diff --git a/docs/griptape-cloud/structures/run-structure.md b/docs/griptape-cloud/structures/run-structure.md index 86250b824..995fcff01 100644 --- a/docs/griptape-cloud/structures/run-structure.md +++ b/docs/griptape-cloud/structures/run-structure.md @@ -1,12 +1,12 @@ # Running a Structure -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. +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, in the `Runs` tab of your Structure. -## From the UI +## From the Cloud Console -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. +In the cloud console, 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. -When passing arguments through the UI, pass each new argument on a new line. For example if your local code could be ran with the inputs `-i input_file.txt` then the arguments you would pass in the cloud would be: +When passing arguments through the cloud console, pass each new argument on a new line. For example if your local code is ran with the inputs `-i input_file.txt` then the arguments you would pass in the cloud would be: ``` -i @@ -22,7 +22,7 @@ The example below will kick off a run with the args you pass as a json object. ```shell export GT_CLOUD_API_KEY= export INVOCATION_URL= -curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"args": ["arg1"], "env": {"var1":"value1"}}' ${INVOCATION_URL} +curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"args": ["arg1"], ""env_vars"": [{"name":"var1", "value": "value"}]}' ${INVOCATION_URL} ``` For more information on other Structure run APIs, check out the [StructureRuns API docs](../api/api-reference.md/#/StructureRuns). From 891ad8678433101d0f7e344bfd401bcb5856bda8 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Wed, 28 Aug 2024 11:00:43 -0700 Subject: [PATCH 06/10] spell check --- docs/griptape-cloud/data-sources/create-data-source.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/griptape-cloud/data-sources/create-data-source.md b/docs/griptape-cloud/data-sources/create-data-source.md index 40799230f..d1bb0a818 100644 --- a/docs/griptape-cloud/data-sources/create-data-source.md +++ b/docs/griptape-cloud/data-sources/create-data-source.md @@ -10,7 +10,7 @@ If you do not see a Data Source configuration you'd wish to use, you can submit ### Web Page -You can scrape and ingest a single, public web page by providing a URL. If you wish to scrape multiple pages, you must create mutliple Data Sources. However, you can then add all of the pages to the same Knowledge Base if you wish to access all the pages together. +You can scrape and ingest a single, public web page by providing a URL. If you wish to scrape multiple pages, you must create multiple Data Sources. However, you can then add all of the pages to the same Knowledge Base if you wish to access all the pages together. ### Google Drive From 4519cafe91b6d551b1e9fe4e92e7e66894ccf2a5 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Thu, 29 Aug 2024 12:35:09 -0700 Subject: [PATCH 07/10] minor tweaks in wording --- .../data-sources/create-data-source.md | 14 ++++++++++---- docs/griptape-cloud/index.md | 4 ++-- .../knowledge-bases/create-knowledge-base.md | 2 +- docs/griptape-cloud/structures/create-structure.md | 2 +- 4 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/griptape-cloud/data-sources/create-data-source.md b/docs/griptape-cloud/data-sources/create-data-source.md index d1bb0a818..7cd70c45f 100644 --- a/docs/griptape-cloud/data-sources/create-data-source.md +++ b/docs/griptape-cloud/data-sources/create-data-source.md @@ -1,13 +1,11 @@ # Data Sources -Data Sources are the first step to Griptape's RAG pipeline. They allow you to bring your own data to ingest and transform for use with your AI applications via [Knowledge Bases](../knowledge-bases/create-knowledge-base.md). +Data Sources are the first step to Griptape's RAG pipeline. They allow you to bring your own data to ingest and transform. You can then make one or more Data Source available to 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 in the cloud console. -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`. - ### Web Page You can scrape and ingest a single, public web page by providing a URL. If you wish to scrape multiple pages, you must create multiple Data Sources. However, you can then add all of the pages to the same Knowledge Base if you wish to access all the pages together. @@ -18,4 +16,12 @@ You can ingest documents and spreadsheets stored in a Google Drive account. We s ### Confluence -You can connect to your personal or company Confluence by providing a domain, [Atlassian API Token](https://id.atlassian.com/manage-profile/security/api-tokens), and the email address for the token holder's account. Each Confluence Data Source is limited to a single space in Confluence. +You can connect to your personal or company Confluence by providing a URL, [Atlassian API Token](https://id.atlassian.com/manage-profile/security/api-tokens), and the email address for the token holder's account. Each Confluence Data Source can be limited to a single Space in Confluence by specifying the [specific URL for that Space](https://support.atlassian.com/confluence-cloud/docs/use-spaces-to-organize-your-work/). + +### Structure (Experimental) + +You can specify a [Structure](../structures/create-structure.md) to run as a Data Source as long as your Structure returns a [`TextArtifact` or `ListArtifact` from Griptape](../../griptape-framework/data/artifacts.md). You can use this as a way to build custom Data Sources. + +## Other Data Source Types + +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/index.md b/docs/griptape-cloud/index.md index db76ffadc..74a78eaf1 100644 --- a/docs/griptape-cloud/index.md +++ b/docs/griptape-cloud/index.md @@ -1,12 +1,12 @@ # Griptape Cloud -[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. +[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/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/create-structure.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/create-knowledge-base.md b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md index 3404f6f99..e1d4a72b1 100644 --- a/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md +++ b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md @@ -1,6 +1,6 @@ # 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. You can specify multiple Data Sources per Knowledge Base in order to access data ingested from different sources all in one place. +Knowledge Bases are the way to organize and access your data ingested from [Data Sources](../data-sources/create-data-source.md). You can specify multiple Data Sources per Knowledge Base in order to access data ingested from different sources all in one place. ## Create a Knowledge Base diff --git a/docs/griptape-cloud/structures/create-structure.md b/docs/griptape-cloud/structures/create-structure.md index 028d58a88..17f68c3a3 100644 --- a/docs/griptape-cloud/structures/create-structure.md +++ b/docs/griptape-cloud/structures/create-structure.md @@ -1,6 +1,6 @@ # Structures -Structures are the primary building block in the Griptape. +Structures are a primary component in Griptape for organizing and executing Tasks against a LLM. ## Create a Structure From 2c86b224331c07bacf6edd3dd0f6f03c161b9ca7 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Thu, 29 Aug 2024 12:37:07 -0700 Subject: [PATCH 08/10] not instant --- docs/griptape-cloud/knowledge-bases/create-knowledge-base.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md index e1d4a72b1..686e2b92e 100644 --- a/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md +++ b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md @@ -4,4 +4,4 @@ Knowledge Bases are the way to organize and access your data ingested from [Data ## 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. Once created, you can [access your data](accessing-data.md) instantly. +You can [create a Knowledge Base](https://cloud.griptape.ai/knowledge-bases/create) by specifying which Data Sources you wish to include. Once created, you can [access your data](accessing-data.md). From f7425fee007250d6ecb6393e4f7eb403e2e44906 Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Thu, 29 Aug 2024 13:18:11 -0700 Subject: [PATCH 09/10] add more words to links --- .../griptape-cloud/data-sources/create-data-source.md | 4 ++-- .../knowledge-bases/create-knowledge-base.md | 2 +- docs/griptape-cloud/structures/create-structure.md | 11 ++++++----- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/griptape-cloud/data-sources/create-data-source.md b/docs/griptape-cloud/data-sources/create-data-source.md index 7cd70c45f..aede0e9ee 100644 --- a/docs/griptape-cloud/data-sources/create-data-source.md +++ b/docs/griptape-cloud/data-sources/create-data-source.md @@ -4,7 +4,7 @@ Data Sources are the first step to Griptape's RAG pipeline. They allow you to br ## 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 in the cloud console. +You can [create a Data Source in the Griptape Cloud console](https://cloud.griptape.ai/data-sources/create) by specifying the required configuration for your chosen Data Source in the cloud console. ### Web Page @@ -20,7 +20,7 @@ You can connect to your personal or company Confluence by providing a URL, [Atla ### Structure (Experimental) -You can specify a [Structure](../structures/create-structure.md) to run as a Data Source as long as your Structure returns a [`TextArtifact` or `ListArtifact` from Griptape](../../griptape-framework/data/artifacts.md). You can use this as a way to build custom Data Sources. +You can specify a [Structure](../structures/create-structure.md) to run as a Data Source as long as your Structure returns a [`TextArtifact` or `ListArtifact` from the Griptape Framework](../../griptape-framework/data/artifacts.md). You can use this as a way to build custom Data Sources. ## Other Data Source Types diff --git a/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md index 686e2b92e..254c889d3 100644 --- a/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md +++ b/docs/griptape-cloud/knowledge-bases/create-knowledge-base.md @@ -4,4 +4,4 @@ Knowledge Bases are the way to organize and access your data ingested from [Data ## 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. Once created, you can [access your data](accessing-data.md). +You can [create a Knowledge Base in the Griptape Cloud console](https://cloud.griptape.ai/knowledge-bases/create) by specifying which Data Sources you wish to include. Once created, you can [access your data](accessing-data.md). diff --git a/docs/griptape-cloud/structures/create-structure.md b/docs/griptape-cloud/structures/create-structure.md index 17f68c3a3..df0449891 100644 --- a/docs/griptape-cloud/structures/create-structure.md +++ b/docs/griptape-cloud/structures/create-structure.md @@ -4,13 +4,14 @@ Structures are a primary component in Griptape for organizing and executing Task ## 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 +1. [Connect Your GitHub Account in your Griptape Cloud account](https://cloud.griptape.ai/account) +1. Install the [Griptape Cloud GitHub app to your GitHub account or organization](https://github.com/apps/griptape-cloud/installations/new/) - Be sure to allow the app access to `All Repositories` or select the specific repositories you need -1. Create a [Structure Config YAML](structure-config.md) in your repository +1. Ensure your repository has a Structure Config YAML file + - To learn more see [Structure Config YAML](structure-config.md) -You can now [create a Structure](https://cloud.griptape.ai/structures/create) by providing your GitHub repository information. +You can now [create a Structure in the Griptape Cloud console](https://cloud.griptape.ai/structures/create) by providing your GitHub repository information. ### 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). +To get started with Structures in the Cloud, check out the [managed-structure-template on GitHub](https://github.com/griptape-ai/managed-structure-template) or deploy one of the [griptape-sample-structures from GitHub](https://github.com/griptape-ai/griptape-sample-structures/tree/main). From 6b46528db2c23d15e44b8e15f9c551017a015eac Mon Sep 17 00:00:00 2001 From: Emily Danielson Date: Thu, 29 Aug 2024 13:24:52 -0700 Subject: [PATCH 10/10] added pedantry --- .../knowledge-bases/accessing-data.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/griptape-cloud/knowledge-bases/accessing-data.md b/docs/griptape-cloud/knowledge-bases/accessing-data.md index f849b2742..8cb2f7e7b 100644 --- a/docs/griptape-cloud/knowledge-bases/accessing-data.md +++ b/docs/griptape-cloud/knowledge-bases/accessing-data.md @@ -4,28 +4,28 @@ You can `Search` or `Query` the Knowledge Base for information contained in your ## From the Cloud Console -You can try out both actions from the cloud console on the `Test` tab of your Knowledge Base. +You can explore your data with a natural language question on the `Test` tab of your Knowledge Base. Compare and contrast the results of `Search` vs. `Query` to understand which is correct for your application. ## 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. +You can enact both `Search` and `Query` 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. +The following example commands will send the string `"test question"` and return the results from the Knowledge Base. -### Query +### Search ```shell export GT_CLOUD_API_KEY= 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 +curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"query": "test question"}' https://cloud.griptape.ai/api/knowledge-bases/${KNOWLEDGE_BASE_ID}/search ``` -### Search +### Query ```shell export GT_CLOUD_API_KEY= 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 +curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"query": "test question"}' https://cloud.griptape.ai/api/knowledge-bases/${KNOWLEDGE_BASE_ID}/query ``` ## Using the Griptape Framework