- JSON representation
- SearchParams
- SearchResultList
- SearchResult
- UnstructuredDocumentInfo
- DocumentContext
- ExtractiveSegment
- ExtractiveAnswer
- ChunkInfo
Search specification.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field input . Search parameters to control the search behavior. Or provide search result list to generate answer. input can be only one of the following: |
|
searchParams |
Search parameters. |
searchResultList |
Search result list. |
SearchParams
Search parameters.
JSON representation |
---|
{ "maxReturnResults": integer, "filter": string, "boostSpec": { object ( |
Fields | |
---|---|
maxReturnResults |
Number of search results to return. The default value is 10. |
filter |
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter |
boostSpec |
Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting |
orderBy |
The order in which documents are returned. Documents can be ordered by a field in an If this field is unrecognizable, an |
searchResultMode |
Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]: * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to |
dataStoreSpecs[] |
Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. |
SearchResultList
Search result list.
JSON representation |
---|
{
"searchResults": [
{
object ( |
Fields | |
---|---|
searchResults[] |
Search results. |
SearchResult
Search result.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field content . Search result content. content can be only one of the following: |
|
unstructuredDocumentInfo |
Unstructured document information. |
chunkInfo |
Chunk information. |
UnstructuredDocumentInfo
Unstructured document information.
JSON representation |
---|
{ "document": string, "uri": string, "title": string, "documentContexts": [ { object ( |
Fields | |
---|---|
document |
Document resource name. |
uri |
URI for the document. |
title |
Title. |
documentContexts[] |
List of document contexts. |
extractiveSegments[] |
List of extractive segments. |
extractiveAnswers[] |
List of extractive answers. |
DocumentContext
Document context.
JSON representation |
---|
{ "pageIdentifier": string, "content": string } |
Fields | |
---|---|
pageIdentifier |
Page identifier. |
content |
Document content. |
ExtractiveSegment
Extractive segment. Guide
JSON representation |
---|
{ "pageIdentifier": string, "content": string } |
Fields | |
---|---|
pageIdentifier |
Page identifier. |
content |
Extractive segment content. |
ExtractiveAnswer
Extractive answer. Guide
JSON representation |
---|
{ "pageIdentifier": string, "content": string } |
Fields | |
---|---|
pageIdentifier |
Page identifier. |
content |
Extractive answer content. |
ChunkInfo
Chunk information.
JSON representation |
---|
{ "chunk": string, "content": string } |
Fields | |
---|---|
chunk |
Chunk resource name. |
content |
Chunk textual content. |