Batch API

Die Gemini API unterstützt Batch-APIs, mit denen Sie mehrere Anfragen in einem einzigen Aufruf verarbeiten können. Weitere Informationen finden Sie in der Batch API-Anleitung.

Methode: models.batchGenerateContent

Stellt einen Batch von models.generateContent-Anfragen für die Batchverarbeitung in die Warteschlange.

Endpunkt

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

Pfadparameter

batch.model string

Erforderlich. Der Name des Model, der zum Generieren der Vervollständigung verwendet werden soll.

Format: models/{model}. Sie hat die Form models/{model}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

Felder
batch.name string

Nur Ausgabe. ID. Ressourcenname des Batches.

Format: batches/{batchId}.

batch.displayName string

Erforderlich. Der benutzerdefinierte Name dieses Batches.

batch.inputConfig object (InputConfig)

Erforderlich. Eingabekonfiguration der Instanzen, auf denen die Batchverarbeitung ausgeführt wird.

batch.output object (GenerateContentBatchOutput)

Nur Ausgabe. Die Ausgabe der Batchanfrage.

batch.createTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Batchverarbeitung abgeschlossen wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

batch.batchStats object (BatchStats)

Nur Ausgabe. Statistiken zum Batch.

batch.state enum (BatchState)

Nur Ausgabe. Der Status des Batches.

batch.priority string (int64 format)

Optional. Die Priorität des Batches. Batches mit einem höheren Prioritätswert werden vor Batches mit einem niedrigeren Prioritätswert verarbeitet. Negative Werte sind zulässig. Der Standardwert ist 0.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

GenerateContentRequest

Anfrage zum Generieren einer Vervollständigung durch das Modell.

Felder
model string

Erforderlich. Der Name des Model, der zum Generieren der Vervollständigung verwendet werden soll.

Format: models/{model}.

contents[] object (Content)

Erforderlich. Der Inhalt der aktuellen Unterhaltung mit dem Modell.

Bei Einzelabfragen ist dies eine einzelne Instanz. Bei Mehrfachabfragen wie chat ist dies ein wiederkehrendes Feld, das den Unterhaltungsverlauf und die letzte Anfrage enthält.

tools[] object (Tool)

Optional. Eine Liste mit Tools, die Model verwenden kann, um die nächste Antwort zu generieren.

Eine Tool ist ein Code, der es dem System ermöglicht, mit externen Systemen zu interagieren, um eine Aktion oder eine Reihe von Aktionen außerhalb des Wissens und Umfangs der Model auszuführen. Unterstützte Tools sind Function und codeExecution. Weitere Informationen finden Sie in den Anleitungen Funktionsaufrufe und Codeausführung.

toolConfig object (ToolConfig)

Optional. Toolkonfiguration für alle in der Anfrage angegebenen Tool. Ein Anwendungsbeispiel finden Sie im Leitfaden zu Funktionsaufrufen.

safetySettings[] object (SafetySetting)

Optional. Eine Liste mit eindeutigen SafetySetting-Instanzen zum Blockieren unsicherer Inhalte.

Dies wird auf der GenerateContentRequest.contents und der GenerateContentResponse.candidates erzwungen. Es sollte nicht mehr als eine Einstellung für jeden SafetyCategory-Typ geben. Die API blockiert alle Inhalte und Antworten, die die durch diese Einstellungen festgelegten Grenzwerte nicht erreichen. Diese Liste überschreibt die Standardeinstellungen für die einzelnen SafetyCategory, die in „safetySettings“ angegeben sind. Wenn für ein bestimmtes SafetyCategory in der Liste kein SafetySetting angegeben ist, verwendet die API die standardmäßige Sicherheitseinstellung für diese Kategorie. Die Kategorien schädlicher Inhalte HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT und HARM_CATEGORY_CIVIC_INTEGRITY werden unterstützt. Hier finden Sie eine Anleitung mit detaillierten Informationen zu den verfügbaren Sicherheitseinstellungen. Sicherheitshinweise

systemInstruction object (Content)

Optional. Der Entwickler hat Systemanweisungen festgelegt. Derzeit nur Text.

generationConfig object (GenerationConfig)

Optional. Konfigurationsoptionen für die Modellgenerierung und ‑ausgabe.

cachedContent string

Optional. Der Name des zwischengespeicherten Inhalts, der als Kontext für die Bereitstellung der Vorhersage verwendet werden soll. Format: cachedContents/{cachedContent}

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

