Method: projects.locations.apps.retrieveToolSchema

Recupera lo schema dello strumento specificato. Lo schema viene calcolato al volo per l'istanza specificata dello strumento.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa dell'app a cui appartiene lo strumento/il set di strumenti. Formato: projects/{project}/locations/{location}/apps/{app}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{

  // 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.
}
Campi
L'identificatore dello strumento per recuperare lo schema. Può trattarsi di uno strumento persistente o di uno strumento di un insieme di strumenti. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
tool

string

Facoltativo. Il nome dello strumento per cui recuperare lo schema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

Facoltativo. Lo strumento del toolset per recuperare lo schema. Solo uno strumento deve corrispondere al predicato del set di strumenti. In caso contrario, verrà restituito un errore.

Fine dei campi che si escludono a vicenda.

Corpo della risposta

Messaggio di risposta per ToolService.RetrieveToolSchema.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "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.
}
Campi
inputSchema

object (Schema)

Lo schema dei parametri di input dello strumento.

outputSchema

object (Schema)

Lo schema dei parametri di output dello strumento.

L'identificatore dello strumento a cui si riferisce lo schema. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
tool

string

Il nome dello strumento a cui è destinato lo schema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

Lo strumento del toolset per cui è previsto lo schema.

Fine dei campi che si escludono a vicenda.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • ces.tools.get

Per saperne di più, consulta la documentazione di IAM.