2026-02-05
▼ ▲ ces.projects.locations.apps.list
HTTP Method : GET
Scopes :
Description : Lists apps in the given project and location.
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps
Parameters :
filter
Description : Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details.
Location : query
Type : string
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. The resource name of the location to list apps from.
Required : Yes
pageToken
Type : string
Description : Optional. The next_page_token value returned from a previous list AgentService.ListApps call.
Location : query
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
Format : int32
Location : query
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Type : string
Location : query
Path : v1beta/{+parent}/apps
▼ ▲ ces.projects.locations.apps.retrieveToolSchema
Parameter Order : parent
HTTP Method : POST
Parameters :
parent
Required : Yes
Description : Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Type : string
Location : path
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:retrieveToolSchema
Description : Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.
Scopes :
Path : v1beta/{+parent}:retrieveToolSchema
▼ ▲ ces.projects.locations.apps.exportApp
HTTP Method : POST
Parameter Order : name
Description : Exports the specified app.
Path : v1beta/{+name}:exportApp
Scopes :
Parameters :
name
Type : string
Required : Yes
Description : Required. The resource name of the app to export.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:exportApp
▼ ▲ ces.projects.locations.apps.testPersonaVoice
Description : Tests the voice of a persona. Also accepts a default persona.
Parameters :
app
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. the resource name of the app to test the persona voice for. Format: `projects/{project}/locations/{location}/apps/{app}`
Location : path
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:testPersonaVoice
HTTP Method : POST
Path : v1beta/{+app}:testPersonaVoice
Parameter Order : app
Scopes :
▼ ▲ ces.projects.locations.apps.get
Parameters :
name
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The resource name of the app to retrieve.
Parameter Order : name
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}
Description : Gets details of the specified app.
Scopes :
HTTP Method : GET
▼ ▲ ces.projects.locations.apps.runEvaluation
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:runEvaluation
Scopes :
Description : Runs an evaluation of the app.
HTTP Method : POST
Parameters :
app
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`
Required : Yes
Type : string
Parameter Order : app
Path : v1beta/{+app}:runEvaluation
▼ ▲ ces.projects.locations.apps.create
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps
HTTP Method : POST
Scopes :
Parameter Order : parent
Parameters :
appId
Type : string
Description : Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app.
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The resource name of the location to create an app in.
Description : Creates a new app in the given project and location.
Path : v1beta/{+parent}/apps
▼ ▲ ces.projects.locations.apps.delete
Parameters :
name
Description : Required. The resource name of the app to delete.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Location : path
etag
Description : Optional. The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned.
Type : string
Location : query
Description : Deletes the specified app.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}
HTTP Method : DELETE
Parameter Order : name
Scopes :
Path : v1beta/{+name}
▼ ▲ ces.projects.locations.apps.importEvaluations
Scopes :
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Type : string
Description : Required. The app to import the evaluations into. Format: `projects/{project}/locations/{location}/apps/{app}`
Location : path
Required : Yes
Parameter Order : parent
Description : Imports evaluations into the app.
Path : v1beta/{+parent}:importEvaluations
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:importEvaluations
HTTP Method : POST
▼ ▲ ces.projects.locations.apps.importApp
Parameters :
parent
Description : Required. The parent resource name with the location of the app to import.
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Path : v1beta/{+parent}/apps:importApp
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps:importApp
Scopes :
Parameter Order : parent
Description : Imports the specified app.
HTTP Method : POST
▼ ▲ ces.projects.locations.apps.executeTool
Scopes :
Description : Executes the given tool with the given arguments.
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:executeTool
Path : v1beta/{+parent}:executeTool
Parameters :
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Description : Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`
Parameter Order : parent
▼ ▲ ces.projects.locations.apps.patch
Description : Updates the specified app.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Location : path
updateMask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Format : google-fieldmask
Type : string
Parameter Order : name
Path : v1beta/{+name}
Scopes :
▼ ▲ ces.projects.locations.apps.evaluationRuns.list
Parameter Order : parent
Path : v1beta/{+parent}/evaluationRuns
Scopes :
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Description : Required. The resource name of the app to list evaluation runs from.
Required : Yes
Type : string
orderBy
Location : query
Description : Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.
Type : string
filter
Type : string
Location : query
Description : Optional. Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details.
pageToken
Location : query
Description : Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call.
Type : string
pageSize
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Description : Lists all evaluation runs in the given app.
▼ ▲ ces.projects.locations.apps.evaluationRuns.get
Path : v1beta/{+name}
Description : Gets details of the specified evaluation run.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}
Parameter Order : name
Scopes :
HTTP Method : GET
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$
Description : Required. The resource name of the evaluation run to retrieve.
Location : path
Required : Yes
Type : string
▼ ▲ ces.projects.locations.apps.evaluationRuns.delete
Description : Deletes an evaluation run.
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}
Parameters :
name
Description : Required. The resource name of the evaluation run to delete.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$
Path : v1beta/{+name}
Scopes :
▼ ▲ ces.projects.locations.apps.conversations.delete
HTTP Method : DELETE
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}
Path : v1beta/{+name}
Parameter Order : name
Parameters :
source
Description : Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.
Location : query
Deprecated : Yes
Enum :
Enum Descriptions :
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$
Location : path
Description : Required. The resource name of the conversation to delete.
Required : Yes
Type : string
Scopes :
Description : Deletes the specified conversation.
▼ ▲ ces.projects.locations.apps.conversations.generateEvaluation
Description : Creates a golden evaluation from a conversation.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}:generateEvaluation
Parameter Order : conversation
Parameters :
conversation
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$
Type : string
Description : Required. The conversation to create the golden evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`
Location : path
HTTP Method : POST
Path : v1beta/{+conversation}:generateEvaluation
Scopes :
▼ ▲ ces.projects.locations.apps.conversations.get
Description : Gets details of the specified conversation.
HTTP Method : GET
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}
Path : v1beta/{+name}
Parameter Order : name
Parameters :
source
Enum :
Type : string
Deprecated : Yes
Location : query
Enum Descriptions :
Description : Optional. Indicate the source of the conversation. If not set, all source will be searched.
name
Required : Yes
Description : Required. The resource name of the conversation to retrieve.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$
Location : path
Type : string
▼ ▲ ces.projects.locations.apps.conversations.list
Scopes :
Path : v1beta/{+parent}/conversations
HTTP Method : GET
Parameters :
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.
source
Type : string
Enum Descriptions :
Enum :
Description : Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.
Location : query
parent
Location : path
Type : string
Required : Yes
Description : Required. The resource name of the app to list conversations from.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
filter
Location : query
Type : string
Description : Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Description : Lists conversations in the given app.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations
Parameter Order : parent
▼ ▲ ces.projects.locations.apps.conversations.batchDelete
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations:batchDelete
Parameter Order : parent
Path : v1beta/{+parent}/conversations:batchDelete
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Type : string
Description : Batch deletes the specified conversations.
▼ ▲ ces.projects.locations.apps.guardrails.get
Parameter Order : name
Path : v1beta/{+name}
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}
Description : Gets details of the specified guardrail.
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the guardrail to retrieve.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$
▼ ▲ ces.projects.locations.apps.guardrails.patch
Scopes :
HTTP Method : PATCH
Parameter Order : name
Description : Updates the specified guardrail.
Parameters :
updateMask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Location : query
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$
Required : Yes
Location : path
Type : string
Description : Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}
▼ ▲ ces.projects.locations.apps.guardrails.delete
Description : Deletes the specified guardrail.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}
Parameter Order : name
Scopes :
HTTP Method : DELETE
Parameters :
force
Description : Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any apps/agents still reference the guardrail. * If `force = true`, all existing references from apps/agents will be removed and the guardrail will be deleted.
Location : query
Type : boolean
name
Description : Required. The resource name of the guardrail to delete.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$
Location : path
Type : string
etag
Location : query
Type : string
Description : Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.
Path : v1beta/{+name}
▼ ▲ ces.projects.locations.apps.guardrails.create
Parameters :
parent
Description : Required. The resource name of the app to create a guardrail in.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Type : string
guardrailId
Location : query
Type : string
Description : Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail.
Parameter Order : parent
HTTP Method : POST
Path : v1beta/{+parent}/guardrails
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails
Description : Creates a new guardrail in the given app.
▼ ▲ ces.projects.locations.apps.guardrails.list
Parameter Order : parent
Path : v1beta/{+parent}/guardrails
HTTP Method : GET
Parameters :
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken
Description : Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call.
Type : string
Location : query
filter
Type : string
Location : query
Description : Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details.
parent
Description : Required. The resource name of the app to list guardrails from.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Required : Yes
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Type : string
Location : query
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails
Description : Lists guardrails in the given app.
Scopes :
▼ ▲ ces.projects.locations.apps.sessions.runSession
Parameter Order : session
Scopes :
Description : Initiates a single turn interaction with the CES agent within a session.
Path : v1beta/{+session}:runSession
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession
Parameters :
session
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$
Required : Yes
Description : Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`
Type : string
HTTP Method : POST
▼ ▲ ces.projects.locations.apps.sessions.generateChatToken
Description : Generates a session scoped token for chat widget to authenticate with Session APIs.
Path : v1beta/{+name}:generateChatToken
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:generateChatToken
Parameter Order : name
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$
Description : Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
Scopes :
HTTP Method : POST
▼ ▲ ces.projects.locations.apps.tools.create
Description : Creates a new tool in the given app.
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The resource name of the app to create a tool in.
Type : string
Location : path
toolId
Type : string
Description : Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
Location : query
HTTP Method : POST
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools
Parameter Order : parent
Path : v1beta/{+parent}/tools
▼ ▲ ces.projects.locations.apps.tools.list
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools
Scopes :
Path : v1beta/{+parent}/tools
Parameter Order : parent
Parameters :
filter
Location : query
Description : Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details.
Type : string
parent
Location : path
Description : Required. The resource name of the app to list tools from.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Type : string
pageToken
Description : Optional. The next_page_token value returned from a previous list AgentService.ListTools call.
Location : query
Type : string
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Location : query
Type : string
HTTP Method : GET
Description : Lists tools in the given app.
▼ ▲ ces.projects.locations.apps.tools.get
HTTP Method : GET
Parameters :
name
Type : string
Required : Yes
Description : Required. The resource name of the tool to retrieve.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}
Parameter Order : name
Path : v1beta/{+name}
Description : Gets details of the specified tool.
▼ ▲ ces.projects.locations.apps.tools.patch
HTTP Method : PATCH
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}
Description : Updates the specified tool.
Parameters :
updateMask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Format : google-fieldmask
Type : string
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$
Type : string
Description : 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.
Scopes :
Parameter Order : name
▼ ▲ ces.projects.locations.apps.tools.delete
Description : Deletes the specified tool.
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$
Required : Yes
Description : Required. The resource name of the tool to delete.
Location : path
etag
Description : Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned.
Type : string
Location : query
force
Location : query
Description : Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * If `force = false`, the deletion will fail if any agents still reference the tool. * If `force = true`, all existing references from agents will be removed and the tool will be deleted.
Type : boolean
Path : v1beta/{+name}
HTTP Method : DELETE
Parameter Order : name
▼ ▲ ces.projects.locations.apps.toolsets.list
HTTP Method : GET
Parameters :
orderBy
Type : string
Location : query
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
filter
Location : query
Description : Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details.
Type : string
pageToken
Description : Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call.
Location : query
Type : string
pageSize
Format : int32
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
parent
Description : Required. The resource name of the app to list toolsets from.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Type : string
Location : path
Path : v1beta/{+parent}/toolsets
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets
Description : Lists toolsets in the given app.
Parameter Order : parent
▼ ▲ ces.projects.locations.apps.toolsets.retrieveTools
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}:retrieveTools
HTTP Method : POST
Path : v1beta/{+toolset}:retrieveTools
Description : Retrieve the list of tools included in the specified toolset.
Parameters :
toolset
Type : string
Description : Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$
Location : path
Required : Yes
Parameter Order : toolset
Scopes :
▼ ▲ ces.projects.locations.apps.toolsets.get
HTTP Method : GET
Scopes :
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$
Description : Required. The resource name of the toolset to retrieve.
Location : path
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}
Path : v1beta/{+name}
Parameter Order : name
Description : Gets details of the specified toolset.
▼ ▲ ces.projects.locations.apps.toolsets.patch
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$
Description : Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
updateMask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Type : string
Location : query
Path : v1beta/{+name}
Description : Updates the specified toolset.
Scopes :
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}
HTTP Method : PATCH
▼ ▲ ces.projects.locations.apps.toolsets.create
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets
Parameter Order : parent
HTTP Method : POST
Description : Creates a new toolset in the given app.
Scopes :
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The resource name of the app to create a toolset in.
Type : string
Required : Yes
toolsetId
Location : query
Description : Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset.
Type : string
Path : v1beta/{+parent}/toolsets
▼ ▲ ces.projects.locations.apps.toolsets.delete
Parameter Order : name
Scopes :
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}
Parameters :
etag
Description : Optional. The current etag of the toolset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the toolset, deletion will be blocked and an ABORTED error will be returned.
Type : string
Location : query
force
Description : Optional. Indicates whether to forcefully delete the toolset, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any agents still reference the toolset. * If `force = true`, all existing references from agents will be removed and the toolset will be deleted.
Location : query
Type : boolean
name
Description : Required. The resource name of the toolset to delete.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$
Description : Deletes the specified toolset.
HTTP Method : DELETE
▼ ▲ ces.projects.locations.apps.deployments.list
HTTP Method : GET
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`
Location : path
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Type : string
Location : query
pageSize
Location : query
Description : Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format : int32
Type : integer
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token.
Description : Lists deployments in the given app.
Parameter Order : parent
Path : v1beta/{+parent}/deployments
▼ ▲ ces.projects.locations.apps.deployments.delete
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$
Location : path
Type : string
Required : Yes
etag
Description : Optional. The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned.
Type : string
Location : query
Description : Deletes the specified deployment.
Path : v1beta/{+name}
Parameter Order : name
▼ ▲ ces.projects.locations.apps.deployments.get
HTTP Method : GET
Parameter Order : name
Scopes :
Parameters :
name
Description : Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}
Description : Gets details of the specified deployment.
Path : v1beta/{+name}
▼ ▲ ces.projects.locations.apps.deployments.patch
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}
Description : Updates the specified deployment.
Parameter Order : name
Parameters :
updateMask
Description : Optional. The list of fields to update.
Type : string
Format : google-fieldmask
Location : query
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$
Location : path
Description : Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
Required : Yes
Scopes :
HTTP Method : PATCH
▼ ▲ ces.projects.locations.apps.deployments.create
Parameters :
deploymentId
Description : Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment.
Location : query
Type : string
parent
Type : string
Required : Yes
Location : path
Description : Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Path : v1beta/{+parent}/deployments
Description : Creates a new deployment in the given app.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments
HTTP Method : POST
Parameter Order : parent
Scopes :
▼ ▲ ces.projects.locations.apps.versions.restore
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$
Type : string
Location : path
Description : Required. The resource name of the app version to restore.
Required : Yes
HTTP Method : POST
Parameter Order : name
Description : 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.
Path : v1beta/{+name}:restore
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore
▼ ▲ ces.projects.locations.apps.versions.get
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}
Description : Gets details of the specified app version.
Parameter Order : name
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$
Required : Yes
Description : Required. The resource name of the app version to retrieve.
Path : v1beta/{+name}
HTTP Method : GET
Scopes :
▼ ▲ ces.projects.locations.apps.versions.delete
Scopes :
HTTP Method : DELETE
Path : v1beta/{+name}
Parameters :
etag
Location : query
Description : Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned.
Type : string
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$
Description : Required. The resource name of the app version to delete.
Required : Yes
Description : Deletes the specified app version.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}
Parameter Order : name
▼ ▲ ces.projects.locations.apps.versions.list
Parameter Order : parent
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Description : Required. The resource name of the app to list app versions from.
Type : string
Required : Yes
filter
Location : query
Type : string
Description : Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details.
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call.
orderBy
Location : query
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Type : string
pageSize
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Type : integer
HTTP Method : GET
Description : Lists all app versions in the given app.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions
Path : v1beta/{+parent}/versions
Scopes :
▼ ▲ ces.projects.locations.apps.versions.create
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions
Scopes :
Path : v1beta/{+parent}/versions
Description : Creates a new app version in the given app.
Parameter Order : parent
Parameters :
parent
Type : string
Description : Required. The resource name of the app to create an app version in.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Required : Yes
appVersionId
Location : query
Description : Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
Type : string
▼ ▲ ces.projects.locations.apps.changelogs.list
Scopes :
Parameters :
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Type : string
Location : query
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call.
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Required : Yes
Description : Required. The resource name of the app to list changelogs from.
filter
Type : string
Description : Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action="Create"` (case-sensitive exact match) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time > "2025-01-01T00:00:00Z"` * `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool`
Location : query
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
Path : v1beta/{+parent}/changelogs
Description : Lists the changelogs of the specified app.
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs
HTTP Method : GET
▼ ▲ ces.projects.locations.apps.changelogs.get
Parameters :
name
Description : Required. The resource name of the changelog to retrieve.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/changelogs/[^/]+$
Description : Gets the specified changelog.
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs/{changelogsId}
Scopes :
Path : v1beta/{+name}
HTTP Method : GET
▼ ▲ ces.projects.locations.apps.evaluations.list
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations
Description : Lists all evaluations in the given app.
Scopes :
Path : v1beta/{+parent}/evaluations
Parameters :
pageToken
Type : string
Description : Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.
Location : query
lastTenResults
Type : boolean
Description : Optional. Whether to include the last 10 evaluation results for each evaluation in the response.
Location : query
orderBy
Type : string
Description : Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.
Location : query
pageSize
Type : integer
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
filter
Description : Optional. Filter to be applied when listing the evaluations. See https://google.aip.dev/160 for more details. Currently supports filtering by the following fields: * evaluation_datasets, using the evaluation dataset ID in the format evaluation_datasets:evaluation_dataset_id. * tags, using the tag in the format tags:tag.
Type : string
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Description : Required. The resource name of the app to list evaluations from.
Required : Yes
Type : string
HTTP Method : GET
Parameter Order : parent
▼ ▲ ces.projects.locations.apps.evaluations.patch
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}
HTTP Method : PATCH
Description : Updates an evaluation.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$
Type : string
Location : path
Required : Yes
Description : Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
updateMask
Location : query
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Type : string
Format : google-fieldmask
Scopes :
Parameter Order : name
▼ ▲ ces.projects.locations.apps.evaluations.create
Description : Creates an evaluation.
Path : v1beta/{+parent}/evaluations
Parameter Order : parent
Scopes :
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations
Parameters :
evaluationId
Location : query
Type : string
Description : Optional. The ID to use for the evaluation, which will become the final component of the evaluation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.
parent
Description : Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Type : string
Location : path
▼ ▲ ces.projects.locations.apps.evaluations.get
Path : v1beta/{+name}
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$
Required : Yes
Description : Required. The resource name of the evaluation to retrieve.
Location : path
Type : string
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}
Scopes :
HTTP Method : GET
Description : Gets details of the specified evaluation.
▼ ▲ ces.projects.locations.apps.evaluations.delete
Description : Deletes an evaluation.
Path : v1beta/{+name}
Parameters :
etag
Type : string
Description : Optional. The current etag of the evaluation. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation, deletion will be blocked and an ABORTED error will be returned.
Location : query
force
Description : Optional. Indicates whether to forcefully delete the evaluation, even if it is still referenced by evaluation datasets. * If `force = false`, the deletion will fail if any datasets still reference the evaluation. * If `force = true`, all existing references from datasets will be removed and the evaluation will be deleted.
Type : boolean
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The resource name of the evaluation to delete.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}
Parameter Order : name
Scopes :
HTTP Method : DELETE
▼ ▲ ces.projects.locations.apps.evaluations.results.get
Description : Gets details of the specified evaluation result.
Scopes :
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$
Required : Yes
Type : string
Description : Required. The resource name of the evaluation result to retrieve.
Location : path
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}
Path : v1beta/{+name}
HTTP Method : GET
Parameter Order : name
▼ ▲ ces.projects.locations.apps.evaluations.results.delete
Path : v1beta/{+name}
Description : Deletes an evaluation result.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}
Parameter Order : name
HTTP Method : DELETE
Parameters :
name
Required : Yes
Location : path
Description : Required. The resource name of the evaluation result to delete.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$
Scopes :
▼ ▲ ces.projects.locations.apps.evaluations.results.list
Description : Lists all evaluation results for a given evaluation.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results
HTTP Method : GET
Parameter Order : parent
Path : v1beta/{+parent}/results
Scopes :
Parameters :
pageToken
Description : Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call.
Type : string
Location : query
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$
Description : Required. The resource name of the evaluation to list evaluation results from. To filter by evaluation run, use `-` as the evaluation ID and specify the evaluation run ID in the filter. For example: `projects/{project}/locations/{location}/apps/{app}/evaluations/-`
Required : Yes
Location : path
pageSize
Location : query
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
orderBy
Location : query
Type : string
Description : Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.
filter
Description : Optional. Filter to be applied when listing the evaluation results. See https://google.aip.dev/160 for more details.
Type : string
Location : query
▼ ▲ ces.projects.locations.apps.agents.delete
Parameters :
force
Type : boolean
Location : query
Description : Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples. * If `force = false`, the deletion fails if other agents/examples reference it. * If `force = true`, delete the agent and remove it from all referencing apps/agents/examples.
etag
Description : Optional. The current etag of the agent. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the agent, deletion will be blocked and an ABORTED error will be returned.
Type : string
Location : query
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$
Description : Required. The resource name of the agent to delete.
Location : path
Type : string
HTTP Method : DELETE
Scopes :
Description : Deletes the specified agent.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}
Parameter Order : name
Path : v1beta/{+name}
▼ ▲ ces.projects.locations.apps.agents.get
Parameter Order : name
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}
Scopes :
HTTP Method : GET
Description : Gets details of the specified agent.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$
Type : string
Location : path
Description : Required. The resource name of the agent to retrieve.
Required : Yes
▼ ▲ ces.projects.locations.apps.agents.list
HTTP Method : GET
Description : Lists agents in the given app.
Path : v1beta/{+parent}/agents
Parameter Order : parent
Scopes :
Parameters :
parent
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The resource name of the app to list agents from.
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
filter
Description : Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details.
Type : string
Location : query
orderBy
Location : query
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Type : string
pageToken
Description : Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.
Type : string
Location : query
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents
▼ ▲ ces.projects.locations.apps.agents.patch
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}
HTTP Method : PATCH
Description : Updates the specified agent.
Path : v1beta/{+name}
Parameter Order : name
Parameters :
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
name
Description : Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$
Required : Yes
Type : string
Scopes :
▼ ▲ ces.projects.locations.apps.agents.create
Description : Creates a new agent in the given app.
Path : v1beta/{+parent}/agents
Parameter Order : parent
Parameters :
agentId
Description : Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent.
Location : query
Type : string
parent
Location : path
Type : string
Description : Required. The resource name of the app to create an agent in.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents
HTTP Method : POST
▼ ▲ ces.projects.locations.apps.evaluationDatasets.delete
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$
Location : path
Description : Required. The resource name of the evaluation dataset to delete.
Type : string
Required : Yes
etag
Location : query
Type : string
Description : Optional. The current etag of the evaluation dataset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation dataset, deletion will be blocked and an ABORTED error will be returned.
Parameter Order : name
Path : v1beta/{+name}
Description : Deletes an evaluation dataset.
Scopes :
HTTP Method : DELETE
▼ ▲ ces.projects.locations.apps.evaluationDatasets.get
Scopes :
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$
Description : Required. The resource name of the evaluation dataset to retrieve.
Required : Yes
Type : string
Location : path
Path : v1beta/{+name}
HTTP Method : GET
Description : Gets details of the specified evaluation dataset.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}
Parameter Order : name
▼ ▲ ces.projects.locations.apps.evaluationDatasets.list
Path : v1beta/{+parent}/evaluationDatasets
Parameters :
filter
Location : query
Type : string
Description : Optional. Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details.
orderBy
Type : string
Location : query
Description : Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets call.
parent
Description : Required. The resource name of the app to list evaluation datasets from.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
pageSize
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Scopes :
Description : Lists all evaluation datasets in the given app.
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets
HTTP Method : GET
▼ ▲ ces.projects.locations.apps.evaluationDatasets.create
Parameters :
evaluationDatasetId
Description : Optional. The ID to use for the evaluation dataset, which will become the final component of the evaluation dataset's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.
Location : query
Type : string
parent
Type : string
Description : Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Location : path
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets
Path : v1beta/{+parent}/evaluationDatasets
Scopes :
Parameter Order : parent
HTTP Method : POST
Description : Creates an evaluation dataset.
▼ ▲ ces.projects.locations.apps.evaluationDatasets.patch
Description : Updates an evaluation dataset.
Parameters :
name
Required : Yes
Description : Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$
updateMask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Location : query
Type : string
HTTP Method : PATCH
Scopes :
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}
Parameter Order : name
▼ ▲ ces.projects.locations.apps.scheduledEvaluationRuns.delete
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$
Description : Required. The resource name of the scheduled evaluation run to delete.
Type : string
Required : Yes
etag
Location : query
Description : Optional. The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag.
Type : string
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}
Parameter Order : name
Path : v1beta/{+name}
HTTP Method : DELETE
Scopes :
Description : Deletes a scheduled evaluation run.
▼ ▲ ces.projects.locations.apps.scheduledEvaluationRuns.create
HTTP Method : POST
Description : Creates a scheduled evaluation run.
Parameters :
scheduledEvaluationRunId
Location : query
Description : Optional. The ID to use for the scheduled evaluation run, which will become the final component of the scheduled evaluation run's resource name. If not provided, a unique ID will be automatically assigned.
Type : string
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Description : Required. The app to create the scheduled evaluation run for. Format: `projects/{project}/locations/{location}/apps/{app}`
Required : Yes
Parameter Order : parent
Path : v1beta/{+parent}/scheduledEvaluationRuns
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns
▼ ▲ ces.projects.locations.apps.scheduledEvaluationRuns.list
Path : v1beta/{+parent}/scheduledEvaluationRuns
Description : Lists all scheduled evaluation runs in the given app.
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns
Parameter Order : parent
Parameters :
pageSize
Type : integer
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
orderBy
Description : Optional. Field to sort by. Supported fields are: "name" (ascending), "create_time" (descending), "update_time" (descending), "next_scheduled_execution" (ascending), and "last_completed_run.create_time" (descending). If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.
Type : string
Location : query
filter
Type : string
Description : Optional. Filter to be applied when listing the scheduled evaluation runs. See https://google.aip.dev/160 for more details. Currently supports filtering by: * request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id
Location : query
pageToken
Description : Optional. The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.
Type : string
Location : query
parent
Required : Yes
Description : Required. The resource name of the app to list scheduled evaluation runs from.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Scopes :
▼ ▲ ces.projects.locations.apps.scheduledEvaluationRuns.get
Parameter Order : name
Path : v1beta/{+name}
Description : Gets details of the specified scheduled evaluation run.
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$
Description : Required. The resource name of the scheduled evaluation run to retrieve.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}
Scopes :
HTTP Method : GET
▼ ▲ ces.projects.locations.apps.scheduledEvaluationRuns.patch
Parameter Order : name
Path : v1beta/{+name}
Scopes :
Parameters :
updateMask
Format : google-fieldmask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Type : string
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$
Location : path
Type : string
Description : Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}
HTTP Method : PATCH
Description : Updates a scheduled evaluation run.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}
▼ ▲ ces.projects.locations.apps.evaluationExpectations.get
Scopes :
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$
Required : Yes
Description : Required. The resource name of the evaluation expectation to retrieve.
Parameter Order : name
HTTP Method : GET
Description : Gets details of the specified evaluation expectation.
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}
▼ ▲ ces.projects.locations.apps.evaluationExpectations.patch
Scopes :
HTTP Method : PATCH
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}
Path : v1beta/{+name}
Parameters :
name
Required : Yes
Description : Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$
Location : path
Type : string
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Description : Updates an evaluation expectation.
Parameter Order : name
▼ ▲ ces.projects.locations.apps.evaluationExpectations.delete
Scopes :
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the evaluation expectation to delete.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$
Location : path
etag
Location : query
Description : Optional. The current etag of the evaluation expectation. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation expectation, deletion will be blocked and an ABORTED error will be returned.
Type : string
Path : v1beta/{+name}
Description : Deletes an evaluation expectation.
▼ ▲ ces.projects.locations.apps.evaluationExpectations.create
Description : Creates an evaluation expectation.
HTTP Method : POST
Parameter Order : parent
Parameters :
evaluationExpectationId
Description : Optional. The ID to use for the evaluation expectation, which will become the final component of the evaluation expectation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation expectation.
Type : string
Location : query
parent
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The app to create the evaluation expectation for. Format: `projects/{project}/locations/{location}/apps/{app}`
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations
Path : v1beta/{+parent}/evaluationExpectations
▼ ▲ ces.projects.locations.apps.evaluationExpectations.list
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations
Parameters :
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Type : integer
Location : query
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Description : Required. The resource name of the app to list evaluation expectations from.
orderBy
Type : string
Location : query
Description : Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.
filter
Description : Optional. Filter to be applied when listing the evaluation expectations. See https://google.aip.dev/160 for more details.
Location : query
Type : string
pageToken
Location : query
Description : Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.
Type : string
Parameter Order : parent
Path : v1beta/{+parent}/evaluationExpectations
Description : Lists all evaluation expectations in the given app.
Scopes :
HTTP Method : GET
▼ ▲ ces.projects.locations.apps.examples.patch
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}
Parameters :
updateMask
Location : query
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Type : string
Format : google-fieldmask
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$
Type : string
Description : Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
Parameter Order : name
HTTP Method : PATCH
Scopes :
Path : v1beta/{+name}
Description : Updates the specified example.
▼ ▲ ces.projects.locations.apps.examples.get
Path : v1beta/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$
Location : path
Description : Required. The resource name of the example to retrieve.
Type : string
Required : Yes
Scopes :
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}
Description : Gets details of the specified example.
▼ ▲ ces.projects.locations.apps.examples.create
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples
Path : v1beta/{+parent}/examples
Description : Creates a new example in the given app.
Scopes :
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Description : Required. The resource name of the app to create an example in.
Type : string
exampleId
Type : string
Location : query
Description : Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example.
Parameter Order : parent
HTTP Method : POST
▼ ▲ ces.projects.locations.apps.examples.list
HTTP Method : GET
Parameter Order : parent
Description : Lists examples in the given app.
Path : v1beta/{+parent}/examples
Parameters :
pageSize
Location : query
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
pageToken
Type : string
Location : query
Description : Optional. The next_page_token value returned from a previous list AgentService.ListExamples call.
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Location : query
Type : string
filter
Type : string
Description : Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.
Location : query
parent
Description : Required. The resource name of the app to list examples from.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples
Scopes :
▼ ▲ ces.projects.locations.apps.examples.delete
Parameter Order : name
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}
Description : Deletes the specified example.
Scopes :
HTTP Method : DELETE
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$
Description : Required. The resource name of the example to delete.
Required : Yes
Location : path
Type : string
etag
Location : query
Type : string
Description : Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.
▼ ▲ ces.projects.locations.operations.list
Parameter Order : name
HTTP Method : GET
Parameters :
pageSize
Format : int32
Location : query
Type : integer
Description : The standard list page size.
name
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : The name of the operation's parent resource.
filter
Type : string
Location : query
Description : The standard list filter.
returnPartialSuccess
Type : boolean
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
pageToken
Type : string
Location : query
Description : The standard list page token.
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes :
Path : v1beta/{+name}/operations
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations
▼ ▲ ces.projects.locations.operations.delete
Parameter Order : name
Scopes :
Path : v1beta/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Type : string
Required : Yes
Location : path
Description : 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`.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
▼ ▲ ces.projects.locations.operations.get
Parameters :
name
Type : string
Description : The name of the operation resource.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required : Yes
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameter Order : name
HTTP Method : GET
Description : 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.
Path : v1beta/{+name}
Scopes :
▼ ▲ ces.projects.locations.operations.cancel
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Type : string
Description : The name of the operation resource to be cancelled.
Path : v1beta/{+name}:cancel
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Description : 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`.
Scopes :
▼ ▲ ces.projects.locations.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}
Parameter Order : name
Description : Gets information about a location.
Scopes :
Parameters :
name
Description : Resource name for the location.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
HTTP Method : GET
▼ ▲ ces.projects.locations.list
Path : v1beta/{+name}/locations
Scopes :
Parameters :
pageToken
Type : string
Location : query
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
extraLocationTypes
Description : Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
Location : query
Repeated : Yes
Type : string
name
Pattern : ^projects/[^/]+$
Description : The resource that owns the locations collection, if applicable.
Location : path
Required : Yes
Type : string
filter
Type : string
Location : query
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize
Type : integer
Description : The maximum number of results to return. If not set, the service selects a default.
Format : int32
Location : query
Parameter Order : name
Description : 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.
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations