Class ContentSearchSpec (0.11.12)

Version 0.11.12

• 0.13.4 (latest)
• 0.13.3
• 0.12.3
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

ContentSearchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A specification for configuring the behavior of content search.

Attributes
Name	Description
snippet_spec	google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SnippetSpec If snippetSpec is not specified, snippets are not included in the search response.
summary_spec	google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SummarySpec If summarySpec is not specified, summaries are not included in the search response.
extractive_content_spec	google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.ExtractiveContentSpec If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
search_result_mode	google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.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.
chunk_spec	google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.ChunkSpec Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

Classes

ChunkSpec

ChunkSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

ExtractiveContentSpec

ExtractiveContentSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A specification for configuring the extractive content in a search response.

SearchResultMode

SearchResultMode(value)

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.

SnippetSpec

SnippetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A specification for configuring snippets in a search response.

SummarySpec

SummarySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A specification for configuring a summary returned in a search response.