Retrieve Tool

Retrieves relevant data from the indexed web resources to augment the user prompt.

Arguments

Name Type Description
query string Required. A query to retrieve relevant data for
jobName string Optional. Scope of data to use for augmentation. If JobName is specified, all data from the job with the given job will be used for augmentation. If not, the data from all jobs in the current tenant will be used
threshold string Optional. A similarity threshold for filtering retrieval results: exact-match, same-category, same-domain, generic-similarity. If not specified, the default value is same-domain
limit int Optional. The maximum number of retrieval results to return. If not specified, the default value is 10
nextCursor string Optional. A cursor for pagination. If specified, the retrieval will continue from the position indicated by the cursor. If not specified, the retrieval will start from the beginning

Return Type

Array of RetrievalItem

RetrievalItem

Name Type Description
Score double Required. Retrieval item score
Span string Required. Found text with its semantic context
DownloadTasks array of DownloadTaskInfo Required. Download tasks that containt the found text

DownloadTaskInfo

Name Type Description
DownloadTaskId string Required. Download task ID
Url string Required. Page URL
CaptureDateUtc datetime Required. Capture date (UTC)

Please rotate your device to landscape mode

This documentation is specifically designed with a wider layout to provide a better reading experience for code examples, tables, and diagrams.
Rotating your device horizontally ensures you can see everything clearly without excessive scrolling or resizing.

Return to Web Data Source Home