Enterprise context by Workato connector - Search documents advanced filters

The Search documents (advanced filters) batch action searches the knowledge base you specify by natural language or keyword search query.

The Search documents (advanced filters) batch action runs a natural-language or keyword search across one or more knowledge bases and returns the matching documents. Use the filters to narrow results by content type, metadata, or date. Filter metadata with a data_filters JSON object to retrieve data that dedicated fields can't express, such as matching against a list of values, OR groups of conditions, or combining several conditions at once.

Refer to Metadata filters for more information on advanced filters.

You can select multiple knowledge bases in a single call. Each selected knowledge base is queried as a separate request. The request volume counted against your rate limit increases when you select more knowledge bases.

Input

Input fieldDescription
Knowledge baseSelect the knowledge base you plan to search. Only recipe-type knowledge bases can be selected. Workato GO sources aren't supported. The handle appears in the URL.
Search queryThe search query, as natural language or keywords.
PageThe page number to retrieve. Starts at 1. Defaults to 1.
Page sizeResults per page (1–100). Defaults to 50.
Enable LLM rerankingRe-rank search results using an LLM for higher relevance. May increase latency.
Data filtersFilter by document metadata using JSON. For example: exact matches{"status":"active"}.

Output

Output fieldDescription
DocumentsThe list of documents that match the search.
Document IDThe ID of the document that contained the natural language search query or keyword you provided. For example: br689aec2ie03218te706l76y157nn12.
TitleThe title of the document returned in the search.
Source URL (Documents)The source URL of the document.
Content typeThe content type of the document returned in the search. For example: application/vnd.openxmlformats-officedocument.presentationml.presentation.
Workspace emailThe email address of the user who owns each document returned in the search.
Created dateThe date each document returned in the search was created.
Updated dateThe date each document returned in the search was updated, if any.
Document contentThe content that matches the search query.
Relevance scoreThe relevance score of the data returned. For example: 0.87.
Metadata (Documents)The key-value metadata stored with the document.
Document type (Documents)The type of the returned item, for example document.
List size (Documents)The total number of documents returned on this page.
List index (Documents)The index of the current item in the documents list.
Total countThe total number of documents that match the search, across all pages.
Current pageThe page number of the returned results.
Page sizeThe page size used for the request.

Last updated: