Google Cloud Discovery Engine V1beta Client - Class ConverseConversationRequest (0.7.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class ConverseConversationRequest.

Request message for ConversationalSearchService.ConverseConversation method.

Generated from protobuf message google.cloud.discoveryengine.v1beta.ConverseConversationRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

↳ query Google\Cloud\DiscoveryEngine\V1beta\TextInput

Required. Current user input.

↳ serving_config string

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.

↳ conversation Google\Cloud\DiscoveryEngine\V1beta\Conversation

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

↳ safe_search bool

Whether to turn on safe search.

↳ user_labels array|Google\Protobuf\Internal\MapField

The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.

↳ summary_spec Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\ContentSearchSpec\SummarySpec

A specification for configuring the summary returned in the response.

getName

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}.

Use projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

Returns
TypeDescription
string

setName

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}.

Use projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getQuery

Required. Current user input.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1beta\TextInput|null

hasQuery

clearQuery

setQuery

Required. Current user input.

Parameter
NameDescription
var Google\Cloud\DiscoveryEngine\V1beta\TextInput
Returns
TypeDescription
$this

getServingConfig

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.

Returns
TypeDescription
string

setServingConfig

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConversation

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1beta\Conversation|null

hasConversation

clearConversation

setConversation

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

Parameter
NameDescription
var Google\Cloud\DiscoveryEngine\V1beta\Conversation
Returns
TypeDescription
$this

getSafeSearch

Whether to turn on safe search.

Returns
TypeDescription
bool

setSafeSearch

Whether to turn on safe search.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getUserLabels

The user labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.

  • Each label must be a key-value pair.

  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.
Returns
TypeDescription
Google\Protobuf\Internal\MapField

setUserLabels

The user labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.

  • Each label must be a key-value pair.

  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.
Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getSummarySpec

A specification for configuring the summary returned in the response.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\ContentSearchSpec\SummarySpec|null

hasSummarySpec

clearSummarySpec

setSummarySpec

A specification for configuring the summary returned in the response.

Parameter
NameDescription
var Google\Cloud\DiscoveryEngine\V1beta\SearchRequest\ContentSearchSpec\SummarySpec
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
name string

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. Please see Google\Cloud\DiscoveryEngine\V1beta\ConversationalSearchServiceClient::conversationName() for help formatting this field.

query Google\Cloud\DiscoveryEngine\V1beta\TextInput

Required. Current user input.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1beta\ConverseConversationRequest