Methode: models.asyncBatchEmbedContent

Stellt einen Batch von models.embedContent-Anfragen für die Batchverarbeitung in die Warteschlange. Wir haben einen models.batchEmbedContents-Handler in GenerativeService, aber er wurde synchronisiert. Um Verwirrung zu vermeiden, nennen wir sie Async.

Endpunkt

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

Pfadparameter

batch.model string

Erforderlich. Der Name des Model, der zum Generieren der Vervollständigung verwendet werden soll.

Format: models/{model}. Sie hat die Form models/{model}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

Felder
batch.name string

Nur Ausgabe. ID. Ressourcenname des Batches.

Format: batches/{batchId}.

batch.displayName string

Erforderlich. Der benutzerdefinierte Name dieses Batches.

batch.inputConfig object (InputEmbedContentConfig)

Erforderlich. Eingabekonfiguration der Instanzen, auf denen die Batchverarbeitung ausgeführt wird.

batch.output object (EmbedContentBatchOutput)

Nur Ausgabe. Die Ausgabe der Batchanfrage.

batch.createTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Batchverarbeitung abgeschlossen wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

batch.batchStats object (EmbedContentBatchStats)

Nur Ausgabe. Statistiken zum Batch.

batch.state enum (BatchState)

Nur Ausgabe. Der Status des Batches.

batch.priority string (int64 format)

Optional. Die Priorität des Batches. Batches mit einem höheren Prioritätswert werden vor Batches mit einem niedrigeren Prioritätswert verarbeitet. Negative Werte sind zulässig. Der Standardwert ist 0.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

EmbedContentRequest

Anfrage mit dem Content für das einzubettende Modell.

Felder
model string

Erforderlich. Der Ressourcenname des Modells. Dies dient als ID für das zu verwendende Modell.

Dieser Name sollte mit einem Modellnamen übereinstimmen, der von der Methode models.list zurückgegeben wird.

Format: models/{model}

content object (Content)

Erforderlich. Der einzubettende Inhalt. Es werden nur die parts.text-Felder gezählt.

taskType enum (TaskType)

Optional. Optionaler Aufgabentyp, für den die Einbettungen verwendet werden. Wird auf älteren Modellen (models/embedding-001) nicht unterstützt.

title string

Optional. Ein optionaler Titel für den Text. Gilt nur, wenn TaskType RETRIEVAL_DOCUMENT ist.

Hinweis: Wenn Sie einen title für RETRIEVAL_DOCUMENT angeben, erhalten Sie Einbettungen mit höherer Qualität für den Abruf.

outputDimensionality integer

Optional. Optionale reduzierte Dimension für die Ausgabe-Einbettung. Wenn festgelegt, werden übermäßige Werte in der Ausgabeeinbettung am Ende abgeschnitten. Wird nur von neueren Modellen ab 2024 unterstützt. Sie können diesen Wert nicht festlegen, wenn Sie das frühere Modell (models/embedding-001) verwenden.

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

Methode: batches.get

Ruft den letzten Status eines lange laufenden Vorgangs ab. Clients können diese Methode nutzen, um die Ergebnisse eines Vorgangs nach gewissen Zeitabständen zu testen, wie vom API-Dienst empfohlen.

Endpunkt

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

Pfadparameter

name string

Der Name der Vorgangsressource. Sie hat die Form batches/{batches}.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Methode: batches.list

Listet Vorgänge auf, die zu dem in der Anfrage angegebenen Filter passen Wenn der Server diese Methode nicht unterstützt, wird UNIMPLEMENTED zurückgegeben.

Endpunkt

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

Pfadparameter

name string

Der Name der übergeordneten Ressource des Vorgangs. Sie hat die Form batches.

Abfrageparameter

filter string

Der Standard-Listenfilter.

pageSize integer

Die Standardgröße der Listenseite

pageToken string

Das Standardtoken der Listenseite

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ListOperationsResponse.

Methode: batches.cancel

Startet den asynchronen Abbruch eines lang andauernden Vorgangs. Der Server unternimmt alles, um den Vorgang abzubrechen, aber der Erfolg kann nicht garantiert werden. Wenn der Server diese Methode nicht unterstützt, wird google.rpc.Code.UNIMPLEMENTED zurückgegeben. Kunden können Operations.GetOperation oder andere Methoden verwenden, um zu prüfen, ob der Abbruch erfolgreich war oder der Vorgang dennoch abgeschlossen wurde. Bei erfolgreichem Abbruch wird der Vorgang nicht gelöscht. Stattdessen wird daraus ein Vorgang mit einem Operation.error-Wert mit einem google.rpc.Status.code von 1, was Code.CANCELLED entspricht.

