Method: projects.locations.apps.retrieveToolSchema

Récupère le schéma de l'outil donné. Le schéma est calculé à la volée pour l'instance de l'outil donnée.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'application à laquelle appartient l'outil ou l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
Identifiant de l'outil pour lequel récupérer le schéma. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
tool

string

Facultatif. Nom de l'outil pour lequel récupérer le schéma. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Facultatif. Outil du toolset pour lequel récupérer le schéma. Un seul outil doit correspondre au prédicat de l'ensemble d'outils. Sinon, une erreur sera renvoyée.
Fin des champs qui s'excluent mutuellement.

Corps de la réponse

Message de réponse pour ToolService.RetrieveToolSchema.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation 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.
}
Champs
inputSchema

object (Schema)

Schéma des paramètres d'entrée de l'outil.
outputSchema

object (Schema)

Schéma des paramètres de sortie de l'outil.
Identifiant de l'outil auquel le schéma est destiné. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
tool

string

Nom de l'outil auquel le schéma est destiné. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Ensemble d'outils auquel le schéma est destiné.
Fin des champs qui s'excluent mutuellement.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • ces.tools.get

Pour en savoir plus, consultez la documentation IAM.