Batch API

L'API Gemini supporta le API batch, che consentono di elaborare più richieste in una singola chiamata. Per maggiori dettagli, consulta la guida all'API batch.

Metodo: models.batchGenerateContent

Mette in coda un batch di richieste models.generateContent per l'elaborazione batch.

Endpoint

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

Parametri del percorso

batch.model string

Obbligatorio. Il nome di Model da utilizzare per generare il completamento.

Formato: models/{model}. Assume la forma models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
batch.name string

Solo output. Identificatore. Nome risorsa del batch.

Formato: batches/{batchId}.

batch.displayName string

Obbligatorio. Il nome definito dall'utente di questo batch.

batch.inputConfig object (InputConfig)

Obbligatorio. Configurazione di input delle istanze su cui viene eseguita l'elaborazione batch.

batch.output object (GenerateContentBatchOutput)

Solo output. L'output della richiesta batch.

batch.createTime string (Timestamp format)

Solo output. L'ora in cui è stato creato il batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Solo output. L'ora in cui è stata completata l'elaborazione batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Solo output. L'ora dell'ultimo aggiornamento del batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.batchStats object (BatchStats)

Solo output. Statistiche sul batch.

batch.state enum (BatchState)

Solo output. Lo stato del batch.

batch.priority string (int64 format)

(Facoltativo) La priorità del batch. I batch con un valore di priorità più alto vengono elaborati prima di quelli con un valore di priorità più basso. Sono consentiti valori negativi. Il valore predefinito è 0.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

GenerateContentRequest

Richiedi di generare un completamento dal modello.

Campi
model string

Obbligatorio. Il nome di Model da utilizzare per generare il completamento.

Formato: models/{model}.

contents[] object (Content)

Obbligatorio. I contenuti della conversazione attuale con il modello.

Per le query a un solo turno, si tratta di una singola istanza. Per le query multi-turno come chat, questo è un campo ripetuto che contiene la cronologia della conversazione e l'ultima richiesta.

tools[] object (Tool)

(Facoltativo) Un elenco di Tools che Model può utilizzare per generare la risposta successiva.

Un Tool è un frammento di codice che consente al sistema di interagire con sistemi esterni per eseguire un'azione o un insieme di azioni al di fuori delle conoscenze e dell'ambito dell'Model. I Tool supportati sono Function e codeExecution. Per saperne di più, consulta le guide Chiamata di funzioni ed Esecuzione di codice.

toolConfig object (ToolConfig)

(Facoltativo) Configurazione dello strumento per qualsiasi Tool specificato nella richiesta. Per un esempio di utilizzo, consulta la guida alla chiamata di funzioni.

safetySettings[] object (SafetySetting)

(Facoltativo) Un elenco di istanze SafetySetting uniche per bloccare i contenuti non sicuri.

Questa norma verrà applicata il giorno GenerateContentRequest.contents e GenerateContentResponse.candidates. Non deve esserci più di un'impostazione per ogni tipo di SafetyCategory. L'API bloccherà tutti i contenuti e le risposte che non soddisfano le soglie impostate da queste impostazioni. Questo elenco sostituisce le impostazioni predefinite per ogni SafetyCategory specificato in safetySettings. Se nell'elenco non è presente SafetySetting per un determinato SafetyCategory, l'API utilizzerà l'impostazione di sicurezza predefinita per quella categoria. Sono supportate le categorie di contenuti dannosi HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Per informazioni dettagliate sulle impostazioni di sicurezza disponibili, consulta la guida. Consulta anche le indicazioni sulla sicurezza per scoprire come incorporare le considerazioni sulla sicurezza nelle tue applicazioni di AI.

systemInstruction object (Content)

(Facoltativo) Lo sviluppatore ha impostato istruzioni di sistema. Al momento, solo testo.

generationConfig object (GenerationConfig)

(Facoltativo) Opzioni di configurazione per la generazione e gli output del modello.

cachedContent string

(Facoltativo) Il nome dei contenuti memorizzati nella cache da utilizzare come contesto per fornire la previsione. Formato: cachedContents/{cachedContent}

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

