Google Cloud Discovery Engine V1 Client - Class ContentSearchSpec (0.11.3)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ContentSearchSpec.

A specification for configuring the behavior of content search.

Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ snippet_spec Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SnippetSpec

If snippetSpec is not specified, snippets are not included in the search response.
↳ summary_spec Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SummarySpec

If summarySpec is not specified, summaries are not included in the search response.
↳ extractive_content_spec 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.

getSnippetSpec

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

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SnippetSpec|null

hasSnippetSpec

clearSnippetSpec

setSnippetSpec

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

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SnippetSpec
Returns
Type Description
$this

getSummarySpec

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

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SummarySpec|null

hasSummarySpec

clearSummarySpec

setSummarySpec

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

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SummarySpec
Returns
Type Description
$this

getExtractiveContentSpec

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

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\ExtractiveContentSpec|null

hasExtractiveContentSpec

clearExtractiveContentSpec

setExtractiveContentSpec

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

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\ExtractiveContentSpec
Returns
Type Description
$this