Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ConverseConversationRequest.
Request message for ConversationalSearchService.ConverseConversation method.
Generated from protobuf message google.cloud.discoveryengine.v1.ConverseConversationRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__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: |
↳ query |
Google\Cloud\DiscoveryEngine\V1\TextInput
Required. Current user input. |
↳ serving_config |
string
The resource name of the Serving Config to use. Format: |
↳ conversation |
Google\Cloud\DiscoveryEngine\V1\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\V1\SearchRequest\ContentSearchSpec\SummarySpec
A specification for configuring the summary returned in the response. |
↳ filter |
string
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an |
↳ boost_spec |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting |
getName
Required. The resource name of the Conversation to get. Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}
.
Use
projects/{project}/locations/{location}/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}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}
.
Use
projects/{project}/locations/{location}/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\V1\TextInput|null |
hasQuery
clearQuery
setQuery
Required. Current user input.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\TextInput
|
Returns | |
---|---|
Type | Description |
$this |
getServingConfig
The resource name of the Serving Config to use. Format:
projects/{project}/locations/{location}/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}/locations/{location}/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\V1\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\V1\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 |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getSummarySpec
A specification for configuring the summary returned in the response.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SummarySpec|null |
hasSummarySpec
clearSummarySpec
setSummarySpec
A specification for configuring the summary returned in the response.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\ContentSearchSpec\SummarySpec
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response.
If this field is unrecognizable, an INVALID_ARGUMENT
is returned.
Filtering in Vertex AI Search is done by mapping the LHS filter key to a
key property defined in the Vertex AI Search backend -- this mapping is
defined by the customer in their schema. For example a media customer might
have a field 'name' in their schema. In this case the filter would look
like this: filter --> name:'ANY("king kong")'
For more information about filtering including syntax and filter
operators, see
Filter
Returns | |
---|---|
Type | Description |
string |
setFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response.
If this field is unrecognizable, an INVALID_ARGUMENT
is returned.
Filtering in Vertex AI Search is done by mapping the LHS filter key to a
key property defined in the Vertex AI Search backend -- this mapping is
defined by the customer in their schema. For example a media customer might
have a field 'name' in their schema. In this case the filter would look
like this: filter --> name:'ANY("king kong")'
For more information about filtering including syntax and filter
operators, see
Filter
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getBoostSpec
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec|null |
hasBoostSpec
clearBoostSpec
setBoostSpec
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
name |
string
Required. The resource name of the Conversation to get. Format:
|
query |
Google\Cloud\DiscoveryEngine\V1\TextInput
Required. Current user input. |
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\ConverseConversationRequest |