Skip to content

armgit / txtai

Public Imported from GitHub
0

💡 All-in-one AI framework for semantic search, LLM orchestration and language model workflows

Update documentation

davidmezzetti07b78adf16bf
diff --git a/docs/embeddings/methods.md b/docs/embeddings/methods.md
index 66c81423..4d55f300 100644
--- a/docs/embeddings/methods.md
+++ b/docs/embeddings/methods.md
@@ -3,10 +3,14 @@
::: txtai.embeddings.Embeddings
selection:
filters:
+ - "!createcloud"
- "!createdatabase"
- "!creategraph"
- "!checkarchive"
- "!configure"
+ - "!defaults"
+ - "!loadconfig"
- "!loadquery"
- "!loadvectors"
- "!normalize"
+ - "!saveconfig"
diff --git a/docs/workflow/task/template.md b/docs/workflow/task/template.md
new file mode 100644
index 00000000..4462e904
--- /dev/null
+++ b/docs/workflow/task/template.md
@@ -0,0 +1,35 @@
+# Template Task
+
+![task](../../images/task.png#only-light)
+![task](../../images/task-dark.png#only-dark)
+
+The Template Task generates text from a template and task inputs. Templates can be used to prepare data for a number of tasks including generating large
+language model (LLM) prompts.
+
+## Example
+
+The following shows a simple example using this task as part of a workflow.
+
+```python
+from txtai.workflow import TemplateTask, Workflow
+
+workflow = Workflow([TemplateTask(template="This is a {text} task")])
+workflow([{"text": "template"}])
+```
+
+## Configuration-driven example
+
+This task can also be created with workflow configuration.
+
+```yaml
+workflow:
+ tasks:
+ - task: template
+ template: This is a {text} task
+```
+
+## Methods
+
+Python documentation for the task.
+
+### ::: txtai.workflow.TemplateTask.__init__
diff --git a/mkdocs.yml b/mkdocs.yml
index 2bc4cb9a..840ceba9 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -95,6 +95,7 @@ nav:
- Retrieve: workflow/task/retrieve.md
- Service: workflow/task/service.md
- Storage: workflow/task/storage.md
+ - Template: workflow/task/template.md
- Url: workflow/task/url.md
- Workflow: workflow/task/workflow.md
- API: