ces

import { ces } from "https://googleapis.deno.dev/v1/ces:v1.ts";

class ces {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsAppsAgentsCreate(

parent: string,

req: Agent,

opts?: ProjectsLocationsAppsAgentsCreateOptions,

): Promise<Agent>;

async projectsLocationsAppsAgentsDelete(name: string, opts?: ProjectsLocationsAppsAgentsDeleteOptions): Promise<Empty>;

async projectsLocationsAppsAgentsGet(name: string): Promise<Agent>;

async projectsLocationsAppsAgentsList(parent: string, opts?: ProjectsLocationsAppsAgentsListOptions): Promise<ListAgentsResponse>;

async projectsLocationsAppsAgentsPatch(

req: Agent,

opts?: ProjectsLocationsAppsAgentsPatchOptions,

): Promise<Agent>;

async projectsLocationsAppsChangelogsGet(name: string): Promise<Changelog>;

async projectsLocationsAppsChangelogsList(parent: string, opts?: ProjectsLocationsAppsChangelogsListOptions): Promise<ListChangelogsResponse>;

async projectsLocationsAppsConversationsBatchDelete(parent: string, req: BatchDeleteConversationsRequest): Promise<Operation>;

async projectsLocationsAppsConversationsDelete(name: string, opts?: ProjectsLocationsAppsConversationsDeleteOptions): Promise<Empty>;

async projectsLocationsAppsConversationsGet(name: string, opts?: ProjectsLocationsAppsConversationsGetOptions): Promise<Conversation>;

async projectsLocationsAppsConversationsList(parent: string, opts?: ProjectsLocationsAppsConversationsListOptions): Promise<ListConversationsResponse>;

async projectsLocationsAppsCreate(

parent: string,

req: App,

opts?: ProjectsLocationsAppsCreateOptions,

): Promise<Operation>;

async projectsLocationsAppsDelete(name: string, opts?: ProjectsLocationsAppsDeleteOptions): Promise<Operation>;

async projectsLocationsAppsDeploymentsCreate(

parent: string,

req: Deployment,

opts?: ProjectsLocationsAppsDeploymentsCreateOptions,

): Promise<Deployment>;

async projectsLocationsAppsDeploymentsDelete(name: string, opts?: ProjectsLocationsAppsDeploymentsDeleteOptions): Promise<Empty>;

async projectsLocationsAppsDeploymentsGet(name: string): Promise<Deployment>;

async projectsLocationsAppsDeploymentsList(parent: string, opts?: ProjectsLocationsAppsDeploymentsListOptions): Promise<ListDeploymentsResponse>;

async projectsLocationsAppsDeploymentsPatch(

req: Deployment,

opts?: ProjectsLocationsAppsDeploymentsPatchOptions,

): Promise<Deployment>;

async projectsLocationsAppsExamplesCreate(

parent: string,

req: Example,

opts?: ProjectsLocationsAppsExamplesCreateOptions,

): Promise<Example>;

async projectsLocationsAppsExamplesDelete(name: string, opts?: ProjectsLocationsAppsExamplesDeleteOptions): Promise<Empty>;

async projectsLocationsAppsExamplesGet(name: string): Promise<Example>;

async projectsLocationsAppsExamplesList(parent: string, opts?: ProjectsLocationsAppsExamplesListOptions): Promise<ListExamplesResponse>;

async projectsLocationsAppsExamplesPatch(

req: Example,

opts?: ProjectsLocationsAppsExamplesPatchOptions,

): Promise<Example>;

async projectsLocationsAppsExecuteTool(parent: string, req: ExecuteToolRequest): Promise<ExecuteToolResponse>;

async projectsLocationsAppsExportApp(name: string, req: ExportAppRequest): Promise<Operation>;

async projectsLocationsAppsGet(name: string): Promise<App>;

async projectsLocationsAppsGuardrailsCreate(

parent: string,

req: Guardrail,

opts?: ProjectsLocationsAppsGuardrailsCreateOptions,

): Promise<Guardrail>;

async projectsLocationsAppsGuardrailsDelete(name: string, opts?: ProjectsLocationsAppsGuardrailsDeleteOptions): Promise<Empty>;

async projectsLocationsAppsGuardrailsGet(name: string): Promise<Guardrail>;

async projectsLocationsAppsGuardrailsList(parent: string, opts?: ProjectsLocationsAppsGuardrailsListOptions): Promise<ListGuardrailsResponse>;

async projectsLocationsAppsGuardrailsPatch(

req: Guardrail,

opts?: ProjectsLocationsAppsGuardrailsPatchOptions,

): Promise<Guardrail>;

async projectsLocationsAppsImportApp(parent: string, req: ImportAppRequest): Promise<Operation>;

async projectsLocationsAppsList(parent: string, opts?: ProjectsLocationsAppsListOptions): Promise<ListAppsResponse>;

async projectsLocationsAppsPatch(

req: App,

opts?: ProjectsLocationsAppsPatchOptions,

): Promise<App>;

async projectsLocationsAppsRetrieveToolSchema(parent: string, req: RetrieveToolSchemaRequest): Promise<RetrieveToolSchemaResponse>;

async projectsLocationsAppsSessionsGenerateChatToken(name: string, req: GenerateChatTokenRequest): Promise<GenerateChatTokenResponse>;

async projectsLocationsAppsSessionsRunSession(session: string, req: RunSessionRequest): Promise<RunSessionResponse>;

async projectsLocationsAppsToolsCreate(

parent: string,

req: Tool,

opts?: ProjectsLocationsAppsToolsCreateOptions,

): Promise<Tool>;

async projectsLocationsAppsToolsDelete(name: string, opts?: ProjectsLocationsAppsToolsDeleteOptions): Promise<Empty>;

async projectsLocationsAppsToolsetsCreate(

parent: string,

req: Toolset,

opts?: ProjectsLocationsAppsToolsetsCreateOptions,

): Promise<Toolset>;

async projectsLocationsAppsToolsetsDelete(name: string, opts?: ProjectsLocationsAppsToolsetsDeleteOptions): Promise<Empty>;

async projectsLocationsAppsToolsetsGet(name: string): Promise<Toolset>;

async projectsLocationsAppsToolsetsList(parent: string, opts?: ProjectsLocationsAppsToolsetsListOptions): Promise<ListToolsetsResponse>;

async projectsLocationsAppsToolsetsPatch(

req: Toolset,

opts?: ProjectsLocationsAppsToolsetsPatchOptions,

): Promise<Toolset>;

async projectsLocationsAppsToolsetsRetrieveTools(toolset: string, req: RetrieveToolsRequest): Promise<RetrieveToolsResponse>;

async projectsLocationsAppsToolsGet(name: string): Promise<Tool>;

async projectsLocationsAppsToolsList(parent: string, opts?: ProjectsLocationsAppsToolsListOptions): Promise<ListToolsResponse>;

async projectsLocationsAppsToolsPatch(

req: Tool,

opts?: ProjectsLocationsAppsToolsPatchOptions,

): Promise<Tool>;

async projectsLocationsAppsVersionsCreate(

parent: string,

req: AppVersion,

opts?: ProjectsLocationsAppsVersionsCreateOptions,

): Promise<AppVersion>;

async projectsLocationsAppsVersionsDelete(name: string, opts?: ProjectsLocationsAppsVersionsDeleteOptions): Promise<Empty>;

async projectsLocationsAppsVersionsGet(name: string): Promise<AppVersion>;

async projectsLocationsAppsVersionsList(parent: string, opts?: ProjectsLocationsAppsVersionsListOptions): Promise<ListAppVersionsResponse>;

async projectsLocationsAppsVersionsRestore(name: string, req: RestoreAppVersionRequest): Promise<Operation>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

}

