Interface SearchRequest.ContentSearchSpecOrBuilder (0.45.0)

Version 0.45.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface SearchRequest.ContentSearchSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChunkSpec()

public abstract SearchRequest.ContentSearchSpec.ChunkSpec getChunkSpec()

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Returns
Type	Description
SearchRequest.ContentSearchSpec.ChunkSpec	The chunkSpec.

getChunkSpecOrBuilder()

public abstract SearchRequest.ContentSearchSpec.ChunkSpecOrBuilder getChunkSpecOrBuilder()

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Returns
Type	Description
SearchRequest.ContentSearchSpec.ChunkSpecOrBuilder

getExtractiveContentSpec()

public abstract SearchRequest.ContentSearchSpec.ExtractiveContentSpec getExtractiveContentSpec()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec	The extractiveContentSpec.

getExtractiveContentSpecOrBuilder()

public abstract SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder getExtractiveContentSpecOrBuilder()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

getSearchResultMode()

public abstract SearchRequest.ContentSearchSpec.SearchResultMode getSearchResultMode()

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.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SearchResultMode	The searchResultMode.

getSearchResultModeValue()

public abstract int getSearchResultModeValue()

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.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;

Returns
Type	Description
int	The enum numeric value on the wire for searchResultMode.

getSnippetSpec()

public abstract SearchRequest.ContentSearchSpec.SnippetSpec getSnippetSpec()

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SnippetSpec	The snippetSpec.

getSnippetSpecOrBuilder()

public abstract SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder getSnippetSpecOrBuilder()

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

getSummarySpec()

public abstract SearchRequest.ContentSearchSpec.SummarySpec getSummarySpec()

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec	The summarySpec.

getSummarySpecOrBuilder()

public abstract SearchRequest.ContentSearchSpec.SummarySpecOrBuilder getSummarySpecOrBuilder()

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

hasChunkSpec()

public abstract boolean hasChunkSpec()

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Returns
Type	Description
boolean	Whether the chunkSpec field is set.

hasExtractiveContentSpec()

public abstract boolean hasExtractiveContentSpec()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
Type	Description
boolean	Whether the extractiveContentSpec field is set.

hasSnippetSpec()

public abstract boolean hasSnippetSpec()

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
Type	Description
boolean	Whether the snippetSpec field is set.

hasSummarySpec()

public abstract boolean hasSummarySpec()

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
Type	Description
boolean	Whether the summarySpec field is set.