Metodo: models.asyncBatchEmbedContent

Mette in coda un batch di richieste models.embedContent per l'elaborazione batch. Abbiamo un gestore models.batchEmbedContents in GenerativeService, ma è stato sincronizzato. Quindi, per evitare confusione, lo chiamiamo Async.

Endpoint

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

Parametri del percorso

batch.model string

Obbligatorio. Il nome di Model da utilizzare per generare il completamento.

Formato: models/{model}. Assume la forma models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
batch.name string

Solo output. Identificatore. Nome risorsa del batch.

Formato: batches/{batchId}.

batch.displayName string

Obbligatorio. Il nome definito dall'utente di questo batch.

batch.inputConfig object (InputEmbedContentConfig)

Obbligatorio. Configurazione di input delle istanze su cui viene eseguita l'elaborazione batch.

batch.output object (EmbedContentBatchOutput)

Solo output. L'output della richiesta batch.

batch.createTime string (Timestamp format)

Solo output. L'ora in cui è stato creato il batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Solo output. L'ora in cui è stata completata l'elaborazione batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Solo output. L'ora dell'ultimo aggiornamento del batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.batchStats object (EmbedContentBatchStats)

Solo output. Statistiche sul batch.

batch.state enum (BatchState)

Solo output. Lo stato del batch.

batch.priority string (int64 format)

(Facoltativo) La priorità del batch. I batch con un valore di priorità più alto vengono elaborati prima di quelli con un valore di priorità più basso. Sono consentiti valori negativi. Il valore predefinito è 0.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

EmbedContentRequest

Richiesta contenente Content per il modello da incorporare.

Campi
model string

Obbligatorio. Il nome della risorsa del modello. che funge da ID da utilizzare per il modello.

Questo nome deve corrispondere a un nome di modello restituito dal metodo models.list.

Formato: models/{model}

content object (Content)

Obbligatorio. I contenuti da incorporare. Verranno conteggiati solo i campi parts.text.

taskType enum (TaskType)

(Facoltativo) (Facoltativo) Tipo di attività per cui verranno utilizzati gli incorporamenti. Non supportato sui modelli precedenti (models/embedding-001).

title string

(Facoltativo) Un titolo facoltativo per il testo. Applicabile solo quando TaskType è RETRIEVAL_DOCUMENT.

Nota: specificare un title per RETRIEVAL_DOCUMENT fornisce incorporamenti di qualità migliore per il recupero.

outputDimensionality integer

(Facoltativo) Dimensione ridotta facoltativa per l'incorporamento di output. Se impostato, i valori eccessivi nell'incorporamento dell'output vengono troncati dalla fine. Supportato solo dai modelli più recenti a partire dal 2024. Non puoi impostare questo valore se utilizzi il modello precedente (models/embedding-001).

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

Metodo: batches.get

Recupera lo stato più recente di un'operazione a lunga esecuzione. I client possono utilizzare questo metodo per eseguire il polling del risultato dell'operazione a intervalli come consigliato dal servizio API.

Endpoint

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

Parametri del percorso

name string

Il nome della risorsa dell'operazione. Assume la forma batches/{batches}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Metodo: batches.list

Elenca le operazioni che corrispondono al filtro specificato nella richiesta. Se il server non supporta questo metodo, restituisce UNIMPLEMENTED.

Endpoint

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

Parametri del percorso

name string

Il nome della risorsa padre dell'operazione. Assume la forma batches.

Parametri di query

filter string

Il filtro standard dell'elenco.

pageSize integer

Le dimensioni standard della pagina dell'elenco.

pageToken string

Il token della pagina dell'elenco standard.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di ListOperationsResponse.

Metodo: batches.cancel

Avvia l'annullamento asincrono di un'operazione a lunga esecuzione. Il server fa del suo meglio per annullare l'operazione, ma la riuscita non è garantita. Se il server non supporta questo metodo, restituisce google.rpc.Code.UNIMPLEMENTED. I client possono utilizzare Operations.GetOperation o altri metodi per verificare se l'annullamento è andato a buon fine o se l'operazione è stata completata nonostante l'annullamento. In caso di annullamento riuscito, l'operazione non viene eliminata, ma diventa un'operazione con un valore Operation.error con un google.rpc.Status.code di 1, corrispondente a Code.CANCELLED.

