Batch API

L'API Gemini est compatible avec les API par lot, qui vous permettent de traiter plusieurs requêtes en un seul appel. Pour en savoir plus, consultez le guide de l'API Batch.

Méthode : models.batchGenerateContent

Place en file d'attente un lot de models.generateContent requêtes pour le traitement par lot.

Point de terminaison

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:batchGenerateContent

Paramètres de chemin d'accès

batch.model string

Obligatoire. Nom du Model à utiliser pour générer la complétion.

Format : models/{model}. Il se présente sous la forme models/{model}.

Corps de la requête

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

Champs
batch.name string

Uniquement en sortie. Identifiant. Nom de ressource du lot.

Format : batches/{batchId}.

batch.displayName string

Obligatoire. Nom défini par l'utilisateur pour ce lot.

batch.inputConfig object (InputConfig)

Obligatoire. Configuration d'entrée des instances sur lesquelles le traitement par lot est effectué.

batch.output object (GenerateContentBatchOutput)

Uniquement en sortie. Sortie de la requête par lot.

batch.createTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le lot a été créé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le traitement par lot s'est terminé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le lot a été mis à jour pour la dernière fois.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

batch.batchStats object (BatchStats)

Uniquement en sortie. Statistiques sur le lot.

batch.state enum (BatchState)

Uniquement en sortie. État du lot.

batch.priority string (int64 format)

Facultatif. Priorité du lot. Les lots ayant une valeur de priorité plus élevée seront traités avant ceux ayant une valeur de priorité plus faible. Les valeurs négatives sont autorisées. La valeur par défaut est "0".

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Méthode : models.asyncBatchEmbedContent

Place en file d'attente un lot de models.embedContent requêtes pour le traitement par lot. Nous avons un gestionnaire models.batchEmbedContents dans GenerativeService, mais il était synchronisé. Pour éviter toute confusion, nous allons nommer celui-ci Async.

Point de terminaison

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:asyncBatchEmbedContent

Paramètres de chemin d'accès

batch.model string

Obligatoire. Nom du Model à utiliser pour générer la complétion.

Format : models/{model}. Il se présente sous la forme models/{model}.

Corps de la requête

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

Champs
batch.name string

Uniquement en sortie. Identifiant. Nom de ressource du lot.

Format : batches/{batchId}.

batch.displayName string

Obligatoire. Nom défini par l'utilisateur pour ce lot.

batch.inputConfig object (InputEmbedContentConfig)

Obligatoire. Configuration d'entrée des instances sur lesquelles le traitement par lot est effectué.

batch.output object (EmbedContentBatchOutput)

Uniquement en sortie. Sortie de la requête par lot.

batch.createTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le lot a été créé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le traitement par lot s'est terminé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le lot a été mis à jour pour la dernière fois.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

batch.batchStats object (EmbedContentBatchStats)

Uniquement en sortie. Statistiques sur le lot.

batch.state enum (BatchState)

Uniquement en sortie. État du lot.

batch.priority string (int64 format)

Facultatif. Priorité du lot. Les lots ayant une valeur de priorité plus élevée seront traités avant ceux ayant une valeur de priorité plus faible. Les valeurs négatives sont autorisées. La valeur par défaut est "0".

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Méthode : batches.get

Récupère le dernier état d'une opération de longue durée. Cette méthode permet aux clients d'interroger le résultat de l'opération à des intervalles recommandés par le service d'API.

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Paramètres de chemin d'accès

name string

Nom de la ressource de l'opération. Il se présente sous la forme batches/{batches}.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Méthode : batches.list

Répertorie les opérations qui correspondent au filtre spécifié dans la requête. Si le serveur n'accepte pas cette méthode, il renvoie UNIMPLEMENTED.

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/{name=batches}

Paramètres de chemin d'accès

name string

Le nom de la ressource parente de l'opération. Il se présente sous la forme batches.

Paramètres de requête

filter string

Le filtre de la liste standard.

pageSize integer

La taille de page de la liste standard.

pageToken string

Le jeton de page de la liste standard.

returnPartialSuccess boolean

Lorsque la valeur est définie sur true, les opérations accessibles sont renvoyées normalement, et celles qui ne le sont pas sont renvoyées dans le champ [ListOperationsResponse.unreachable].

Cette valeur ne peut être définie sur true que lors de la lecture de plusieurs collections, par exemple lorsque parent est défini sur "projects/example/locations/-".

Par défaut, ce champ n'est pas pris en charge et générera une erreur UNIMPLEMENTED s'il est défini, sauf indication contraire explicite dans la documentation spécifique au service ou au produit.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ListOperationsResponse.

