Discovery Engine v1 API - Class ConversationalSearchServiceClientImpl (1.6.0) 

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

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

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

AnswerQuery(AnswerQueryRequest, CallSettings)

public override AnswerQueryResponse AnswerQuery(AnswerQueryRequest request, CallSettings callSettings = null)

Answer query method.

Parameters
Name Description
request AnswerQueryRequest

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
AnswerQueryResponse

The RPC response.
Overrides

AnswerQueryAsync(AnswerQueryRequest, CallSettings)

public override Task<AnswerQueryResponse> AnswerQueryAsync(AnswerQueryRequest request, CallSettings callSettings = null)

Answer query method.

Parameters
Name Description
request AnswerQueryRequest

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
TaskAnswerQueryResponse

A Task containing the RPC response.
Overrides

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

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

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

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

CreateSession(CreateSessionRequest, CallSettings)

public override Session CreateSession(CreateSessionRequest request, CallSettings callSettings = null)

Creates a Session.

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

Parameters
Name Description
request CreateSessionRequest

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
Session

The RPC response.
Overrides

CreateSessionAsync(CreateSessionRequest, CallSettings)

public override Task<Session> CreateSessionAsync(CreateSessionRequest request, CallSettings callSettings = null)

Creates a Session.

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

Parameters
Name Description
request CreateSessionRequest

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
TaskSession

A Task containing the RPC response.
Overrides

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

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

DeleteSession(DeleteSessionRequest, CallSettings)

public override void DeleteSession(DeleteSessionRequest request, CallSettings callSettings = null)

Deletes a Session.

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

Parameters
Name Description
request DeleteSessionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteSessionAsync(DeleteSessionRequest, CallSettings)

public override Task DeleteSessionAsync(DeleteSessionRequest request, CallSettings callSettings = null)

Deletes a Session.

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

Parameters
Name Description
request DeleteSessionRequest

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

GetAnswer(GetAnswerRequest, CallSettings)

public override Answer GetAnswer(GetAnswerRequest request, CallSettings callSettings = null)

Gets a Answer.

Parameters
Name Description
request GetAnswerRequest

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
Answer

The RPC response.
Overrides

GetAnswerAsync(GetAnswerRequest, CallSettings)

public override Task<Answer> GetAnswerAsync(GetAnswerRequest request, CallSettings callSettings = null)

Gets a Answer.

Parameters
Name Description
request GetAnswerRequest

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
TaskAnswer

A Task containing the RPC response.
Overrides

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

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

GetSession(GetSessionRequest, CallSettings)

public override Session GetSession(GetSessionRequest request, CallSettings callSettings = null)

Gets a Session.

Parameters
Name Description
request GetSessionRequest

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
Session

The RPC response.
Overrides

GetSessionAsync(GetSessionRequest, CallSettings)

public override Task<Session> GetSessionAsync(GetSessionRequest request, CallSettings callSettings = null)

Gets a Session.

Parameters
Name Description
request GetSessionRequest

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
TaskSession

A Task containing the RPC response.
Overrides

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

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

ListSessions(ListSessionsRequest, CallSettings)

public override PagedEnumerable<ListSessionsResponse, Session> ListSessions(ListSessionsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListSessionsRequest

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
PagedEnumerableListSessionsResponseSession

A pageable sequence of Session resources.
Overrides

ListSessionsAsync(ListSessionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSessionsResponse, Session> ListSessionsAsync(ListSessionsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListSessionsRequest

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
PagedAsyncEnumerableListSessionsResponseSession

A pageable asynchronous sequence of Session resources.
Overrides

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

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

UpdateSession(UpdateSessionRequest, CallSettings)

public override Session UpdateSession(UpdateSessionRequest request, CallSettings callSettings = null)

Updates a Session.

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

Parameters
Name Description
request UpdateSessionRequest

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
Session

The RPC response.
Overrides

UpdateSessionAsync(UpdateSessionRequest, CallSettings)

public override Task<Session> UpdateSessionAsync(UpdateSessionRequest request, CallSettings callSettings = null)

Updates a Session.

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

Parameters
Name Description
request UpdateSessionRequest

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
TaskSession

A Task containing the RPC response.
Overrides