Class GoogleCloudDiscoveryengineV1ConverseConversationRequest

Request message for ConversationalSearchService.ConverseConversation method.

Inheritance
object
GoogleCloudDiscoveryengineV1ConverseConversationRequest
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1.Data
Assembly: Google.Apis.DiscoveryEngine.v1.dll
Syntax
public class GoogleCloudDiscoveryengineV1ConverseConversationRequest : IDirectResponseSchema

Properties

BoostSpec

Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting

Declaration
[JsonProperty("boostSpec")]
public virtual GoogleCloudDiscoveryengineV1SearchRequestBoostSpec BoostSpec { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1SearchRequestBoostSpec

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.

Declaration
[JsonProperty("conversation")]
public virtual GoogleCloudDiscoveryengineV1Conversation Conversation { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1Conversation

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Filter

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

Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type Description
string

Query

Required. Current user input.

Declaration
[JsonProperty("query")]
public virtual GoogleCloudDiscoveryengineV1TextInput Query { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1TextInput

SafeSearch

Whether to turn on safe search.

Declaration
[JsonProperty("safeSearch")]
public virtual bool? SafeSearch { get; set; }
Property Value
Type Description
bool?

ServingConfig

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.

Declaration
[JsonProperty("servingConfig")]
public virtual string ServingConfig { get; set; }
Property Value
Type Description
string

SummarySpec

A specification for configuring the summary returned in the response.

Declaration
[JsonProperty("summarySpec")]
public virtual GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec SummarySpec { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec

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>

Implements