§Constructors

new ces(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsAppsAgentsCreate(parent: string, req: Agent, opts?: ProjectsLocationsAppsAgentsCreateOptions): Promise<Agent>

[src]

Creates a new agent in the given app.

@param parent

Required. The resource name of the app to create an agent in.

projectsLocationsAppsAgentsDelete(name: string, opts?: ProjectsLocationsAppsAgentsDeleteOptions): Promise<Empty>

[src]

Deletes the specified agent.

@param name

Required. The resource name of the agent to delete.

projectsLocationsAppsAgentsGet(name: string): Promise<Agent>

[src]

Gets details of the specified agent.

@param name

Required. The resource name of the agent to retrieve.

projectsLocationsAppsAgentsList(parent: string, opts?: ProjectsLocationsAppsAgentsListOptions): Promise<ListAgentsResponse>

[src]

Lists agents in the given app.

@param parent

Required. The resource name of the app to list agents from.

projectsLocationsAppsAgentsPatch(name: string, req: Agent, opts?: ProjectsLocationsAppsAgentsPatchOptions): Promise<Agent>

[src]

Updates the specified agent.

@param name

Identifier. The unique identifier of the agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

projectsLocationsAppsChangelogsGet(name: string): Promise<Changelog>

[src]

Gets the specified changelog.

@param name

Required. The resource name of the changelog to retrieve.

projectsLocationsAppsChangelogsList(parent: string, opts?: ProjectsLocationsAppsChangelogsListOptions): Promise<ListChangelogsResponse>

[src]

Lists the changelogs of the specified app.

@param parent

Required. The resource name of the app to list changelogs from.

projectsLocationsAppsConversationsBatchDelete(parent: string, req: BatchDeleteConversationsRequest): Promise<Operation>

[src]

Batch deletes the specified conversations.

@param parent

Required. The resource name of the app to delete conversations from. Format: projects/{project}/locations/{location}/apps/{app}

projectsLocationsAppsConversationsDelete(name: string, opts?: ProjectsLocationsAppsConversationsDeleteOptions): Promise<Empty>

[src]

Deletes the specified conversation.

@param name

Required. The resource name of the conversation to delete.

projectsLocationsAppsConversationsGet(name: string, opts?: ProjectsLocationsAppsConversationsGetOptions): Promise<Conversation>

[src]

Gets details of the specified conversation.

@param name

Required. The resource name of the conversation to retrieve.

projectsLocationsAppsConversationsList(parent: string, opts?: ProjectsLocationsAppsConversationsListOptions): Promise<ListConversationsResponse>

[src]

Lists conversations in the given app.

@param parent

Required. The resource name of the app to list conversations from.

projectsLocationsAppsCreate(parent: string, req: App, opts?: ProjectsLocationsAppsCreateOptions): Promise<Operation>

[src]

Creates a new app in the given project and location.

@param parent

Required. The resource name of the location to create an app in.

projectsLocationsAppsDelete(name: string, opts?: ProjectsLocationsAppsDeleteOptions): Promise<Operation>

[src]

Deletes the specified app.

@param name

Required. The resource name of the app to delete.

projectsLocationsAppsDeploymentsCreate(parent: string, req: Deployment, opts?: ProjectsLocationsAppsDeploymentsCreateOptions): Promise<Deployment>

[src]

Creates a new deployment in the given app.

@param parent

Required. The parent app. Format: projects/{project}/locations/{location}/apps/{app}

projectsLocationsAppsDeploymentsDelete(name: string, opts?: ProjectsLocationsAppsDeploymentsDeleteOptions): Promise<Empty>

[src]

Deletes the specified deployment.

@param name

Required. The name of the deployment to delete. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

projectsLocationsAppsDeploymentsGet(name: string): Promise<Deployment>

[src]

Gets details of the specified deployment.

@param name

Required. The name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

projectsLocationsAppsDeploymentsList(parent: string, opts?: ProjectsLocationsAppsDeploymentsListOptions): Promise<ListDeploymentsResponse>

[src]

Lists deployments in the given app.

@param parent

Required. The parent app. Format: projects/{project}/locations/{location}/apps/{app}

projectsLocationsAppsDeploymentsPatch(name: string, req: Deployment, opts?: ProjectsLocationsAppsDeploymentsPatchOptions): Promise<Deployment>

[src]

Updates the specified deployment.

@param name

Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

projectsLocationsAppsExamplesCreate(parent: string, req: Example, opts?: ProjectsLocationsAppsExamplesCreateOptions): Promise<Example>

[src]

Creates a new example in the given app.

@param parent

Required. The resource name of the app to create an example in.

projectsLocationsAppsExamplesDelete(name: string, opts?: ProjectsLocationsAppsExamplesDeleteOptions): Promise<Empty>

[src]

Deletes the specified example.

@param name

Required. The resource name of the example to delete.

projectsLocationsAppsExamplesGet(name: string): Promise<Example>

[src]

Gets details of the specified example.

@param name

Required. The resource name of the example to retrieve.

projectsLocationsAppsExamplesList(parent: string, opts?: ProjectsLocationsAppsExamplesListOptions): Promise<ListExamplesResponse>

[src]

Lists examples in the given app.

@param parent

Required. The resource name of the app to list examples from.

projectsLocationsAppsExamplesPatch(name: string, req: Example, opts?: ProjectsLocationsAppsExamplesPatchOptions): Promise<Example>

[src]

Updates the specified example.

@param name

Identifier. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}

projectsLocationsAppsExecuteTool(parent: string, req: ExecuteToolRequest): Promise<ExecuteToolResponse>

[src]

Executes the given tool with the given arguments.

@param parent

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

projectsLocationsAppsExportApp(name: string, req: ExportAppRequest): Promise<Operation>

[src]

Exports the specified app.

@param name

Required. The resource name of the app to export.

projectsLocationsAppsGet(name: string): Promise<App>

[src]

Gets details of the specified app.

@param name

Required. The resource name of the app to retrieve.

projectsLocationsAppsGuardrailsCreate(parent: string, req: Guardrail, opts?: ProjectsLocationsAppsGuardrailsCreateOptions): Promise<Guardrail>

[src]

Creates a new guardrail in the given app.

@param parent

Required. The resource name of the app to create a guardrail in.

projectsLocationsAppsGuardrailsDelete(name: string, opts?: ProjectsLocationsAppsGuardrailsDeleteOptions): Promise<Empty>

[src]

Deletes the specified guardrail.

@param name

Required. The resource name of the guardrail to delete.

projectsLocationsAppsGuardrailsGet(name: string): Promise<Guardrail>

[src]

Gets details of the specified guardrail.

@param name

Required. The resource name of the guardrail to retrieve.

projectsLocationsAppsGuardrailsList(parent: string, opts?: ProjectsLocationsAppsGuardrailsListOptions): Promise<ListGuardrailsResponse>

[src]

Lists guardrails in the given app.

@param parent

Required. The resource name of the app to list guardrails from.

projectsLocationsAppsGuardrailsPatch(name: string, req: Guardrail, opts?: ProjectsLocationsAppsGuardrailsPatchOptions): Promise<Guardrail>

[src]

Updates the specified guardrail.

@param name

Identifier. The unique identifier of the guardrail. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

projectsLocationsAppsImportApp(parent: string, req: ImportAppRequest): Promise<Operation>

[src]

Imports the specified app.

@param parent

Required. The parent resource name with the location of the app to import.

projectsLocationsAppsList(parent: string, opts?: ProjectsLocationsAppsListOptions): Promise<ListAppsResponse>

[src]

Lists apps in the given project and location.

@param parent

Required. The resource name of the location to list apps from.

projectsLocationsAppsPatch(name: string, req: App, opts?: ProjectsLocationsAppsPatchOptions): Promise<App>

[src]

Updates the specified app.

@param name

Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

projectsLocationsAppsRetrieveToolSchema(parent: string, req: RetrieveToolSchemaRequest): Promise<RetrieveToolSchemaResponse>

[src]

Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.

@param parent

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

projectsLocationsAppsSessionsGenerateChatToken(name: string, req: GenerateChatTokenRequest): Promise<GenerateChatTokenResponse>

[src]

Generates a session scoped token for chat widget to authenticate with Session APIs.

@param name

Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

projectsLocationsAppsSessionsRunSession(session: string, req: RunSessionRequest): Promise<RunSessionResponse>

[src]

Initiates a single turn interaction with the CES agent within a session.

@param session

Required. The unique identifier of the session. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

projectsLocationsAppsToolsCreate(parent: string, req: Tool, opts?: ProjectsLocationsAppsToolsCreateOptions): Promise<Tool>

[src]

Creates a new tool in the given app.

@param parent

Required. The resource name of the app to create a tool in.

projectsLocationsAppsToolsDelete(name: string, opts?: ProjectsLocationsAppsToolsDeleteOptions): Promise<Empty>

[src]

Deletes the specified tool.

@param name

Required. The resource name of the tool to delete.

projectsLocationsAppsToolsetsCreate(parent: string, req: Toolset, opts?: ProjectsLocationsAppsToolsetsCreateOptions): Promise<Toolset>

[src]

Creates a new toolset in the given app.

@param parent

Required. The resource name of the app to create a toolset in.

projectsLocationsAppsToolsetsDelete(name: string, opts?: ProjectsLocationsAppsToolsetsDeleteOptions): Promise<Empty>

[src]

Deletes the specified toolset.

@param name

Required. The resource name of the toolset to delete.

projectsLocationsAppsToolsetsGet(name: string): Promise<Toolset>

[src]

Gets details of the specified toolset.

@param name

Required. The resource name of the toolset to retrieve.

projectsLocationsAppsToolsetsList(parent: string, opts?: ProjectsLocationsAppsToolsetsListOptions): Promise<ListToolsetsResponse>

[src]

Lists toolsets in the given app.

@param parent

Required. The resource name of the app to list toolsets from.

projectsLocationsAppsToolsetsPatch(name: string, req: Toolset, opts?: ProjectsLocationsAppsToolsetsPatchOptions): Promise<Toolset>

[src]

Updates the specified toolset.

@param name

Identifier. The unique identifier of the toolset. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

projectsLocationsAppsToolsetsRetrieveTools(toolset: string, req: RetrieveToolsRequest): Promise<RetrieveToolsResponse>

[src]

Retrieve the list of tools included in the specified toolset.

@param toolset

Required. The name of the toolset to retrieve the tools for. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

projectsLocationsAppsToolsGet(name: string): Promise<Tool>

[src]

Gets details of the specified tool.

@param name

Required. The resource name of the tool to retrieve.

projectsLocationsAppsToolsList(parent: string, opts?: ProjectsLocationsAppsToolsListOptions): Promise<ListToolsResponse>

[src]

Lists tools in the given app.

@param parent

Required. The resource name of the app to list tools from.

projectsLocationsAppsToolsPatch(name: string, req: Tool, opts?: ProjectsLocationsAppsToolsPatchOptions): Promise<Tool>

[src]

Updates the specified tool.

@param name

Identifier. The unique identifier of the tool. Format: - projects/{project}/locations/{location}/apps/{app}/tools/{tool} for ## standalone tools. projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.

projectsLocationsAppsVersionsCreate(parent: string, req: AppVersion, opts?: ProjectsLocationsAppsVersionsCreateOptions): Promise<AppVersion>

[src]

Creates a new app version in the given app.

@param parent

Required. The resource name of the app to create an app version in.

projectsLocationsAppsVersionsDelete(name: string, opts?: ProjectsLocationsAppsVersionsDeleteOptions): Promise<Empty>

[src]

Deletes the specified app version.

@param name

Required. The resource name of the app version to delete.

projectsLocationsAppsVersionsGet(name: string): Promise<AppVersion>

[src]

Gets details of the specified app version.

@param name

Required. The resource name of the app version to retrieve.

projectsLocationsAppsVersionsList(parent: string, opts?: ProjectsLocationsAppsVersionsListOptions): Promise<ListAppVersionsResponse>

[src]

Lists all app versions in the given app.

@param parent

Required. The resource name of the app to list app versions from.

projectsLocationsAppsVersionsRestore(name: string, req: RestoreAppVersionRequest): Promise<Operation>

[src]

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.

@param name

Required. The resource name of the app version to restore.

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service. This method can be called in two ways: * List all public locations: Use the path GET /v1/locations. * List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.