Gemini Enterprise for Customer Experience v1 API - Class AgentService.AgentServiceBase (1.0.0-beta01)

[BindServiceMethod(typeof(AgentService), "BindService")]
public abstract class AgentService.AgentServiceBase

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class AgentService.AgentServiceBase.

Base class for server-side implementations of AgentService

Inheritance

object > AgentService.AgentServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Methods

BatchDeleteConversations(BatchDeleteConversationsRequest, ServerCallContext)

public virtual Task<Operation> BatchDeleteConversations(BatchDeleteConversationsRequest request, ServerCallContext context)

Batch deletes the specified conversations.

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

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

CreateAgent(CreateAgentRequest, ServerCallContext)

public virtual Task<Agent> CreateAgent(CreateAgentRequest request, ServerCallContext context)

Creates a new agent in the given app.

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

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

CreateApp(CreateAppRequest, ServerCallContext)

public virtual Task<Operation> CreateApp(CreateAppRequest request, ServerCallContext context)

Creates a new app in the given project and location.

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

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

CreateAppVersion(CreateAppVersionRequest, ServerCallContext)

public virtual Task<AppVersion> CreateAppVersion(CreateAppVersionRequest request, ServerCallContext context)

Creates a new app version in the given app.

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

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

CreateDeployment(CreateDeploymentRequest, ServerCallContext)

public virtual Task<Deployment> CreateDeployment(CreateDeploymentRequest request, ServerCallContext context)

Creates a new deployment in the given app.

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

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

CreateExample(CreateExampleRequest, ServerCallContext)

public virtual Task<Example> CreateExample(CreateExampleRequest request, ServerCallContext context)

Creates a new example in the given app.

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

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

CreateGuardrail(CreateGuardrailRequest, ServerCallContext)

public virtual Task<Guardrail> CreateGuardrail(CreateGuardrailRequest request, ServerCallContext context)

Creates a new guardrail in the given app.

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

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

CreateTool(CreateToolRequest, ServerCallContext)

public virtual Task<Tool> CreateTool(CreateToolRequest request, ServerCallContext context)

Creates a new tool in the given app.

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

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

CreateToolset(CreateToolsetRequest, ServerCallContext)

public virtual Task<Toolset> CreateToolset(CreateToolsetRequest request, ServerCallContext context)

Creates a new toolset in the given app.

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

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

DeleteAgent(DeleteAgentRequest, ServerCallContext)

public virtual Task<Empty> DeleteAgent(DeleteAgentRequest request, ServerCallContext context)

Deletes the specified agent.

Parameters
Name	Description
request	DeleteAgentRequest 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).

DeleteApp(DeleteAppRequest, ServerCallContext)

public virtual Task<Operation> DeleteApp(DeleteAppRequest request, ServerCallContext context)

Deletes the specified app.

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

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

DeleteAppVersion(DeleteAppVersionRequest, ServerCallContext)

public virtual Task<Empty> DeleteAppVersion(DeleteAppVersionRequest request, ServerCallContext context)

Deletes the specified app version.

Parameters
Name	Description
request	DeleteAppVersionRequest 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).

DeleteConversation(DeleteConversationRequest, ServerCallContext)

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

Deletes the specified conversation.

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).

DeleteDeployment(DeleteDeploymentRequest, ServerCallContext)

public virtual Task<Empty> DeleteDeployment(DeleteDeploymentRequest request, ServerCallContext context)

Deletes the specified deployment.

Parameters
Name	Description
request	DeleteDeploymentRequest 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).

DeleteExample(DeleteExampleRequest, ServerCallContext)

public virtual Task<Empty> DeleteExample(DeleteExampleRequest request, ServerCallContext context)

Deletes the specified example.

Parameters
Name	Description
request	DeleteExampleRequest 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).

DeleteGuardrail(DeleteGuardrailRequest, ServerCallContext)

public virtual Task<Empty> DeleteGuardrail(DeleteGuardrailRequest request, ServerCallContext context)

Deletes the specified guardrail.

Parameters
Name	Description
request	DeleteGuardrailRequest 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).

DeleteTool(DeleteToolRequest, ServerCallContext)

public virtual Task<Empty> DeleteTool(DeleteToolRequest request, ServerCallContext context)

Deletes the specified tool.

Parameters
Name	Description
request	DeleteToolRequest 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).

DeleteToolset(DeleteToolsetRequest, ServerCallContext)

public virtual Task<Empty> DeleteToolset(DeleteToolsetRequest request, ServerCallContext context)

Deletes the specified toolset.

Parameters
Name	Description
request	DeleteToolsetRequest 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).

ExportApp(ExportAppRequest, ServerCallContext)

public virtual Task<Operation> ExportApp(ExportAppRequest request, ServerCallContext context)

Exports the specified app.

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

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

GetAgent(GetAgentRequest, ServerCallContext)

public virtual Task<Agent> GetAgent(GetAgentRequest request, ServerCallContext context)

Gets details of the specified agent.

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

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

GetApp(GetAppRequest, ServerCallContext)

public virtual Task<App> GetApp(GetAppRequest request, ServerCallContext context)

Gets details of the specified app.

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

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

GetAppVersion(GetAppVersionRequest, ServerCallContext)

public virtual Task<AppVersion> GetAppVersion(GetAppVersionRequest request, ServerCallContext context)

