Skip to content

Commit

Permalink
Merge pull request #542 from RizaFarheen/main
Browse files Browse the repository at this point in the history
llmgetdocumentdoc
  • Loading branch information
nhandt2021 authored Oct 30, 2023
2 parents b0a1351 + a08d2ab commit 73920c7
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 2 deletions.
73 changes: 73 additions & 0 deletions docs/reference-docs/ai-tasks/llm-get-document.md
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>
2 changes: 1 addition & 1 deletion docs/reference-docs/ai-tasks/llm-index-text.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 7
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
2 changes: 1 addition & 1 deletion docs/reference-docs/ai-tasks/llm-search-index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 8
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
Binary file added static/img/llm-get-document-ui-method.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 73920c7

Please sign in to comment.