From 068682d79b10969657f175bd5fdfcc0eca3d12f0 Mon Sep 17 00:00:00 2001 From: Collin Dutter Date: Wed, 14 Aug 2024 08:56:16 -0700 Subject: [PATCH] Fix docs --- docs/griptape-framework/structures/agents.md | 2 +- docs/griptape-framework/structures/pipelines.md | 2 +- docs/griptape-framework/structures/task-memory.md | 2 +- docs/griptape-framework/structures/tasks.md | 2 +- .../official-tools/{extraction-client.md => extraction-tool.md} | 0 .../{prompt-summary-client.md => prompt-summary-tool.md} | 0 .../official-tools/{query-client.md => query-tool.md} | 2 +- mkdocs.yml | 1 - 8 files changed, 5 insertions(+), 6 deletions(-) rename docs/griptape-tools/official-tools/{extraction-client.md => extraction-tool.md} (100%) rename docs/griptape-tools/official-tools/{prompt-summary-client.md => prompt-summary-tool.md} (100%) rename docs/griptape-tools/official-tools/{query-client.md => query-tool.md} (98%) diff --git a/docs/griptape-framework/structures/agents.md b/docs/griptape-framework/structures/agents.md index 376e7288a..1b40fad2b 100644 --- a/docs/griptape-framework/structures/agents.md +++ b/docs/griptape-framework/structures/agents.md @@ -12,7 +12,7 @@ directly, which the agent uses to dynamically determine whether to use a [Prompt If [tools](../../reference/griptape/structures/agent.md#griptape.structures.agent.Agent.tools) are passed provided to the Agent, a [Toolkit Task](./tasks.md#toolkit-task) will be used. If no [tools](../../reference/griptape/structures/agent.md#griptape.structures.agent.Agent.tools) are provided, a [Prompt Task](./tasks.md#prompt-task) will be used. -You can access the final output of the Agent by using the [output](../../reference/griptape/structures/agent.md#griptape.structures.structure.Structure.output) attribute. +You can access the final output of the Agent by using the [output](../../reference/griptape/structures/structure.md#griptape.structures.structure.Structure.output) attribute. ## Toolkit Task Agent diff --git a/docs/griptape-framework/structures/pipelines.md b/docs/griptape-framework/structures/pipelines.md index fc5046196..7bcfc1348 100644 --- a/docs/griptape-framework/structures/pipelines.md +++ b/docs/griptape-framework/structures/pipelines.md @@ -6,7 +6,7 @@ search: ## Overview A [Pipeline](../../reference/griptape/structures/pipeline.md) is very similar to an [Agent](../../reference/griptape/structures/agent.md), but allows for multiple tasks. -You can access the final output of the Pipeline by using the [output](../../reference/griptape/structures/agent.md#griptape.structures.structure.Structure.output) attribute. +You can access the final output of the Pipeline by using the [output](../../reference/griptape/structures/structure.md#griptape.structures.structure.Structure.output) attribute. ## Context diff --git a/docs/griptape-framework/structures/task-memory.md b/docs/griptape-framework/structures/task-memory.md index cc50be322..1cbc8e6ed 100644 --- a/docs/griptape-framework/structures/task-memory.md +++ b/docs/griptape-framework/structures/task-memory.md @@ -276,7 +276,7 @@ Today, these include: - [PromptSummaryTool](../../griptape-tools/official-tools/prompt-summary-tool.md) - [ExtractionTool](../../griptape-tools/official-tools/extraction-tool.md) - [RagClient](../../griptape-tools/official-tools/rag-tool.md) -- [FileManagerTool](../../griptape-tools/official-tools/file-manager.md) +- [FileManagerTool](../../griptape-tools/official-tools/file-manager-tool.md) ## Task Memory Considerations diff --git a/docs/griptape-framework/structures/tasks.md b/docs/griptape-framework/structures/tasks.md index 40dff8f8d..f91937ec0 100644 --- a/docs/griptape-framework/structures/tasks.md +++ b/docs/griptape-framework/structures/tasks.md @@ -342,7 +342,7 @@ The [Outpainting Image Generation Task](../../reference/griptape/tasks/outpainti The [Image Query Task](../../reference/griptape/tasks/image_query_task.md) performs a natural language query on one or more input images. This Task uses an [Image Query Engine](../engines/image-query-engines.md) configured with an [Image Query Driver](../drivers/image-query-drivers.md) to perform the query. The functionality provided by this Task depend on the capabilities of the model provided by the Driver. -This Task accepts two inputs: a query (represented by either a string or a [Text Artifact](../data/artifacts.md#textartifact)) and a list of [Image Artifacts](../data/artifacts.md#image) or a Callable returning these two values. +This Task accepts two inputs: a query (represented by either a string or a [Text Artifact](../data/artifacts.md#text)) and a list of [Image Artifacts](../data/artifacts.md#image) or a Callable returning these two values. ```python --8<-- "docs/griptape-framework/structures/src/tasks_15.py" diff --git a/docs/griptape-tools/official-tools/extraction-client.md b/docs/griptape-tools/official-tools/extraction-tool.md similarity index 100% rename from docs/griptape-tools/official-tools/extraction-client.md rename to docs/griptape-tools/official-tools/extraction-tool.md diff --git a/docs/griptape-tools/official-tools/prompt-summary-client.md b/docs/griptape-tools/official-tools/prompt-summary-tool.md similarity index 100% rename from docs/griptape-tools/official-tools/prompt-summary-client.md rename to docs/griptape-tools/official-tools/prompt-summary-tool.md diff --git a/docs/griptape-tools/official-tools/query-client.md b/docs/griptape-tools/official-tools/query-tool.md similarity index 98% rename from docs/griptape-tools/official-tools/query-client.md rename to docs/griptape-tools/official-tools/query-tool.md index 5728806a2..5c5754e3c 100644 --- a/docs/griptape-tools/official-tools/query-client.md +++ b/docs/griptape-tools/official-tools/query-tool.md @@ -1,4 +1,4 @@ -The [RagClient](../../reference/griptape/tools/rag_client/tool.md) enables LLMs to query modular RAG engines. +The [RagClient](../../reference/griptape/tools/rag/tool.md) enables LLMs to query modular RAG engines. Here is an example of how it can be used with a local vector store driver: diff --git a/mkdocs.yml b/mkdocs.yml index da68fb29c..7e3806264 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -144,7 +144,6 @@ nav: - Open Weather: "griptape-tools/official-tools/openweather-tool.md" - Rest Api Client: "griptape-tools/official-tools/rest-api-tool.md" - Sql: "griptape-tools/official-tools/sql-tool.md" - - Task Memory: "griptape-tools/official-tools/task-memory-tool.md" - Vector Store Tool: "griptape-tools/official-tools/vector-store-tool.md" - Web Scraper: "griptape-tools/official-tools/web-scraper-tool.md" - Web Search: "griptape-tools/official-tools/web-search-tool.md"