Méthode : batches.cancel

Démarre l'annulation asynchrone sur une opération de longue durée. Le serveur fait de son mieux pour annuler l'opération, mais la réussite de l'annulation n'est pas garantie. Si le serveur n'accepte pas cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED. Les clients peuvent utiliser Operations.GetOperation ou d'autres méthodes pour vérifier si l'annulation a réussi, ou si l'opération a abouti malgré la tentative d'annulation. En cas d'annulation réussie, l'opération n'est pas supprimée, mais elle devient une opération portant une valeur Operation.error avec un google.rpc.Status.code de 1, ce qui correspond à Code.CANCELLED.

Point de terminaison

post https://generativelanguage.googleapis.com/v1beta/{name=batches/*}:cancel

Paramètres de chemin d'accès

name string

Le nom de la ressource de l'opération à annuler. Il se présente sous la forme batches/{batches}.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est un objet JSON vide.

Méthode : batches.delete

Supprime une opération de longue durée. Cette méthode indique que le client n'est plus intéressé par le résultat de l'opération. Elle n'annule pas l'opération. Si le serveur n'accepte pas cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED.

Point de terminaison

delete https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Paramètres de chemin d'accès

name string

Le nom de ressource de l'opération à supprimer. Il se présente sous la forme batches/{batches}.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est un objet JSON vide.

GenerateContentBatch

Ressource représentant un lot de requêtes GenerateContent.

Champs
model string

Obligatoire. Nom du Model à utiliser pour générer la complétion.

Format : models/{model}.

name string

Uniquement en sortie. Identifiant. Nom de ressource du lot.

Format : batches/{batchId}.

displayName string

Obligatoire. Nom défini par l'utilisateur pour ce lot.

inputConfig object (InputConfig)

Obligatoire. Configuration d'entrée des instances sur lesquelles le traitement par lot est effectué.

output object (GenerateContentBatchOutput)

Uniquement en sortie. Sortie de la requête par lot.

createTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le lot a été créé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le traitement par lot s'est terminé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Uniquement en sortie. Heure à laquelle le lot a été mis à jour pour la dernière fois.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

batchStats object (BatchStats)

Uniquement en sortie. Statistiques sur le lot.

state enum (BatchState)

Uniquement en sortie. État du lot.

priority string (int64 format)

Facultatif. Priorité du lot. Les lots ayant une valeur de priorité plus élevée seront traités avant ceux ayant une valeur de priorité plus faible. Les valeurs négatives sont autorisées. La valeur par défaut est "0".

Représentation JSON 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputConfig)
  },
  "output": {
    object (GenerateContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (BatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputConfig

Configure l'entrée de la requête par lot.

Champs
source Union type
Obligatoire. Source de l'entrée. source ne peut être qu'un des éléments suivants :
fileName string

Nom du File contenant les requêtes d'entrée.

requests object (InlinedRequests)

Requêtes à traiter dans le lot.

Représentation JSON 
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedRequests)
  }
  // Union type
}

InlinedRequests

Requêtes à traiter dans le lot si elles sont fournies dans la requête de création du lot.

Champs
requests[] object (InlinedRequest)

Obligatoire. Requêtes à traiter dans le lot.

Représentation JSON 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

InlinedRequest

Requête à traiter dans le lot.

Champs
request object (GenerateContentRequest)

Obligatoire. Requête à traiter dans le lot.

metadata object (Struct format)

Facultatif. Métadonnées à associer à la requête.

Représentation JSON 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

GenerateContentBatchOutput

Sortie d'une requête par lot. Cette valeur est renvoyée dans le champ BatchGenerateContentResponse ou GenerateContentBatch.output.

Champs
output Union type
Sortie de la requête par lot. output ne peut être qu'un des éléments suivants :
responsesFile string

Uniquement en sortie. ID du fichier contenant les réponses. Il s'agit d'un fichier JSONL avec une seule réponse par ligne. Les réponses seront des messages GenerateContentResponse au format JSON. Les réponses seront rédigées dans le même ordre que les requêtes d'entrée.

inlinedResponses object (InlinedResponses)

Uniquement en sortie. Réponses aux requêtes du lot. Renvoie la valeur "true" si le lot a été créé à l'aide de requêtes intégrées. Les réponses seront dans le même ordre que les requêtes d'entrée.

Représentation JSON 
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedResponses)
  }
  // Union type
}

InlinedResponses

Réponses aux requêtes du lot.

Champs
inlinedResponses[] object (InlinedResponse)

Uniquement en sortie. Réponses aux requêtes du lot.

Représentation JSON 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

InlinedResponse

Réponse à une seule requête du lot.

