ConverseConversationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for ConversationalSearchService.ConverseConversation method.
Attributes |
|
|---|---|
| Name | Description |
name |
str
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_v1alpha.types.TextInput
Required. Current user input. |
serving_config |
str
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_v1alpha.types.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 |
MutableMapping[str, str]
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 |
summary_spec |
google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SummarySpec
A specification for configuring the summary returned in the response. |
filter |
str
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 __
|
boost_spec |
google.cloud.discoveryengine_v1alpha.types.SearchRequest.BoostSpec
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting __
|
Classes
UserLabelsEntry
UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |