Discovery Engine v1 API - Class ConversationalSearchServiceClientImpl (1.0.0-beta02)

Version 1.0.0-beta02

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public sealed class ConversationalSearchServiceClientImpl : ConversationalSearchServiceClient

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

ConversationalSearchService client wrapper implementation, for convenient use.

Inheritance

object > ConversationalSearchServiceClient > ConversationalSearchServiceClientImpl

Inherited Members

ConversationalSearchServiceClient.DefaultEndpoint

ConversationalSearchServiceClient.DefaultScopes

ConversationalSearchServiceClient.ServiceMetadata

ConversationalSearchServiceClient.CreateAsync(CancellationToken)

ConversationalSearchServiceClient.Create()

ConversationalSearchServiceClient.ShutdownDefaultChannelsAsync()

ConversationalSearchServiceClient.ConverseConversationAsync(ConverseConversationRequest, CancellationToken)

ConversationalSearchServiceClient.ConverseConversation(string, TextInput, CallSettings)

ConversationalSearchServiceClient.ConverseConversationAsync(string, TextInput, CallSettings)

ConversationalSearchServiceClient.ConverseConversationAsync(string, TextInput, CancellationToken)

ConversationalSearchServiceClient.ConverseConversation(ConversationName, TextInput, CallSettings)

ConversationalSearchServiceClient.ConverseConversationAsync(ConversationName, TextInput, CallSettings)

ConversationalSearchServiceClient.ConverseConversationAsync(ConversationName, TextInput, CancellationToken)

ConversationalSearchServiceClient.CreateConversationAsync(CreateConversationRequest, CancellationToken)

ConversationalSearchServiceClient.CreateConversation(string, Conversation, CallSettings)

ConversationalSearchServiceClient.CreateConversationAsync(string, Conversation, CallSettings)

ConversationalSearchServiceClient.CreateConversationAsync(string, Conversation, CancellationToken)

ConversationalSearchServiceClient.CreateConversation(DataStoreName, Conversation, CallSettings)

ConversationalSearchServiceClient.CreateConversationAsync(DataStoreName, Conversation, CallSettings)

ConversationalSearchServiceClient.CreateConversationAsync(DataStoreName, Conversation, CancellationToken)

ConversationalSearchServiceClient.DeleteConversationAsync(DeleteConversationRequest, CancellationToken)

ConversationalSearchServiceClient.DeleteConversation(string, CallSettings)

ConversationalSearchServiceClient.DeleteConversationAsync(string, CallSettings)

ConversationalSearchServiceClient.DeleteConversationAsync(string, CancellationToken)

ConversationalSearchServiceClient.DeleteConversation(ConversationName, CallSettings)

ConversationalSearchServiceClient.DeleteConversationAsync(ConversationName, CallSettings)

ConversationalSearchServiceClient.DeleteConversationAsync(ConversationName, CancellationToken)

ConversationalSearchServiceClient.UpdateConversationAsync(UpdateConversationRequest, CancellationToken)

ConversationalSearchServiceClient.UpdateConversation(Conversation, FieldMask, CallSettings)

ConversationalSearchServiceClient.UpdateConversationAsync(Conversation, FieldMask, CallSettings)

ConversationalSearchServiceClient.UpdateConversationAsync(Conversation, FieldMask, CancellationToken)

ConversationalSearchServiceClient.GetConversationAsync(GetConversationRequest, CancellationToken)

ConversationalSearchServiceClient.GetConversation(string, CallSettings)

ConversationalSearchServiceClient.GetConversationAsync(string, CallSettings)

ConversationalSearchServiceClient.GetConversationAsync(string, CancellationToken)

ConversationalSearchServiceClient.GetConversation(ConversationName, CallSettings)

ConversationalSearchServiceClient.GetConversationAsync(ConversationName, CallSettings)

ConversationalSearchServiceClient.GetConversationAsync(ConversationName, CancellationToken)

ConversationalSearchServiceClient.ListConversations(string, string, int?, CallSettings)

ConversationalSearchServiceClient.ListConversationsAsync(string, string, int?, CallSettings)

ConversationalSearchServiceClient.ListConversations(DataStoreName, string, int?, CallSettings)

