Method: projects.locations.apps.retrieveToolSchema

Ruft das Schema des angegebenen Tools ab. Das Schema wird für die jeweilige Instanz des Tools dynamisch berechnet.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname der App, zu der das Tool bzw. das Toolset gehört. Format: projects/{project}/locations/{location}/apps/{app}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
Felder
Die Kennung des Tools, für das das Schema abgerufen werden soll. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
tool

string

Optional. Der Name des Tools, für das das Schema abgerufen werden soll. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Optional. Das Toolset-Tool, für das das Schema abgerufen werden soll. Nur ein Tool aus dem Toolset sollte dem Prädikat entsprechen. Andernfalls wird ein Fehler zurückgegeben.
Ende der sich gegenseitig ausschließenden Felder.

Antworttext

Antwortnachricht für ToolService.RetrieveToolSchema.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
Felder
inputSchema

object (Schema)

Das Schema der Eingabeparameter des Tools.
outputSchema

object (Schema)

Das Schema der Ausgabeparameter des Tools.
Die Kennung des Tools, für das das Schema gilt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
tool

string

Der Name des Tools, für das das Schema gilt. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Das Toolset-Tool, für das das Schema gilt.
Ende der sich gegenseitig ausschließenden Felder.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • ces.tools.get

Weitere Informationen finden Sie in der IAM-Dokumentation.