Champs
metadata object (Struct format)

Uniquement en sortie. Métadonnées associées à la requête.

output Union type
Résultat de la requête. output ne peut être qu'un des éléments suivants :
error object (Status)

Uniquement en sortie. Erreur rencontrée lors du traitement de la demande.

response object (GenerateContentResponse)

Uniquement en sortie. Réponse à la demande.

Représentation JSON 
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (GenerateContentResponse)
  }
  // Union type
}

BatchStats

Statistiques sur le lot.

Champs
requestCount string (int64 format)

Uniquement en sortie. Nombre de requêtes dans le lot.

successfulRequestCount string (int64 format)

Uniquement en sortie. Nombre de requêtes traitées avec succès.

failedRequestCount string (int64 format)

Uniquement en sortie. Nombre de requêtes qui n'ont pas pu être traitées.

pendingRequestCount string (int64 format)

Uniquement en sortie. Nombre de demandes en attente de traitement.

Représentation JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

Méthode : batches.updateEmbedContentBatch

Met à jour un lot de requêtes EmbedContent pour le traitement par lot.

Point de terminaison

patch https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

PATCH https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

Paramètres de chemin d'accès

embedContentBatch.name string

Uniquement en sortie. Identifiant. Nom de ressource du lot.

Format : batches/{batchId}. Il se présente sous la forme batches/{batches}.

Paramètres de requête

updateMask string (FieldMask format)

Facultatif. Liste des champs à mettre à jour.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la requête

Le corps de la requête contient une instance de EmbedContentBatch.

Champs
model string

Obligatoire. Nom du Model à utiliser pour générer la complétion.

Format : models/{model}.

displayName string

Obligatoire. Nom défini par l'utilisateur pour ce lot.

inputConfig object (InputEmbedContentConfig)

Obligatoire. Configuration d'entrée des instances sur lesquelles le traitement par lot est effectué.

priority string (int64 format)

Facultatif. Priorité du lot. Les lots ayant une valeur de priorité plus élevée seront traités avant ceux ayant une valeur de priorité plus faible. Les valeurs négatives sont autorisées. La valeur par défaut est "0".

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de EmbedContentBatch.

EmbedContentRequest

Requête contenant le Content à intégrer au modèle.

Champs
model string

Obligatoire. Nom de ressource du modèle. Il sert d'ID au modèle.

Ce nom doit correspondre à un nom de modèle renvoyé par la méthode ListModels.

Format : models/{model}

content object (Content)

Obligatoire. Contenu à intégrer. Seuls les champs parts.text seront comptabilisés.

taskType enum (TaskType)

Facultatif. Type de tâche facultatif pour lequel les embeddings seront utilisés. Non compatible avec les modèles antérieurs (models/embedding-001).

title string

Facultatif. Titre facultatif du texte. Ne s'applique que lorsque TaskType est défini sur RETRIEVAL_DOCUMENT.

Remarque : Spécifier un title pour RETRIEVAL_DOCUMENT permet d'obtenir des embeddings de meilleure qualité pour la récupération.

outputDimensionality integer

Facultatif. Dimension réduite facultative pour l'embedding de sortie. Si cette option est définie, les valeurs excessives de l'embedding de sortie sont tronquées à la fin. Compatible avec les modèles récents (à partir de 2024) uniquement. Vous ne pouvez pas définir cette valeur si vous utilisez l'ancien modèle (models/embedding-001).

Représentation JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}

Méthode : batches.updateGenerateContentBatch

Met à jour un lot de requêtes GenerateContent pour le traitement par lot.

Point de terminaison

patch https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

PATCH https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

Paramètres de chemin d'accès

generateContentBatch.name string

Uniquement en sortie. Identifiant. Nom de ressource du lot.

Format : batches/{batchId}. Il se présente sous la forme batches/{batches}.

Paramètres de requête

updateMask string (FieldMask format)

Facultatif. Liste des champs à mettre à jour.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la requête

Le corps de la requête contient une instance de GenerateContentBatch.

Champs
model string

Obligatoire. Nom du Model à utiliser pour générer la complétion.

Format : models/{model}.

displayName string

Obligatoire. Nom défini par l'utilisateur pour ce lot.

inputConfig object (InputConfig)

Obligatoire. Configuration d'entrée des instances sur lesquelles le traitement par lot est effectué.

priority string (int64 format)

Facultatif. Priorité du lot. Les lots ayant une valeur de priorité plus élevée seront traités avant ceux ayant une valeur de priorité plus faible. Les valeurs négatives sont autorisées. La valeur par défaut est "0".

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de GenerateContentBatch.

GenerateContentRequest