Endpoint

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

Parametri del percorso

name string

Il nome della risorsa dell'operazione da annullare. Assume la forma batches/{batches}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta è un oggetto JSON vuoto.

Metodo: batches.delete

Elimina un'operazione a lunga esecuzione. Questo metodo indica che il client non è più interessato al risultato dell'operazione. Non annulla l'operazione. Se il server non supporta questo metodo, restituisce google.rpc.Code.UNIMPLEMENTED.

Endpoint

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

Parametri del percorso

name string

Il nome della risorsa dell'operazione da eliminare. Assume la forma batches/{batches}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta è un oggetto JSON vuoto.

GenerateContentBatch

Una risorsa che rappresenta un batch di richieste GenerateContent.

Campi
model string

Obbligatorio. Il nome di Model da utilizzare per generare il completamento.

Formato: models/{model}.

name string

Solo output. Identificatore. Nome risorsa del batch.

Formato: batches/{batchId}.

displayName string

Obbligatorio. Il nome definito dall'utente di questo batch.

inputConfig object (InputConfig)

Obbligatorio. Configurazione di input delle istanze su cui viene eseguita l'elaborazione batch.

output object (GenerateContentBatchOutput)

Solo output. L'output della richiesta batch.

createTime string (Timestamp format)

Solo output. L'ora in cui è stato creato il batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Solo output. L'ora in cui è stata completata l'elaborazione batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Solo output. L'ora dell'ultimo aggiornamento del batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batchStats object (BatchStats)

Solo output. Statistiche sul batch.

state enum (BatchState)

Solo output. Lo stato del batch.

priority string (int64 format)

(Facoltativo) La priorità del batch. I batch con un valore di priorità più alto vengono elaborati prima di quelli con un valore di priorità più basso. Sono consentiti valori negativi. Il valore predefinito è 0.

Rappresentazione 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

Configura l'input della richiesta batch.

Campi
source Union type
Obbligatorio. L'origine dell'input. source può essere solo uno dei seguenti:
fileName string

Il nome di File contenente le richieste di input.

requests object (InlinedRequests)

Le richieste da elaborare nel batch.