ConversationalSearchServiceClient.ListConversationsAsync(DataStoreName, string, int?, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for conversational search.

Constructors

ConversationalSearchServiceClientImpl(ConversationalSearchServiceClient, ConversationalSearchServiceSettings, ILogger)

public ConversationalSearchServiceClientImpl(ConversationalSearchService.ConversationalSearchServiceClient grpcClient, ConversationalSearchServiceSettings settings, ILogger logger)

Constructs a client wrapper for the ConversationalSearchService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	ConversationalSearchServiceConversationalSearchServiceClient The underlying gRPC client.
settings	ConversationalSearchServiceSettings The base ConversationalSearchServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override ConversationalSearchService.ConversationalSearchServiceClient GrpcClient { get; }

The underlying gRPC ConversationalSearchService client

Property Value
Type	Description
ConversationalSearchServiceConversationalSearchServiceClient

Overrides

ConversationalSearchServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

ConversationalSearchServiceClient.LocationsClient

Methods

ConverseConversation(ConverseConversationRequest, CallSettings)

public override ConverseConversationResponse ConverseConversation(ConverseConversationRequest request, CallSettings callSettings = null)

Converses a conversation.

Parameters
Name	Description
request	ConverseConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ConverseConversationResponse	The RPC response.

Overrides

ConversationalSearchServiceClient.ConverseConversation(ConverseConversationRequest, CallSettings)

ConverseConversationAsync(ConverseConversationRequest, CallSettings)

public override Task<ConverseConversationResponse> ConverseConversationAsync(ConverseConversationRequest request, CallSettings callSettings = null)

Converses a conversation.

Parameters
Name	Description
request	ConverseConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConverseConversationResponse	A Task containing the RPC response.

Overrides

ConversationalSearchServiceClient.ConverseConversationAsync(ConverseConversationRequest, CallSettings)

CreateConversation(CreateConversationRequest, CallSettings)

public override Conversation CreateConversation(CreateConversationRequest request, CallSettings callSettings = null)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name	Description
request	CreateConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Conversation	The RPC response.

Overrides

ConversationalSearchServiceClient.CreateConversation(CreateConversationRequest, CallSettings)

CreateConversationAsync(CreateConversationRequest, CallSettings)

public override Task<Conversation> CreateConversationAsync(CreateConversationRequest request, CallSettings callSettings = null)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name	Description
request	CreateConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConversation	A Task containing the RPC response.

Overrides

ConversationalSearchServiceClient.CreateConversationAsync(CreateConversationRequest, CallSettings)

DeleteConversation(DeleteConversationRequest, CallSettings)

public override void DeleteConversation(DeleteConversationRequest request, CallSettings callSettings = null)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
request	DeleteConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

ConversationalSearchServiceClient.DeleteConversation(DeleteConversationRequest, CallSettings)

DeleteConversationAsync(DeleteConversationRequest, CallSettings)

public override Task DeleteConversationAsync(DeleteConversationRequest request, CallSettings callSettings = null)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
request	DeleteConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

ConversationalSearchServiceClient.DeleteConversationAsync(DeleteConversationRequest, CallSettings)

GetConversation(GetConversationRequest, CallSettings)

public override Conversation GetConversation(GetConversationRequest request, CallSettings callSettings = null)

Gets a Conversation.

Parameters
Name	Description
request	GetConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Conversation	The RPC response.

Overrides

ConversationalSearchServiceClient.GetConversation(GetConversationRequest, CallSettings)

GetConversationAsync(GetConversationRequest, CallSettings)

public override Task<Conversation> GetConversationAsync(GetConversationRequest request, CallSettings callSettings = null)

Gets a Conversation.

Parameters
Name	Description
request	GetConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConversation	A Task containing the RPC response.

Overrides

ConversationalSearchServiceClient.GetConversationAsync(GetConversationRequest, CallSettings)

ListConversations(ListConversationsRequest, CallSettings)

public override PagedEnumerable<ListConversationsResponse, Conversation> ListConversations(ListConversationsRequest request, CallSettings callSettings = null)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name	Description
request	ListConversationsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListConversationsResponseConversation	A pageable sequence of Conversation resources.

Overrides

ConversationalSearchServiceClient.ListConversations(ListConversationsRequest, CallSettings)

ListConversationsAsync(ListConversationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConversationsResponse, Conversation> ListConversationsAsync(ListConversationsRequest request, CallSettings callSettings = null)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name	Description
request	ListConversationsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListConversationsResponseConversation	A pageable asynchronous sequence of Conversation resources.

Overrides

ConversationalSearchServiceClient.ListConversationsAsync(ListConversationsRequest, CallSettings)

UpdateConversation(UpdateConversationRequest, CallSettings)

public override Conversation UpdateConversation(UpdateConversationRequest request, CallSettings callSettings = null)

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
request	UpdateConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Conversation	The RPC response.

Overrides

ConversationalSearchServiceClient.UpdateConversation(UpdateConversationRequest, CallSettings)

UpdateConversationAsync(UpdateConversationRequest, CallSettings)

public override Task<Conversation> UpdateConversationAsync(UpdateConversationRequest request, CallSettings callSettings = null)

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
request	UpdateConversationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConversation	A Task containing the RPC response.

Overrides

ConversationalSearchServiceClient.UpdateConversationAsync(UpdateConversationRequest, CallSettings)