Endpunkt

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

Pfadparameter

name string

Der Name der abzubrechenden Vorgangsressource Sie hat die Form batches/{batches}.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, ist der Antworttext ein leeres JSON-Objekt.

Methode: batches.delete

Löscht einen lange laufenden Vorgang. Diese Methode zeigt an, dass der Client kein Interesse mehr an dem Ergebnis eines Vorgangs hat. Der Vorgang wird nicht abgebrochen. Wenn der Server diese Methode nicht unterstützt, wird google.rpc.Code.UNIMPLEMENTED zurückgegeben.

Endpunkt

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

Pfadparameter

name string

Der Name der zu löschenden Vorgangsressource. Sie hat die Form batches/{batches}.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, ist der Antworttext ein leeres JSON-Objekt.

GenerateContentBatch

Eine Ressource, die einen Batch von GenerateContent-Anfragen darstellt.

Felder
model string

Erforderlich. Der Name des Model, der zum Generieren der Vervollständigung verwendet werden soll.

Format: models/{model}.

name string

Nur Ausgabe. ID. Ressourcenname des Batches.

Format: batches/{batchId}.

displayName string

Erforderlich. Der benutzerdefinierte Name dieses Batches.

inputConfig object (InputConfig)

Erforderlich. Eingabekonfiguration der Instanzen, auf denen die Batchverarbeitung ausgeführt wird.

output object (GenerateContentBatchOutput)

Nur Ausgabe. Die Ausgabe der Batchanfrage.

createTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Batchverarbeitung abgeschlossen wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

batchStats object (BatchStats)

Nur Ausgabe. Statistiken zum Batch.

state enum (BatchState)

Nur Ausgabe. Der Status des Batches.

priority string (int64 format)

Optional. Die Priorität des Batches. Batches mit einem höheren Prioritätswert werden vor Batches mit einem niedrigeren Prioritätswert verarbeitet. Negative Werte sind zulässig. Der Standardwert ist 0.

