Method: projects.locations.apps.retrieveToolSchema

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

HTTP request

POST https://ces.googleapis.com/v1/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Fields
Union field tool_identifier. The identifier of the tool to retrieve the schema for. It could be either a persisted tool or a tool from a toolset. tool_identifier can be only one of the following:
tool

string

Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

Response body

Response message for ToolService.RetrieveToolSchema.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Fields
inputSchema

object (Schema)

Required. The schema of the tool input parameters.
outputSchema

object (Schema)

Required. The schema of the tool output parameters.
Union field tool_identifier. The identifier of the tool that the schema is for. tool_identifier can be only one of the following:
tool

string

The name of the tool that the schema is for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

The toolset tool that the schema is for.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • ces.tools.get

For more information, see the IAM documentation.