Class GoogleCloudDiscoveryengineV1AnswerQueryRequest

Request message for ConversationalSearchService.AnswerQuery method.

Inheritance

object

GoogleCloudDiscoveryengineV1AnswerQueryRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1.Data

Assembly: Google.Apis.DiscoveryEngine.v1.dll

Syntax

public class GoogleCloudDiscoveryengineV1AnswerQueryRequest : IDirectResponseSchema

Properties

AnswerGenerationSpec

Answer generation specification.

Declaration

[JsonProperty("answerGenerationSpec")]
public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec AnswerGenerationSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec

AsynchronousMode

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.

Declaration

[JsonProperty("asynchronousMode")]
public virtual bool? AsynchronousMode { get; set; }

Property Value

Type	Description
bool?

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

GroundingSpec

Optional. Grounding specification.

Declaration

[JsonProperty("groundingSpec")]
public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec GroundingSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec

Query

Required. Current user query.

Declaration

[JsonProperty("query")]
public virtual GoogleCloudDiscoveryengineV1Query Query { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1Query

QueryUnderstandingSpec

Query understanding specification.

Declaration

[JsonProperty("queryUnderstandingSpec")]
public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec QueryUnderstandingSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec

RelatedQuestionsSpec

Related questions specification.

Declaration

[JsonProperty("relatedQuestionsSpec")]
public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec RelatedQuestionsSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec

SafetySpec

Model specification.

Declaration

[JsonProperty("safetySpec")]
public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec SafetySpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec

SearchSpec

Search specification.

Declaration

[JsonProperty("searchSpec")]
public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec SearchSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec

Session

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.

Declaration

[JsonProperty("session")]
public virtual string Session { get; set; }

Property Value

Type	Description
string

UserLabels

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.

Declaration

[JsonProperty("userLabels")]
public virtual IDictionary<string, string> UserLabels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

UserPseudoId

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.

Declaration

[JsonProperty("userPseudoId")]
public virtual string UserPseudoId { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema