chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
# Retrieve Task
|
||||
|
||||

|
||||

|
||||
|
||||
The Retrieve Task connects to a url and downloads the content locally. This task is helpful when working with actions that require data to be available locally.
|
||||
|
||||
## Example
|
||||
|
||||
The following shows a simple example using this task as part of a workflow.
|
||||
|
||||
```python
|
||||
from txtai.workflow import RetrieveTask, Workflow
|
||||
|
||||
workflow = Workflow([RetrieveTask(directory="/tmp")])
|
||||
workflow(["https://file.to.download", "/local/file/to/copy"])
|
||||
```
|
||||
|
||||
## Configuration-driven example
|
||||
|
||||
This task can also be created with workflow configuration.
|
||||
|
||||
```yaml
|
||||
workflow:
|
||||
tasks:
|
||||
- task: retrieve
|
||||
directory: /tmp
|
||||
```
|
||||
|
||||
## Methods
|
||||
|
||||
Python documentation for the task.
|
||||
|
||||
### ::: txtai.workflow.RetrieveTask.__init__
|
||||
### ::: txtai.workflow.RetrieveTask.register
|
||||
Reference in New Issue
Block a user