Search documents on GroundX for the most relevant information to a given query.
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.
The bucketId, groupId, projectId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted.
The maximum number of returned search results. Accepts 1-100 with a default of 20.
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.
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.
The search query to be used to find relevant documentation.
The minimum search relevance score required to include the result. By default, this is 10.0.
Search query success