Google Cloud Discovery Engine V1 Client - Class SearchResultMode (1.0.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class 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 CHUNKS.

  • Otherwise, it defaults to DOCUMENTS.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest \ ContentSearchSpec

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

SEARCH_RESULT_MODE_UNSPECIFIED

Value: 0

Default value.

Generated from protobuf enum SEARCH_RESULT_MODE_UNSPECIFIED = 0;

DOCUMENTS

Value: 1

Returns documents in the search result.

Generated from protobuf enum DOCUMENTS = 1;

CHUNKS

Value: 2

Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified.

Generated from protobuf enum CHUNKS = 2;