-
Notifications
You must be signed in to change notification settings - Fork 176
/
mkdocs.yml
188 lines (188 loc) · 8.73 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
site_name: Griptape Docs
site_url: !ENV READTHEDOCS_CANONICAL_URL
hooks:
- docs/plugins/swagger_ui_plugin.py
strict: true
plugins:
- glightbox
- search
- mkdocstrings:
handlers:
python:
paths: ["griptape"]
options:
show_if_no_docstring: true
heading_level: 3
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
copyright: "© Griptape, Inc."
extra_css:
- assets/css/extra.css
- assets/css/code_select.css
- assets/css/mkdocstrings.css
- assets/css/swagger-ui.css
extra_javascript:
- assets/scripts/swagger-ui-bundle.js
- assets/scripts/swagger-ui-standalone-preset.js
extra:
analytics:
provider: google
property: G-QM8EDPSCB6
social:
- icon: fontawesome/solid/house
link: https://www.griptape.ai
- icon: fontawesome/brands/discord
link: https://discord.gg/gnWRz88eym
- icon: fontawesome/brands/github
link: https://github.com/griptape-ai/griptape/
- icon: fontawesome/brands/python
link: https://pypi.org/project/griptape/
theme:
name: material
custom_dir: docs/overrides
logo: assets/img/griptape-mark-square-light.svg
palette:
scheme: slate
primary: black
accent: deep orange
features:
- content.code.copy
- content.code.annotate
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- announce.dismiss
- toc.follow
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- admonition
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.tabbed
- tables
- def_list
- footnotes
nav:
- Home:
- Overview: "index.md"
- Contributing: "contributing.md"
- Cloud:
- Overview: "griptape-cloud/index.md"
- Data Sources:
- Create a Data Source: "griptape-cloud/data-sources/create-data-source.md"
- Refreshing Your Data: "griptape-cloud/data-sources/refresh-data.md"
- Knowledge Bases:
- Create a Knowledge Base: "griptape-cloud/knowledge-bases/create-knowledge-base.md"
- Accessing Your Data: "griptape-cloud/knowledge-bases/accessing-data.md"
- Structures:
- 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"
- Structure Run Events: "griptape-cloud/structures/structure-run-events.md"
- Rules:
- Create a Ruleset: "griptape-cloud/rules/rulesets.md"
- Threads:
- Create a Thread: "griptape-cloud/threads/threads.md"
- Cloud API:
- API Reference: "griptape-cloud/api/api-reference.md"
- Framework:
- Overview: "griptape-framework/index.md"
- Structures:
- Agents: "griptape-framework/structures/agents.md"
- Pipelines: "griptape-framework/structures/pipelines.md"
- Workflows: "griptape-framework/structures/workflows.md"
- Tasks: "griptape-framework/structures/tasks.md"
- Task Memory and Off Prompt: "griptape-framework/structures/task-memory.md"
- Conversation Memory: "griptape-framework/structures/conversation-memory.md"
- Rulesets: "griptape-framework/structures/rulesets.md"
- Configs: "griptape-framework/structures/configs.md"
- Observability: "griptape-framework/structures/observability.md"
- Tools:
- Overview: "griptape-framework/tools/index.md"
- Building Custom Tools: "griptape-tools/custom-tools/index.md"
- Engines:
- RAG Engine: "griptape-framework/engines/rag-engines.md"
- Extraction Engines: "griptape-framework/engines/extraction-engines.md"
- Summary Engine: "griptape-framework/engines/summary-engines.md"
- Eval Engine: "griptape-framework/engines/eval-engines.md"
- Drivers:
- Prompt Drivers: "griptape-framework/drivers/prompt-drivers.md"
- Embedding Drivers: "griptape-framework/drivers/embedding-drivers.md"
- Vector Store Drivers: "griptape-framework/drivers/vector-store-drivers.md"
- Image Generation Drivers: "griptape-framework/drivers/image-generation-drivers.md"
- SQL Drivers: "griptape-framework/drivers/sql-drivers.md"
- Web Scraper Drivers: "griptape-framework/drivers/web-scraper-drivers.md"
- Conversation Memory Drivers: "griptape-framework/drivers/conversation-memory-drivers.md"
- Event Listener Drivers: "griptape-framework/drivers/event-listener-drivers.md"
- Structure Run Drivers: "griptape-framework/drivers/structure-run-drivers.md"
- Assistant Drivers: "griptape-framework/drivers/assistant-drivers.md"
- Text to Speech Drivers: "griptape-framework/drivers/text-to-speech-drivers.md"
- Audio Transcription Drivers: "griptape-framework/drivers/audio-transcription-drivers.md"
- Web Search Drivers: "griptape-framework/drivers/web-search-drivers.md"
- Observability Drivers: "griptape-framework/drivers/observability-drivers.md"
- Ruleset Drivers: "griptape-framework/drivers/ruleset-drivers.md"
- File Manager Drivers: "griptape-framework/drivers/file-manager-drivers.md"
- Data:
- Overview: "griptape-framework/data/index.md"
- Artifacts: "griptape-framework/data/artifacts.md"
- Loaders: "griptape-framework/data/loaders.md"
- Chunkers: "griptape-framework/data/chunkers.md"
- Misc:
- Events: "griptape-framework/misc/events.md"
- Tokenizers: "griptape-framework/misc/tokenizers.md"
- Tools:
- Overview: "griptape-tools/index.md"
- Official Tools:
- Calculator: "griptape-tools/official-tools/calculator-tool.md"
- Computer: "griptape-tools/official-tools/computer-tool.md"
- Date Time: "griptape-tools/official-tools/date-time-tool.md"
- Email: "griptape-tools/official-tools/email-tool.md"
- File Manager: "griptape-tools/official-tools/file-manager-tool.md"
- Structure Run Client: "griptape-tools/official-tools/structure-run-tool.md"
- Rest Api Client: "griptape-tools/official-tools/rest-api-tool.md"
- Sql: "griptape-tools/official-tools/sql-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"
- Prompt Image Generation: "griptape-tools/official-tools/prompt-image-generation-tool.md"
- Variation ImageGeneration: "griptape-tools/official-tools/variation-image-generation-tool.md"
- Inpainting ImageGeneration: "griptape-tools/official-tools/inpainting-image-generation-tool.md"
- Outpainting ImageGeneration: "griptape-tools/official-tools/outpainting-image-generation-tool.md"
- Image Query: "griptape-tools/official-tools/image-query-tool.md"
- Text To Speech: "griptape-tools/official-tools/text-to-speech-tool.md"
- Audio Transcription: "griptape-tools/official-tools/audio-transcription-tool.md"
- Griptape Cloud Tool: "griptape-tools/official-tools/griptape-cloud-tool-tool.md"
- Rag: "griptape-tools/official-tools/rag-tool.md"
- Extraction: "griptape-tools/official-tools/extraction-tool.md"
- Query: "griptape-tools/official-tools/query-tool.md"
- Prompt Summary: "griptape-tools/official-tools/prompt-summary-tool.md"
- Custom Tools:
- Building Custom Tools: "griptape-tools/custom-tools/index.md"
- Recipes:
- Overview: "examples/index.md"
- Agents:
- Talk to Redshift: "examples/talk-to-redshift.md"
- Talk to a Webpage: "examples/talk-to-a-webpage.md"
- Talk to a PDF: "examples/talk-to-a-pdf.md"
- Talk to a Video: "examples/talk-to-a-video.md"
- Talk to an Image: "examples/talk-to-an-image.md"
- Multi Agent Workflows: "examples/multi-agent-workflow.md"
- Shared Memory Between Agents: "examples/multiple-agent-shared-memory.md"
- Chat Sessions with Amazon DynamoDB: "examples/amazon-dynamodb-sessions.md"
- Data:
- Load and Query Pinecone: "examples/load-and-query-pinecone.md"
- Load and Query Marqo: "examples/load-query-and-chat-marqo.md"
- Query a Webpage: "examples/query-webpage.md"
- RAG with Astra DB vector store: "examples/query-webpage-astra-db.md"
- Reference Guide: "reference/"
- Trade School: "https://learn.griptape.ai"