GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequest (google_api_discovery_engine v0.28.0)
View SourceRequest message for ConversationalSearchService.AnswerQuery method.
Attributes
-
answerGenerationSpec(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec.t, default:nil) - Answer generation specification. -
asynchronousMode(type:boolean(), default:nil) - 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. -
endUserSpec(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec.t, default:nil) - Optional. End user specification. -
groundingSpec(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec.t, default:nil) - Optional. Grounding specification. -
query(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1Query.t, default:nil) - Required. Current user query. -
queryUnderstandingSpec(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec.t, default:nil) - Query understanding specification. -
relatedQuestionsSpec(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec.t, default:nil) - Related questions specification. -
safetySpec(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec.t, default:nil) - Model specification. -
searchSpec(type:GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec.t, default:nil) - Search specification. -
session(type:String.t, default:nil) - 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. -
userLabels(type:map(), default:nil) - 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. -
userPseudoId(type:String.t, default:nil) - 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 asunknown_visitor. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, anINVALID_ARGUMENTerror is returned.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequest{ answerGenerationSpec: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec.t() | nil, asynchronousMode: boolean() | nil, endUserSpec: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec.t() | nil, groundingSpec: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec.t() | nil, query: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1Query.t() | nil, queryUnderstandingSpec: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec.t() | nil, relatedQuestionsSpec: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec.t() | nil, safetySpec: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec.t() | nil, searchSpec: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec.t() | nil, session: String.t() | nil, userLabels: map() | nil, userPseudoId: String.t() | nil }