Requête de génération d'une complétion à partir du modèle.

Champs
model string

Obligatoire. Nom du Model à utiliser pour générer la complétion.

Format : models/{model}.

contents[] object (Content)

Obligatoire. Contenu de la conversation en cours avec le modèle.

Pour les requêtes à un seul tour, il s'agit d'une instance unique. Pour les requêtes multitours comme chat, il s'agit d'un champ répété contenant l'historique de la conversation et la dernière requête.

tools[] object (Tool)

Facultatif. Liste de Tools que Model peut utiliser pour générer la réponse suivante.

Un Tool est un morceau de code qui permet au système d'interagir avec des systèmes externes pour effectuer une action ou un ensemble d'actions en dehors du champ d'application et des connaissances de Model. Les Tool acceptés sont Function et codeExecution. Pour en savoir plus, consultez les guides Appel de fonction et Exécution de code.

toolConfig object (ToolConfig)

Facultatif. Configuration de l'outil pour tout Tool spécifié dans la requête. Pour obtenir un exemple d'utilisation, consultez le guide sur l'appel de fonction.

safetySettings[] object (SafetySetting)

Facultatif. Liste d'instances SafetySetting uniques permettant de bloquer le contenu non sécurisé.

Cette règle sera appliquée sur GenerateContentRequest.contents et GenerateContentResponse.candidates. Il ne doit pas y avoir plus d'un paramètre pour chaque type SafetyCategory. L'API bloquera tout contenu et toute réponse qui ne respectent pas les seuils définis par ces paramètres. Cette liste remplace les paramètres par défaut de chaque SafetyCategory spécifié dans safetySettings. Si aucun SafetySetting n'est associé à un SafetyCategory donné dans la liste, l'API utilise le paramètre de sécurité par défaut pour cette catégorie. Les catégories de préjudice HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT et HARM_CATEGORY_CIVIC_INTEGRITY sont acceptées. Pour en savoir plus sur les paramètres de sécurité disponibles, consultez le guide. Consultez également les Consignes de sécurité pour découvrir comment intégrer des considérations de sécurité dans vos applications d'IA.

systemInstruction object (Content)

Facultatif. Le développeur a défini des instructions système. Texte uniquement pour le moment.

generationConfig object (GenerationConfig)

Facultatif. Options de configuration pour la génération et les sorties de modèles.

cachedContent string

Facultatif. Nom du contenu mis en cache à utiliser comme contexte pour diffuser la prédiction. Format : cachedContents/{cachedContent}

Représentation JSON 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}

BatchState

État du lot.

Enums
BATCH_STATE_UNSPECIFIED L'état du lot n'est pas spécifié.
BATCH_STATE_PENDING Le service se prépare à exécuter le lot.
BATCH_STATE_RUNNING Le lot est en cours.
BATCH_STATE_SUCCEEDED Le lot a bien été traité.
BATCH_STATE_FAILED Le lot a échoué.
BATCH_STATE_CANCELLED Le lot a été annulé.
BATCH_STATE_EXPIRED Le lot a expiré.

Ressource REST : batches

Ressource : Operation

Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.

Champs
name string

Nom attribué par le serveur. Unique au sein du service qui le renvoie initialement. Si vous utilisez le mappage HTTP par défaut, le champ name doit être un nom de ressource se terminant par operations/{unique_id}.

metadata object

Métadonnées spécifiques au service associées à l'opération. Ce champ contient généralement des informations de progression et des métadonnées courantes telles que la date de création. Certains services peuvent ne pas fournir ce genre de métadonnées. Toute méthode renvoyant une opération de longue durée doit indiquer le type de métadonnées, le cas échéant.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Si la valeur est false, cela signifie que l'opération est toujours en cours. Si elle est définie sur true, l'opération est terminée, et un message error ou response est disponible.

result Union type
Résultat de l'opération, qui peut être une erreur (message error) ou une réponse valide (message response). Si done == false, ni error, ni response ne sont définis. Si done == true, une seule des options error ou response peut être définie. Certains services peuvent ne pas fournir le résultat. result ne peut être qu'un des éléments suivants :
error object (Status)

Résultat d'erreur de l'opération en cas d'échec ou d'annulation.

response object

Réponse normale indiquant la réussite de l'opération. Si la méthode d'origine ne renvoie aucune donnée en cas de réussite (telle que Delete), la réponse est google.protobuf.Empty. Si la méthode d'origine est une méthode Get/Create/Update standard, la réponse doit correspondre à la ressource. Pour les autres méthodes, la réponse doit avoir le type XxxResponse, où Xxx est le nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de réponse déduit est TakeSnapshotResponse.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Représentation JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}