Rappresentazione JSON 
{

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

InlinedRequests

Le richieste da elaborare nel batch, se fornite nell'ambito della richiesta di creazione del batch.

Campi
requests[] object (InlinedRequest)

Obbligatorio. Le richieste da elaborare nel batch.

Rappresentazione JSON 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

InlinedRequest

La richiesta da elaborare nel batch.

Campi
request object (GenerateContentRequest)

Obbligatorio. La richiesta da elaborare nel batch.

metadata object (Struct format)

(Facoltativo) I metadati da associare alla richiesta.

Rappresentazione JSON 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

GenerateContentBatchOutput

L'output di una richiesta batch. Questo valore viene restituito nel campo BatchGenerateContentResponse o GenerateContentBatch.output.

Campi
output Union type
L'output della richiesta batch. output può essere solo uno dei seguenti:
responsesFile string

Solo output. L'ID file del file contenente le risposte. Il file sarà un file JSONL con una sola risposta per riga. Le risposte saranno messaggi GenerateContentResponse formattati come JSON. Le risposte verranno scritte nello stesso ordine delle richieste di input.

inlinedResponses object (InlinedResponses)

Solo output. Le risposte alle richieste nel batch. Restituito quando il batch è stato creato utilizzando richieste incorporate. Le risposte saranno nello stesso ordine delle richieste di input.

Rappresentazione JSON 
{

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

InlinedResponses

Le risposte alle richieste nel batch.

Campi
inlinedResponses[] object (InlinedResponse)

Solo output. Le risposte alle richieste nel batch.

Rappresentazione JSON 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

InlinedResponse

La risposta a una singola richiesta nel batch.

Campi
metadata object (Struct format)

Solo output. I metadati associati alla richiesta.

output Union type
L'output della richiesta. output può essere solo uno dei seguenti:
error object (Status)

Solo output. L'errore riscontrato durante l'elaborazione della richiesta.

response object (GenerateContentResponse)

Solo output. La risposta alla richiesta.

Rappresentazione JSON 
{
  "metadata": {
    object
  },

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

BatchStats

Statistiche sul batch.

Campi
requestCount string (int64 format)

Solo output. Il numero di richieste nel batch.

successfulRequestCount string (int64 format)

Solo output. Il numero di richieste elaborate correttamente.

failedRequestCount string (int64 format)

Solo output. Il numero di richieste che non sono state elaborate.

pendingRequestCount string (int64 format)

Solo output. Il numero di richieste per le quali l'elaborazione è ancora in attesa.

Rappresentazione JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

EmbedContentBatch

Una risorsa che rappresenta un batch di richieste EmbedContent.

Campi
model string

Obbligatorio. Il nome di Model da utilizzare per generare il completamento.

Formato: models/{model}.

name string

Solo output. Identificatore. Nome risorsa del batch.

Formato: batches/{batchId}.

displayName string

Obbligatorio. Il nome definito dall'utente di questo batch.

inputConfig object (InputEmbedContentConfig)

Obbligatorio. Configurazione di input delle istanze su cui viene eseguita l'elaborazione batch.

output object (EmbedContentBatchOutput)

Solo output. L'output della richiesta batch.

createTime string (Timestamp format)

Solo output. L'ora in cui è stato creato il batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Solo output. L'ora in cui è stata completata l'elaborazione batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Solo output. L'ora dell'ultimo aggiornamento del batch.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batchStats object (EmbedContentBatchStats)

Solo output. Statistiche sul batch.

state enum (BatchState)

Solo output. Lo stato del batch.

priority string (int64 format)

(Facoltativo) La priorità del batch. I batch con un valore di priorità più alto vengono elaborati prima di quelli con un valore di priorità più basso. Sono consentiti valori negativi. Il valore predefinito è 0.

Rappresentazione JSON 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputEmbedContentConfig)
  },
  "output": {
    object (EmbedContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (EmbedContentBatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputEmbedContentConfig

Configura l'input della richiesta batch.

Campi
source Union type
Obbligatorio. L'origine dell'input. source può essere solo uno dei seguenti:
fileName string

Il nome di File contenente le richieste di input.

requests object (InlinedEmbedContentRequests)

Le richieste da elaborare nel batch.

Rappresentazione JSON 
{

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

InlinedEmbedContentRequests

Le richieste da elaborare nel batch, se fornite nell'ambito della richiesta di creazione del batch.

Campi
requests[] object (InlinedEmbedContentRequest)

Obbligatorio. Le richieste da elaborare nel batch.

Rappresentazione JSON 
{
  "requests": [
    {
      object (InlinedEmbedContentRequest)
    }
  ]
}

InlinedEmbedContentRequest

La richiesta da elaborare nel batch.

Campi
request object (EmbedContentRequest)

Obbligatorio. La richiesta da elaborare nel batch.

metadata object (Struct format)

(Facoltativo) I metadati da associare alla richiesta.

Rappresentazione JSON 
{
  "request": {
    object (EmbedContentRequest)
  },
  "metadata": {
    object
  }
}

EmbedContentBatchOutput

L'output di una richiesta batch. Questo valore viene restituito nel campo AsyncBatchEmbedContentResponse o EmbedContentBatch.output.

Campi
output Union type
L'output della richiesta batch. output può essere solo uno dei seguenti:
responsesFile string

Solo output. L'ID file del file contenente le risposte. Il file sarà un file JSONL con una sola risposta per riga. Le risposte saranno messaggi EmbedContentResponse formattati come JSON. Le risposte verranno scritte nello stesso ordine delle richieste di input.

inlinedResponses object (InlinedEmbedContentResponses)

Solo output. Le risposte alle richieste nel batch. Restituito quando il batch è stato creato utilizzando richieste incorporate. Le risposte saranno nello stesso ordine delle richieste di input.

Rappresentazione JSON 
{

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

InlinedEmbedContentResponses

Le risposte alle richieste nel batch.

Campi
inlinedResponses[] object (InlinedEmbedContentResponse)

Solo output. Le risposte alle richieste nel batch.

Rappresentazione JSON 
{
  "inlinedResponses": [
    {
      object (InlinedEmbedContentResponse)
    }
  ]
}

InlinedEmbedContentResponse

La risposta a una singola richiesta nel batch.

Campi
metadata object (Struct format)

Solo output. I metadati associati alla richiesta.

output Union type
L'output della richiesta. output può essere solo uno dei seguenti:
error object (Status)

Solo output. L'errore riscontrato durante l'elaborazione della richiesta.

response object (EmbedContentResponse)

Solo output. La risposta alla richiesta.

Rappresentazione JSON 
{
  "metadata": {
    object
  },

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

EmbedContentBatchStats

Statistiche sul batch.

Campi
requestCount string (int64 format)

Solo output. Il numero di richieste nel batch.

successfulRequestCount string (int64 format)

Solo output. Il numero di richieste elaborate correttamente.

failedRequestCount string (int64 format)

Solo output. Il numero di richieste che non sono state elaborate.

pendingRequestCount string (int64 format)

Solo output. Il numero di richieste per le quali l'elaborazione è ancora in attesa.

Rappresentazione JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

BatchState

Lo stato del batch.

Enum
BATCH_STATE_UNSPECIFIED Lo stato del batch non è specificato.
BATCH_STATE_PENDING Il servizio si sta preparando a eseguire il batch.
BATCH_STATE_RUNNING Il batch è in corso.
BATCH_STATE_SUCCEEDED Il batch è stato completato correttamente.
BATCH_STATE_FAILED Il batch non è riuscito.
BATCH_STATE_CANCELLED Il batch è stato annullato.
BATCH_STATE_EXPIRED Il batch è scaduto.

Risorsa REST: batches

Risorsa: Operazione

Questa risorsa rappresenta un'operazione a lunga esecuzione che è il risultato di una chiamata API di rete.

Campi
name string

Il nome assegnato dal server, che è univoco solo all'interno dello stesso servizio che lo restituisce originariamente. Se utilizzi la mappatura HTTP predefinita, name deve essere un nome di risorsa che termina con operations/{unique_id}.

metadata object

Metadati specifici del servizio associati all'operazione. In genere contiene informazioni sullo stato di avanzamento e metadati comuni come l'ora di creazione. Alcuni servizi potrebbero non fornire questi metadati. Qualsiasi metodo che restituisce un'operazione a lunga esecuzione deve documentare il tipo di metadati, se presente.

Un oggetto contenente campi di un tipo arbitrario. Un campo aggiuntivo "@type" contiene un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Se il valore è false, significa che l'operazione è ancora in corso. Se true, l'operazione viene completata ed è disponibile error o response.

result Union type
Il risultato dell'operazione, che può essere un error o un response valido. Se done == false, non è impostato né error né response. Se done == true, è possibile impostare esattamente uno dei valori error o response. Alcuni servizi potrebbero non fornire il risultato. result può essere solo uno dei seguenti:
error object (Status)

Il risultato dell'errore dell'operazione in caso di errore o annullamento.

response object

La risposta normale e riuscita dell'operazione. Se il metodo originale non restituisce dati in caso di esito positivo, ad esempio Delete, la risposta è google.protobuf.Empty. Se il metodo originale è standard Get/Create/Update, la risposta deve essere la risorsa. Per gli altri metodi, la risposta deve avere il tipo XxxResponse, dove Xxx è il nome del metodo originale. Ad esempio, se il nome del metodo originale è TakeSnapshot(), il tipo di risposta dedotto è TakeSnapshotResponse.

Un oggetto contenente campi di un tipo arbitrario. Un campo aggiuntivo "@type" contiene un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.

Rappresentazione JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

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