VectaraSearch
Description: A logic unit for searching in Vectara. Requires the VECTARA_API_KEY environment variable to be set for authentication.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + implementation | No | const | No | - | Implementation |
| + corpus_key | No | string | No | - | Corpus Key |
| - description | No | string | No | - | Description |
| - vectara_url | No | string | No | - | Vectara Url |
| - read_document_enabled | No | boolean | No | - | Read Document Enabled |
| - read_document_description | No | Combination | No | - | Read Document Description |
1. Property implementation
Title: Implementation
| Type | const |
| Required | Yes |
Specific value: "VectaraSearch"
2. Property corpus_key
Title: Corpus Key
| Type | string |
| Required | Yes |
Description: The corpus key to search in.
3. Property description
Title: Description
| Type | string |
| Required | No |
| Default | "Search documents related to {corpus_key}." |
Description: Description of the tool presented to LLM. Will be formatted with corpus_key.
4. Property vectara_url
Title: Vectara Url
| Type | string |
| Required | No |
| Default | "https://api.vectara.io/" |
5. Property read_document_enabled
Title: Read Document Enabled
| Type | boolean |
| Required | No |
| Default | false |
Description: Enable read_document tool.
6. Property read_document_description
Title: Read Document Description
| Type | combining |
| Required | No |
| Additional properties | [Any type: allowed] |
| Default | "Read a document from {corpus_key}." |
Description: Description of the tool presented to LLM. Will be formatted with corpus_key.
6.1. Property item 0
| Type | string |
| Required | No |
6.2. Property item 1
| Type | null |
| Required | No |