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.
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
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.
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
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis documentation details the \u003ccode\u003eConverseConversationRequest\u003c/code\u003e class, which is used to structure requests for the \u003ccode\u003eConversationalSearchService.ConverseConversation\u003c/code\u003e method in the Discovery Engine v1 API.\u003c/p\u003e\n"],["\u003cp\u003eThe class supports several properties, including \u003ccode\u003eBoostSpec\u003c/code\u003e, \u003ccode\u003eConversation\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eQuery\u003c/code\u003e, and \u003ccode\u003eSummarySpec\u003c/code\u003e, to refine the conversational search and its results.\u003c/p\u003e\n"],["\u003cp\u003eIt allows for setting the conversation's name, utilizing filters to refine search results, specifying a serving configuration, and applying user labels for better resource management.\u003c/p\u003e\n"],["\u003cp\u003eThe available versions of the class are listed, with version 1.6.0 being the latest.\u003c/p\u003e\n"],["\u003cp\u003eThe class inherits from the .NET \u003ccode\u003eobject\u003c/code\u003e class, while also implementing \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e and \u003ccode\u003eIBufferMessage\u003c/code\u003e interfaces.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class ConverseConversationRequest (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest) \n\n public sealed class ConverseConversationRequest : IMessage\u003cConverseConversationRequest\u003e, IEquatable\u003cConverseConversationRequest\u003e, IDeepCloneable\u003cConverseConversationRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1 API class ConverseConversationRequest.\n\nRequest message for\n\\[ConversationalSearchService.ConverseConversation\\]\\[google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation\\]\nmethod. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ConverseConversationRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ConverseConversationRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ConverseConversationRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ConverseConversationRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.dll\n\nConstructors\n------------\n\n### ConverseConversationRequest()\n\n public ConverseConversationRequest()\n\n### ConverseConversationRequest(ConverseConversationRequest)\n\n public ConverseConversationRequest(ConverseConversationRequest other)\n\nProperties\n----------\n\n### BoostSpec\n\n public SearchRequest.Types.BoostSpec BoostSpec { get; set; }\n\nBoost specification to boost certain documents in search results which may\naffect the converse response. For more information on boosting, see\n[Boosting](https://cloud.google.com/retail/docs/boosting#boost)\n\n### Conversation\n\n public Conversation Conversation { get; set; }\n\nThe conversation to be used by auto session only. The name field will be\nignored as we automatically assign new name for the conversation in auto\nsession.\n\n### ConversationName\n\n public ConversationName ConversationName { get; set; }\n\n[ConversationName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ConversationName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest#Google_Cloud_DiscoveryEngine_V1_ConverseConversationRequest_Name) resource name property.\n\n### Filter\n\n public string Filter { get; set; }\n\nThe filter syntax consists of an expression language for constructing a\npredicate from one or more fields of the documents being filtered. Filter\nexpression is case-sensitive. This will be used to filter search results\nwhich may affect the summary response.\n\nIf this field is unrecognizable, an `INVALID_ARGUMENT` is returned.\n\nFiltering in Vertex AI Search is done by mapping the LHS filter key to a\nkey property defined in the Vertex AI Search backend -- this mapping is\ndefined by the customer in their schema. For example a media customer might\nhave a field 'name' in their schema. In this case the filter would look\nlike this: filter --\\\u003e name:'ANY(\"king kong\")'\n\nFor more information about filtering including syntax and filter\noperators, see\n[Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)\n\n### Name\n\n public string Name { get; set; }\n\nRequired. The resource name of the Conversation to get. Format:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.\nUse\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`\nto activate auto session mode, which automatically creates a new\nconversation inside a ConverseConversation session.\n\n### Query\n\n public TextInput Query { get; set; }\n\nRequired. Current user input.\n\n### SafeSearch\n\n public bool SafeSearch { get; set; }\n\nWhether to turn on safe search.\n\n### ServingConfig\n\n public string ServingConfig { get; set; }\n\nThe resource name of the Serving Config to use. Format:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`\nIf this is not set, the default serving config will be used.\n\n### ServingConfigAsServingConfigName\n\n public ServingConfigName ServingConfigAsServingConfigName { get; set; }\n\n[ServingConfigName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ServingConfigName)-typed view over the [ServingConfig](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ConverseConversationRequest#Google_Cloud_DiscoveryEngine_V1_ConverseConversationRequest_ServingConfig) resource name property.\n\n### SummarySpec\n\n public SearchRequest.Types.ContentSearchSpec.Types.SummarySpec SummarySpec { get; set; }\n\nA specification for configuring the summary returned in the response.\n\n### UserLabels\n\n public MapField\u003cstring, string\u003e UserLabels { get; }\n\nThe user labels applied to a resource must meet the following requirements:\n\n- Each resource can have multiple labels, up to a maximum of 64.\n- Each label must be a key-value pair.\n- 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.\n- 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.\n- The key portion of a label must be unique. However, you can use the same key with multiple resources.\n- Keys must start with a lowercase letter or international character.\n\nSee [Google Cloud\nDocument](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)\nfor more details."]]
