Discovery Engine v1 API - Class ConverseConversationRequest (1.5.0)

public sealed class ConverseConversationRequest : IMessage<ConverseConversationRequest>, IEquatable<ConverseConversationRequest>, IDeepCloneable<ConverseConversationRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class ConverseConversationRequest.

Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] method.

Inheritance

object > ConverseConversationRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

ConverseConversationRequest()

public ConverseConversationRequest()

ConverseConversationRequest(ConverseConversationRequest)

public ConverseConversationRequest(ConverseConversationRequest other)
Parameter
Name Description
other ConverseConversationRequest

Properties

BoostSpec

public SearchRequest.Types.BoostSpec BoostSpec { get; set; }

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

Property Value
Type Description
SearchRequestTypesBoostSpec

Conversation

public Conversation Conversation { get; set; }

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.

Property Value
Type Description
Conversation

ConversationName

public ConversationName ConversationName { get; set; }

ConversationName-typed view over the Name resource name property.

Property Value
Type Description
ConversationName

Filter

public string Filter { get; set; }

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

Property Value
Type Description
string

Name

public string Name { get; set; }

Required. The resource name of the Conversation to get. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

Property Value
Type Description
string

Query

public TextInput Query { get; set; }

Required. Current user input.

Property Value
Type Description
TextInput

SafeSearch

public bool SafeSearch { get; set; }

Whether to turn on safe search.

Property Value
Type Description
bool

ServingConfig

public string ServingConfig { get; set; }

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.

Property Value
Type Description
string

ServingConfigAsServingConfigName

public ServingConfigName ServingConfigAsServingConfigName { get; set; }

ServingConfigName-typed view over the ServingConfig resource name property.

Property Value
Type Description
ServingConfigName

SummarySpec

public SearchRequest.Types.ContentSearchSpec.Types.SummarySpec SummarySpec { get; set; }

A specification for configuring the summary returned in the response.

Property Value
Type Description
SearchRequestTypesContentSearchSpecTypesSummarySpec

UserLabels

public MapField<string, string> UserLabels { get; }

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.

Property Value
Type Description
MapFieldstringstring