search.documents
Search documents on GroundX for the most relevant information to a given query by documentId(s).
The result of this query is typically used in one of two ways; result.search.text
can be used to provide context to a language model, facilitating RAG, or result.search.results
can be used to observe chunks of text which are relevant to the query, facilitating citation.
Headers
X-API-Key
Query parameters
n
The maximum number of returned search results. Accepts 1-100 with a default of 20.
nextToken
A token for pagination. If the number of search results for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n search results.
verbosity
The amount of data returned with each search result. 0 == no search results, only the recommended context. 1 == search results but no searchData. 2 == search results and searchData.
Request
This endpoint expects an object.
query
The search query to be used to find relevant documentation.
documentIds
An array of unique documentIds to be searched.
filter
A dictionary of key-value pairs that can be used to pre-filter documents prior to a search.
relevance
The minimum search relevance score required to include the result. By default, this is 10.0.
Response
Search query success
search