Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec (v1.3.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec.

A specification for configuring the behavior of content search.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#chunk_spec

def chunk_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec

Returns

(::Google::Cloud::DiscoveryEngine::V1::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

#chunk_spec=

def chunk_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::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

Returns

(::Google::Cloud::DiscoveryEngine::V1::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

#extractive_content_spec

def extractive_content_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec) — If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

#extractive_content_spec=

def extractive_content_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec) — If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec) — If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

#search_result_mode

def search_result_mode() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode) — Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

#search_result_mode=

def search_result_mode=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode) — Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode) — Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

#snippet_spec

def snippet_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec) — If snippetSpec is not specified, snippets are not included in the search response.

#snippet_spec=

def snippet_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec) — If snippetSpec is not specified, snippets are not included in the search response.

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec) — If snippetSpec is not specified, snippets are not included in the search response.

#summary_spec

def summary_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec) — If summarySpec is not specified, summaries are not included in the search response.

#summary_spec=

def summary_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec) — If summarySpec is not specified, summaries are not included in the search response.

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec) — If summarySpec is not specified, summaries are not included in the search response.