JSON-Darstellung 
{
  "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

Konfiguriert die Eingabe für die Batchanfrage.

Felder
source Union type
Erforderlich. Die Quelle der Eingabe. Für source ist nur einer der folgenden Werte zulässig:
fileName string

Der Name des File, der die Eingabeanfragen enthält.

requests object (InlinedRequests)

Die Anfragen, die im Batch verarbeitet werden sollen.

JSON-Darstellung 
{

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

InlinedRequests

Die Anfragen, die im Batch verarbeitet werden sollen, sofern sie als Teil der Batcherstellungsanfrage angegeben werden.

Felder
requests[] object (InlinedRequest)

Erforderlich. Die Anfragen, die im Batch verarbeitet werden sollen.

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

InlinedRequest

Die Anfrage, die im Batch verarbeitet werden soll.

Felder
request object (GenerateContentRequest)

Erforderlich. Die Anfrage, die im Batch verarbeitet werden soll.

metadata object (Struct format)

Optional. Die Metadaten, die der Anfrage zugeordnet werden sollen.

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

GenerateContentBatchOutput

Die Ausgabe einer Batchanfrage. Dieser Wert wird im Feld BatchGenerateContentResponse oder GenerateContentBatch.output zurückgegeben.

Felder
output Union type
Die Ausgabe der Batchanfrage. Für output ist nur einer der folgenden Werte zulässig:
responsesFile string

Nur Ausgabe. Die Datei-ID der Datei mit den Antworten. Die Datei ist eine JSONL-Datei mit einer einzelnen Antwort pro Zeile. Die Antworten sind GenerateContentResponse-Nachrichten im JSON-Format. Die Antworten werden in derselben Reihenfolge wie die Eingabeanfragen verfasst.

inlinedResponses object (InlinedResponses)

Nur Ausgabe. Die Antworten auf die Anfragen im Batch. Wird zurückgegeben, wenn der Batch mit Inline-Anfragen erstellt wurde. Die Antworten werden in derselben Reihenfolge wie die Eingabeanfragen ausgegeben.

JSON-Darstellung 
{

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

InlinedResponses

Die Antworten auf die Anfragen im Batch.

Felder
inlinedResponses[] object (InlinedResponse)

Nur Ausgabe. Die Antworten auf die Anfragen im Batch.

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

InlinedResponse

Die Antwort auf eine einzelne Anfrage im Batch.

Felder
metadata object (Struct format)

Nur Ausgabe. Die Metadaten, die der Anfrage zugeordnet sind.

output Union type
Die Ausgabe der Anfrage. Für output ist nur einer der folgenden Werte zulässig:
error object (Status)

Nur Ausgabe. Der Fehler, der beim Verarbeiten der Anfrage aufgetreten ist.

response object (GenerateContentResponse)

Nur Ausgabe. Die Antwort auf die Anfrage.

JSON-Darstellung 
{
  "metadata": {
    object
  },

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

BatchStats

Statistiken zum Batch.

Felder
requestCount string (int64 format)

Nur Ausgabe. Die Anzahl der Anfragen im Batch.

successfulRequestCount string (int64 format)

Nur Ausgabe. Die Anzahl der Anfragen, die erfolgreich verarbeitet wurden.

failedRequestCount string (int64 format)

Nur Ausgabe. Die Anzahl der Anfragen, die nicht verarbeitet werden konnten.

pendingRequestCount string (int64 format)

Nur Ausgabe. Die Anzahl der Anfragen, die noch nicht verarbeitet wurden.

JSON-Darstellung 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

EmbedContentBatch

Eine Ressource, die einen Batch von EmbedContent-Anfragen darstellt.

Felder
model string

Erforderlich. Der Name des Model, der zum Generieren der Vervollständigung verwendet werden soll.

Format: models/{model}.

name string

Nur Ausgabe. ID. Ressourcenname des Batches.

Format: batches/{batchId}.

displayName string

Erforderlich. Der benutzerdefinierte Name dieses Batches.

inputConfig object (InputEmbedContentConfig)

Erforderlich. Eingabekonfiguration der Instanzen, auf denen die Batchverarbeitung ausgeführt wird.

output object (EmbedContentBatchOutput)

Nur Ausgabe. Die Ausgabe der Batchanfrage.

createTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Batchverarbeitung abgeschlossen wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

batchStats object (EmbedContentBatchStats)

Nur Ausgabe. Statistiken zum Batch.

state enum (BatchState)

Nur Ausgabe. Der Status des Batches.

priority string (int64 format)

Optional. Die Priorität des Batches. Batches mit einem höheren Prioritätswert werden vor Batches mit einem niedrigeren Prioritätswert verarbeitet. Negative Werte sind zulässig. Der Standardwert ist 0.

JSON-Darstellung 
{
  "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

Konfiguriert die Eingabe für die Batchanfrage.

Felder
source Union type
Erforderlich. Die Quelle der Eingabe. Für source ist nur einer der folgenden Werte zulässig:
fileName string

Der Name des File, der die Eingabeanfragen enthält.

requests object (InlinedEmbedContentRequests)

Die Anfragen, die im Batch verarbeitet werden sollen.

JSON-Darstellung 
{

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

InlinedEmbedContentRequests

Die Anfragen, die im Batch verarbeitet werden sollen, sofern sie als Teil der Batcherstellungsanfrage angegeben werden.

Felder
requests[] object (InlinedEmbedContentRequest)

Erforderlich. Die Anfragen, die im Batch verarbeitet werden sollen.

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

InlinedEmbedContentRequest

Die Anfrage, die im Batch verarbeitet werden soll.

Felder
request object (EmbedContentRequest)

Erforderlich. Die Anfrage, die im Batch verarbeitet werden soll.

metadata object (Struct format)

Optional. Die Metadaten, die der Anfrage zugeordnet werden sollen.

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

EmbedContentBatchOutput

Die Ausgabe einer Batchanfrage. Dieser Wert wird im Feld AsyncBatchEmbedContentResponse oder EmbedContentBatch.output zurückgegeben.

Felder
output Union type
Die Ausgabe der Batchanfrage. Für output ist nur einer der folgenden Werte zulässig:
responsesFile string

Nur Ausgabe. Die Datei-ID der Datei mit den Antworten. Die Datei ist eine JSONL-Datei mit einer einzelnen Antwort pro Zeile. Die Antworten sind EmbedContentResponse-Nachrichten im JSON-Format. Die Antworten werden in derselben Reihenfolge wie die Eingabeanfragen verfasst.

inlinedResponses object (InlinedEmbedContentResponses)

Nur Ausgabe. Die Antworten auf die Anfragen im Batch. Wird zurückgegeben, wenn der Batch mit Inline-Anfragen erstellt wurde. Die Antworten werden in derselben Reihenfolge wie die Eingabeanfragen ausgegeben.

JSON-Darstellung 
{

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

InlinedEmbedContentResponses

Die Antworten auf die Anfragen im Batch.

Felder
inlinedResponses[] object (InlinedEmbedContentResponse)

Nur Ausgabe. Die Antworten auf die Anfragen im Batch.

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

InlinedEmbedContentResponse

Die Antwort auf eine einzelne Anfrage im Batch.

Felder
metadata object (Struct format)

Nur Ausgabe. Die Metadaten, die der Anfrage zugeordnet sind.

output Union type
Die Ausgabe der Anfrage. Für output ist nur einer der folgenden Werte zulässig:
error object (Status)

Nur Ausgabe. Der Fehler, der beim Verarbeiten der Anfrage aufgetreten ist.

response object (EmbedContentResponse)

Nur Ausgabe. Die Antwort auf die Anfrage.

JSON-Darstellung 
{
  "metadata": {
    object
  },

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

EmbedContentBatchStats

Statistiken zum Batch.

Felder
requestCount string (int64 format)

Nur Ausgabe. Die Anzahl der Anfragen im Batch.

successfulRequestCount string (int64 format)

Nur Ausgabe. Die Anzahl der Anfragen, die erfolgreich verarbeitet wurden.

failedRequestCount string (int64 format)

Nur Ausgabe. Die Anzahl der Anfragen, die nicht verarbeitet werden konnten.

pendingRequestCount string (int64 format)

Nur Ausgabe. Die Anzahl der Anfragen, die noch nicht verarbeitet wurden.

JSON-Darstellung 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

BatchState

Der Status des Batches.

Enums
BATCH_STATE_UNSPECIFIED Der Batchstatus ist nicht angegeben.
BATCH_STATE_PENDING Der Dienst bereitet die Ausführung des Batches vor.
BATCH_STATE_RUNNING Der Batch wird gerade verarbeitet.
BATCH_STATE_SUCCEEDED Der Batch wurde erfolgreich abgeschlossen.
BATCH_STATE_FAILED Der Batch ist fehlgeschlagen.
BATCH_STATE_CANCELLED Der Batch wurde abgebrochen.
BATCH_STATE_EXPIRED Die Charge ist abgelaufen.

REST-Ressource: batches

Ressource: Vorgang

Diese Ressource steht für einen lange laufenden Vorgang, der das Ergebnis eines Netzwerk-API-Aufrufs ist.

Felder
name string

Der vom Server zugewiesene Name, der nur innerhalb des Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte name ein Ressourcenname sein, der auf operations/{unique_id} endet.

metadata object

Dienstspezifische Metadaten, die mit dem Vorgang verknüpft sind. Typischerweise enthalten sie Informationen zum Verlauf und gemeinsame Metadaten wie den Erstellungszeitpunkt. Solche Metadaten werden nicht von allen Diensten bereitgestellt. Jede Methode, die einen lange laufenden Vorgang zurückgibt, sollte gegebenenfalls den Metadatentyp dokumentieren.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Ist der Wert false, bedeutet das, dass der Vorgang noch läuft. Ist der Wert hingegen true, ist der Vorgang abgeschlossen und entweder error oder response ist verfügbar.

result Union type
Das Ergebnis des Vorgangs kann entweder ein error oder eine gültige response sein. Wenn done = false ist, wird weder error noch response festgelegt. Wenn done = true ist, kann genau ein error oder eine response festgelegt werden. Einige Dienste stellen das Ergebnis möglicherweise nicht bereit. Für result ist nur einer der folgenden Werte zulässig:
error object (Status)

Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs.

response object

Die normale, erfolgreiche Antwort des Vorgangs. Wenn die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, wie bei Delete, lautet die Antwort google.protobuf.Empty. Ist die ursprüngliche Methode standardmäßig Get/Create/Update, sollte die Antwort die Ressource sein. Bei anderen Methoden sollte die Antwort vom Typ XxxResponse sein, wobei Xxx der Name der ursprünglichen Methode ist. Wenn zum Beispiel der Name der ursprünglichen Methode TakeSnapshot() ist, ist der gefolgerte Antworttyp TakeSnapshotResponse.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

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

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