Gets details of the specified app version.

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

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

GetChangelog(GetChangelogRequest, ServerCallContext)

public virtual Task<Changelog> GetChangelog(GetChangelogRequest request, ServerCallContext context)

Gets the specified changelog.

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

Returns
Type	Description
TaskChangelog	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 details of the specified 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).

GetDeployment(GetDeploymentRequest, ServerCallContext)

public virtual Task<Deployment> GetDeployment(GetDeploymentRequest request, ServerCallContext context)

Gets details of the specified deployment.

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

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

GetExample(GetExampleRequest, ServerCallContext)

public virtual Task<Example> GetExample(GetExampleRequest request, ServerCallContext context)

Gets details of the specified example.

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

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

GetGuardrail(GetGuardrailRequest, ServerCallContext)

public virtual Task<Guardrail> GetGuardrail(GetGuardrailRequest request, ServerCallContext context)

Gets details of the specified guardrail.

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

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

GetTool(GetToolRequest, ServerCallContext)

public virtual Task<Tool> GetTool(GetToolRequest request, ServerCallContext context)

Gets details of the specified tool.

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

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

GetToolset(GetToolsetRequest, ServerCallContext)

public virtual Task<Toolset> GetToolset(GetToolsetRequest request, ServerCallContext context)

Gets details of the specified toolset.

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

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

ImportApp(ImportAppRequest, ServerCallContext)

public virtual Task<Operation> ImportApp(ImportAppRequest request, ServerCallContext context)

Imports the specified app.

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

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

ListAgents(ListAgentsRequest, ServerCallContext)

public virtual Task<ListAgentsResponse> ListAgents(ListAgentsRequest request, ServerCallContext context)

Lists agents in the given app.

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

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

ListAppVersions(ListAppVersionsRequest, ServerCallContext)

public virtual Task<ListAppVersionsResponse> ListAppVersions(ListAppVersionsRequest request, ServerCallContext context)

Lists all app versions in the given app.

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

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

ListApps(ListAppsRequest, ServerCallContext)

public virtual Task<ListAppsResponse> ListApps(ListAppsRequest request, ServerCallContext context)

Lists apps in the given project and location.

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

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

ListChangelogs(ListChangelogsRequest, ServerCallContext)

public virtual Task<ListChangelogsResponse> ListChangelogs(ListChangelogsRequest request, ServerCallContext context)

Lists the changelogs of the specified app.

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

Returns
Type	Description
TaskListChangelogsResponse	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 conversations in the given app.

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).

ListDeployments(ListDeploymentsRequest, ServerCallContext)

public virtual Task<ListDeploymentsResponse> ListDeployments(ListDeploymentsRequest request, ServerCallContext context)

Lists deployments in the given app.

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

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

ListExamples(ListExamplesRequest, ServerCallContext)

public virtual Task<ListExamplesResponse> ListExamples(ListExamplesRequest request, ServerCallContext context)

Lists examples in the given app.

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

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

ListGuardrails(ListGuardrailsRequest, ServerCallContext)

public virtual Task<ListGuardrailsResponse> ListGuardrails(ListGuardrailsRequest request, ServerCallContext context)

Lists guardrails in the given app.

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

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

ListTools(ListToolsRequest, ServerCallContext)

public virtual Task<ListToolsResponse> ListTools(ListToolsRequest request, ServerCallContext context)

Lists tools in the given app.

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

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

ListToolsets(ListToolsetsRequest, ServerCallContext)

public virtual Task<ListToolsetsResponse> ListToolsets(ListToolsetsRequest request, ServerCallContext context)

Lists toolsets in the given app.

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

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

RestoreAppVersion(RestoreAppVersionRequest, ServerCallContext)

public virtual Task<Operation> RestoreAppVersion(RestoreAppVersionRequest request, ServerCallContext context)

Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.

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

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

UpdateAgent(UpdateAgentRequest, ServerCallContext)

public virtual Task<Agent> UpdateAgent(UpdateAgentRequest request, ServerCallContext context)

Updates the specified agent.

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

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

UpdateApp(UpdateAppRequest, ServerCallContext)

public virtual Task<App> UpdateApp(UpdateAppRequest request, ServerCallContext context)

Updates the specified app.

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

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

UpdateDeployment(UpdateDeploymentRequest, ServerCallContext)

public virtual Task<Deployment> UpdateDeployment(UpdateDeploymentRequest request, ServerCallContext context)

Updates the specified deployment.

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

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

UpdateExample(UpdateExampleRequest, ServerCallContext)

public virtual Task<Example> UpdateExample(UpdateExampleRequest request, ServerCallContext context)

Updates the specified example.

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

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

UpdateGuardrail(UpdateGuardrailRequest, ServerCallContext)

public virtual Task<Guardrail> UpdateGuardrail(UpdateGuardrailRequest request, ServerCallContext context)

Updates the specified guardrail.

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

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

UpdateTool(UpdateToolRequest, ServerCallContext)

public virtual Task<Tool> UpdateTool(UpdateToolRequest request, ServerCallContext context)

Updates the specified tool.

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

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

UpdateToolset(UpdateToolsetRequest, ServerCallContext)

public virtual Task<Toolset> UpdateToolset(UpdateToolsetRequest request, ServerCallContext context)

Updates the specified toolset.

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

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