Class AnswerQueryRequest (0.51.0)

Request message for ConversationalSearchService.AnswerQuery method.

Protobuf type google.cloud.discoveryengine.v1.AnswerQueryRequest

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.

map<string, string> user_labels = 13;

Answer generation specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Answer generation specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Deprecated. google.cloud.discoveryengine.v1.AnswerQueryRequest.asynchronous_mode is deprecated. See google/cloud/discoveryengine/v1/conversational_search_service.proto;l=821

Deprecated: This field is deprecated. Streaming Answer API will be supported.

Asynchronous mode control.

If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.

bool asynchronous_mode = 10 [deprecated = true];

Required. Current user query.

.google.cloud.discoveryengine.v1.Query query = 2 [(.google.api.field_behavior) = REQUIRED];

Required. Current user query.

.google.cloud.discoveryengine.v1.Query query = 2 [(.google.api.field_behavior) = REQUIRED];

Query understanding specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

Query understanding specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

Related questions specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

Related questions specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

Model specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec safety_spec = 4;

Model specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec safety_spec = 4;

Search specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec search_spec = 8;

Search specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec search_spec = 8;

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

The session resource name. Not required.

When session field is not set, the API is in sessionless mode.

We support auto session mode: users can use the wildcard symbol - as session ID. A new ID will be automatically generated and assigned.

string session = 3 [(.google.api.resource_reference) = { ... }

The session resource name. Not required.

When session field is not set, the API is in sessionless mode.

We support auto session mode: users can use the wildcard symbol - as session ID. A new ID will be automatically generated and assigned.

string session = 3 [(.google.api.resource_reference) = { ... }

Use #getUserLabelsMap() instead.

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.

map<string, string> user_labels = 13;

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.

map<string, string> user_labels = 13;

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.

map<string, string> user_labels = 13;

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.

map<string, string> user_labels = 13;

A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

This field should NOT have a fixed value such as unknown_visitor.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string user_pseudo_id = 12;

A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

This field should NOT have a fixed value such as unknown_visitor.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string user_pseudo_id = 12;

Answer generation specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Required. Current user query.

.google.cloud.discoveryengine.v1.Query query = 2 [(.google.api.field_behavior) = REQUIRED];

Query understanding specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

Related questions specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

Model specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec safety_spec = 4;

Search specification.

.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec search_spec = 8;