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

Version 0.6.0

• 0.11.3 (latest)
• 0.11.2
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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
Name	Description
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.

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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$this

getQuery

Required. Current user input.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\TextInput|null

hasQuery

clearQuery

setQuery

Required. Current user input.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\TextInput

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\Conversation

Returns
Type	Description
$this

getSafeSearch

Whether to turn on safe search.

Returns
Type	Description
bool

setSafeSearch

Whether to turn on safe search.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

static::build

Parameters
Name	Description
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
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\ConverseConversationRequest