-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #542 from RizaFarheen/main
llmgetdocumentdoc
- Loading branch information
Showing
4 changed files
with
75 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
sidebar_position: 6 | ||
--- | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
# LLM Get Document | ||
|
||
A system task to retrieve a specific document from a vector database that has been previously indexed, making it easily searchable and accessible for subsequent retrieval. | ||
|
||
## Definitions | ||
|
||
```json | ||
{ | ||
"name": "get_document_task", | ||
"taskReferenceName": "get_document_task_ref", | ||
"inputParameters": { | ||
"url": "${workflow.input.url}", | ||
"mediaType": "application/pdf" | ||
}, | ||
"type": "GET_DOCUMENT" | ||
} | ||
``` | ||
|
||
## Input Parameters | ||
|
||
| Attribute | Description | | ||
| --------- | ----------- | | ||
| url | Provide the URL of the document to be retrieved.<br/><br/>Check out our documentation on [how to pass parameters to tasks](https://orkes.io/content/developer-guides/passing-inputs-to-task-in-conductor). | | ||
| mediaType | Select the media type of the file to be retrieved. Currently, supported media types include:<ul><li>application/pdf</li><li>text/html</li><li>text/plain</li><li>json</li></ul> | | ||
|
||
## Examples | ||
|
||
<Tabs> | ||
<TabItem value="UI" label="UI" className="paddedContent"> | ||
|
||
<div className="row"> | ||
<div className="col col--4"> | ||
|
||
<br/> | ||
<br/> | ||
|
||
1. Add task type **LLM Get Document**. | ||
2. Provide the document URL and choose the media type. | ||
|
||
</div> | ||
<div className="col"> | ||
<div className="embed-loom-video"> | ||
|
||
<p><img src="/content/img/llm-get-document-ui-method.png" alt="LLM Get Document Task" width="500" height="auto"/></p> | ||
|
||
</div> | ||
</div> | ||
</div> | ||
|
||
|
||
|
||
</TabItem> | ||
<TabItem value="JSON" label="JSON Example"> | ||
|
||
```json | ||
{ | ||
"name": "get_document_task", | ||
"taskReferenceName": "get_document_task_ref", | ||
"inputParameters": { | ||
"url": "${workflow.input.url}", | ||
"mediaType": "application/pdf" | ||
}, | ||
"type": "GET_DOCUMENT" | ||
} | ||
``` | ||
</TabItem> | ||
</Tabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.