Discovery Engine v1 API - Class ConversationalSearchService.ConversationalSearchServiceBase (1.6.0)

Version latest

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

[BindServiceMethod(typeof(ConversationalSearchService), "BindService")]
public abstract class ConversationalSearchService.ConversationalSearchServiceBase

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

Base class for server-side implementations of ConversationalSearchService

Inheritance

object > ConversationalSearchService.ConversationalSearchServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Methods

AnswerQuery(AnswerQueryRequest, ServerCallContext)

public virtual Task<AnswerQueryResponse> AnswerQuery(AnswerQueryRequest request, ServerCallContext context)

Answer query method.

Parameters
Name	Description
request	AnswerQueryRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnswerQueryResponse	The response to send back to the client (wrapped by a task).

ConverseConversation(ConverseConversationRequest, ServerCallContext)

public virtual Task<ConverseConversationResponse> ConverseConversation(ConverseConversationRequest request, ServerCallContext context)

Converses a conversation.

Parameters
Name	Description
request	ConverseConversationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConverseConversationResponse	The response to send back to the client (wrapped by a task).

CreateConversation(CreateConversationRequest, ServerCallContext)

public virtual Task<Conversation> CreateConversation(CreateConversationRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConversation	The response to send back to the client (wrapped by a task).

CreateSession(CreateSessionRequest, ServerCallContext)

public virtual Task<Session> CreateSession(CreateSessionRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSession	The response to send back to the client (wrapped by a task).

DeleteConversation(DeleteConversationRequest, ServerCallContext)

public virtual Task<Empty> DeleteConversation(DeleteConversationRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteSession(DeleteSessionRequest, ServerCallContext)

public virtual Task<Empty> DeleteSession(DeleteSessionRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

GetAnswer(GetAnswerRequest, ServerCallContext)

public virtual Task<Answer> GetAnswer(GetAnswerRequest request, ServerCallContext context)

Gets a Answer.

Parameters
Name	Description
request	GetAnswerRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnswer	The response to send back to the client (wrapped by a task).

GetConversation(GetConversationRequest, ServerCallContext)

public virtual Task<Conversation> GetConversation(GetConversationRequest request, ServerCallContext context)

Gets a Conversation.

Parameters
Name	Description
request	GetConversationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConversation	The response to send back to the client (wrapped by a task).

GetSession(GetSessionRequest, ServerCallContext)

public virtual Task<Session> GetSession(GetSessionRequest request, ServerCallContext context)

Gets a Session.

Parameters
Name	Description
request	GetSessionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSession	The response to send back to the client (wrapped by a task).

ListConversations(ListConversationsRequest, ServerCallContext)

public virtual Task<ListConversationsResponse> ListConversations(ListConversationsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListConversationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListConversationsResponse	The response to send back to the client (wrapped by a task).

ListSessions(ListSessionsRequest, ServerCallContext)

public virtual Task<ListSessionsResponse> ListSessions(ListSessionsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListSessionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListSessionsResponse	The response to send back to the client (wrapped by a task).

UpdateConversation(UpdateConversationRequest, ServerCallContext)

public virtual Task<Conversation> UpdateConversation(UpdateConversationRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConversation	The response to send back to the client (wrapped by a task).

UpdateSession(UpdateSessionRequest, ServerCallContext)

public virtual Task<Session> UpdateSession(UpdateSessionRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSession	The response to send back to the client (wrapped by a task).