Batch Mode

Interfejs Gemini API obsługuje tryb wsadowy, który umożliwia przetwarzanie wielu żądań w ramach jednego wywołania. Więcej informacji znajdziesz w przewodniku po trybie wsadowym.

Metoda: models.batchGenerateContent

Dodaje do kolejki partię żądań models.generateContent do przetwarzania wsadowego.

Punkt końcowy

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

Parametry ścieżki

batch.model string

Wymagane. Nazwa Model, która ma być użyta do wygenerowania dokończenia.

Format: models/{model}. Ma on postać models/{model}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Pola
batch.name string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu pakietu.

Format: batches/{batch_id}.

batch.displayName string

Wymagane. Nazwa tego pakietu zdefiniowana przez użytkownika.

batch.inputConfig object (InputConfig)

Wymagane. Konfiguracja wejściowa instancji, na których wykonywane jest przetwarzanie wsadowe.

batch.output object (GenerateContentBatchOutput)

Tylko dane wyjściowe. Dane wyjściowe żądania zbiorczego.

batch.createTime string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia partii.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Tylko dane wyjściowe. Godzina zakończenia przetwarzania wsadowego.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji pakietu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

batch.batchStats object (BatchStats)

Tylko dane wyjściowe. Statystyki dotyczące partii.

batch.state enum (BatchState)

Tylko dane wyjściowe. Stan wsadu.

batch.priority string (int64 format)

Opcjonalnie: Priorytet zadania wsadowego. Partie o wyższej wartości priorytetu będą przetwarzane przed partiami o niższej wartości priorytetu. Dozwolone są wartości ujemne. Wartość domyślna to 0.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation.

GenerateContentRequest

Wysyłanie do modelu żądania wygenerowania dokończenia.

Pola
model string

Wymagane. Nazwa Model, która ma być użyta do wygenerowania dokończenia.

Format: models/{model}.

contents[] object (Content)

Wymagane. Treść bieżącej rozmowy z modelem.

W przypadku zapytań jednorazowych jest to pojedyncza instancja. W przypadku zapytań wieloetapowych, takich jak czat, jest to pole powtarzane, które zawiera historię rozmowy i najnowsze żądanie.

tools[] object (Tool)

Opcjonalnie: Lista Tools, której Model może użyć do wygenerowania następnej odpowiedzi.

Tool to fragment kodu, który umożliwia systemowi interakcję z systemami zewnętrznymi w celu wykonania działania lub zestawu działań wykraczających poza wiedzę i zakres Model. Obsługiwane Tool to Function i codeExecution. Więcej informacji znajdziesz w przewodnikach Wywoływanie funkcji i Wykonywanie kodu.

toolConfig object (ToolConfig)

Opcjonalnie: Konfiguracja narzędzia dla dowolnego Tool określonego w żądaniu. Przykład użycia znajdziesz w przewodniku po wywoływaniu funkcji.

safetySettings[] object (SafetySetting)

Opcjonalnie: Lista unikalnych SafetySetting instancji do blokowania niebezpiecznych treści.

Będzie to egzekwowane w przypadku GenerateContentRequest.contents i GenerateContentResponse.candidates. Nie powinno być więcej niż 1 ustawienia dla każdego typu SafetyCategory. Interfejs API będzie blokować treści i odpowiedzi, które nie spełniają progów określonych w tych ustawieniach. Ta lista zastępuje domyślne ustawienia każdego parametru SafetyCategory określonego w ustawieniach bezpieczeństwa. Jeśli na liście nie ma wartości SafetySetting dla danego parametru SafetyCategory, interfejs API użyje domyślnego ustawienia bezpieczeństwa dla tej kategorii. Obsługiwane są kategorie szkodliwych treści HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Szczegółowe informacje o dostępnych ustawieniach bezpieczeństwa znajdziesz w przewodniku. Zapoznaj się też z wskazówkami dotyczącymi bezpieczeństwa, aby dowiedzieć się, jak uwzględniać kwestie bezpieczeństwa w aplikacjach AI.

systemInstruction object (Content)

Opcjonalnie: Deweloper ustawił instrukcje systemowe. Obecnie tylko tekst.

generationConfig object (GenerationConfig)

Opcjonalnie: Opcje konfiguracji generowania modelu i danych wyjściowych.

cachedContent string

Opcjonalnie: Nazwa treści w pamięci podręcznej, która ma być używana jako kontekst do wyświetlania prognozy. Format: cachedContents/{cachedContent}

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

GenerateContentBatch

Zasób reprezentujący partię żądań GenerateContent.

Pola
model string

Wymagane. Nazwa Model, która ma być użyta do wygenerowania dokończenia.

Format: models/{model}.

name string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu pakietu.

Format: batches/{batch_id}.

displayName string

Wymagane. Nazwa tego pakietu zdefiniowana przez użytkownika.

inputConfig object (InputConfig)

Wymagane. Konfiguracja wejściowa instancji, na których wykonywane jest przetwarzanie wsadowe.

output object (GenerateContentBatchOutput)

Tylko dane wyjściowe. Dane wyjściowe żądania zbiorczego.

createTime string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia partii.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Tylko dane wyjściowe. Godzina zakończenia przetwarzania wsadowego.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji pakietu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

batchStats object (BatchStats)

Tylko dane wyjściowe. Statystyki dotyczące partii.

state enum (BatchState)

Tylko dane wyjściowe. Stan wsadu.

priority string (int64 format)

Opcjonalnie: Priorytet zadania wsadowego. Partie o wyższej wartości priorytetu będą przetwarzane przed partiami o niższej wartości priorytetu. Dozwolone są wartości ujemne. Wartość domyślna to 0.

Zapis 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

Konfiguruje dane wejściowe żądania zbiorczego.

Pola
source Union type
Wymagane. Źródło danych wejściowych. Pole source może mieć tylko jedną z tych wartości:
fileName string

Nazwa File zawierającego żądania wejściowe.

requests object (InlinedRequests)

Żądania do przetworzenia w partii.

Zapis JSON 
{

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

InlinedRequests

Żądania, które mają być przetwarzane w ramach pakietu, jeśli zostały podane w żądaniu utworzenia pakietu.

Pola
requests[] object (InlinedRequest)

Wymagane. Żądania do przetworzenia w partii.

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

InlinedRequest

Żądanie do przetworzenia w ramach pakietu.

Pola
request object (GenerateContentRequest)

Wymagane. Żądanie do przetworzenia w ramach pakietu.

metadata object (Struct format)

Opcjonalnie: Metadane, które mają być powiązane z żądaniem.

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

GenerateContentBatchOutput

Dane wyjściowe żądania zbiorczego. Jest ona zwracana w polu BatchGenerateContentResponse lub GenerateContentBatch.output.

Pola
output Union type
Dane wyjściowe żądania zbiorczego. Pole output może mieć tylko jedną z tych wartości:
responsesFile string

Tylko dane wyjściowe. Identyfikator pliku zawierającego odpowiedzi. Plik będzie miał format JSONL i będzie zawierać po jednej odpowiedzi w wierszu. Odpowiedzi będą miały postać wiadomości GenerateContentResponse w formacie JSON. Odpowiedzi będą zapisywane w tej samej kolejności co żądania wejściowe.

inlinedResponses object (InlinedResponses)

Tylko dane wyjściowe. Odpowiedzi na żądania w pakiecie. Zwracany, gdy pakiet został utworzony przy użyciu żądań wbudowanych. Odpowiedzi będą w tej samej kolejności co żądania wejściowe.

Zapis JSON 
{

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

InlinedResponses

Odpowiedzi na żądania w pakiecie.

Pola
inlinedResponses[] object (InlinedResponse)

Tylko dane wyjściowe. Odpowiedzi na żądania w pakiecie.

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

InlinedResponse

Odpowiedź na pojedyncze żądanie w pakiecie.

Pola
metadata object (Struct format)

Tylko dane wyjściowe. Metadane powiązane z żądaniem.

output Union type
Wynik żądania. Pole output może mieć tylko jedną z tych wartości:
error object (Status)

Tylko dane wyjściowe. Błąd, który wystąpił podczas przetwarzania żądania.

response object (GenerateContentResponse)

Tylko dane wyjściowe. Odpowiedź na prośbę.

Zapis JSON 
{
  "metadata": {
    object
  },

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

BatchStats

Statystyki dotyczące partii.

Pola
requestCount string (int64 format)

Tylko dane wyjściowe. Liczba żądań w partii.

successfulRequestCount string (int64 format)

Tylko dane wyjściowe. Liczba żądań, które zostały przetworzone.

failedRequestCount string (int64 format)

Tylko dane wyjściowe. Liczba żądań, których nie udało się przetworzyć.

pendingRequestCount string (int64 format)

Tylko dane wyjściowe. Liczba żądań, które nadal oczekują na przetworzenie.

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

BatchState

Stan wsadu.

Wartości w polu enum
BATCH_STATE_UNSPECIFIED Stan zadania wsadowego jest nieokreślony.
BATCH_STATE_PENDING Usługa przygotowuje się do uruchomienia zadania wsadowego.
BATCH_STATE_RUNNING Partia jest w toku.
BATCH_STATE_SUCCEEDED Partia została przetworzona.
BATCH_STATE_FAILED Wsad się nie powiódł.
BATCH_STATE_CANCELLED Partia została anulowana.
BATCH_STATE_EXPIRED Partia wygasła.

Zasób REST: batches

Zasób: Operation

Ten zasób reprezentuje długo trwającą operację, która jest wynikiem wywołania interfejsu API sieci.

Pola
name string

Nazwa przypisana przez serwer, która jest unikalna tylko w ramach tej samej usługi, która ją pierwotnie zwraca. Jeśli używasz domyślnego mapowania HTTP, name powinna być nazwą zasobu kończącą się na operations/{unique_id}.

metadata object

Metadane specyficzne dla usługi powiązane z operacją. Zwykle zawiera informacje o postępach i typowe metadane, takie jak czas utworzenia. Niektóre usługi mogą nie udostępniać takich metadanych. Każda metoda, która zwraca operację długotrwałą, powinna zawierać dokumentację typu metadanych (jeśli występuje).

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI określający typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }

done boolean

Jeśli wartość to false, oznacza to, że operacja jest w toku. Jeśli true, operacja została ukończona i dostępne są wartości error lub response.

result Union type
Wynik operacji, który może być wartością error lub prawidłową wartością response. Jeśli done == false, nie ustawiono ani error, ani response. Jeśli done == true, można ustawić tylko jedną z wartości error lub response. Niektóre usługi mogą nie zwracać wyniku. result może mieć tylko jedną z tych wartości:
error object (Status)

Wynik błędu operacji w przypadku niepowodzenia lub anulowania.

response object

Normalna odpowiedź operacji w przypadku powodzenia. Jeśli oryginalna metoda nie zwraca danych w przypadku powodzenia, np. Delete, odpowiedź to google.protobuf.Empty. Jeśli oryginalna metoda to standardowa metoda Get/Create/Update, odpowiedź powinna być zasobem. W przypadku innych metod odpowiedź powinna mieć typ XxxResponse, gdzie Xxx to oryginalna nazwa metody. Jeśli np. oryginalna nazwa metody to TakeSnapshot(), wywnioskowany typ odpowiedzi to TakeSnapshotResponse.

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI określający typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }

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

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

Metoda: batches.get

Pobiera najnowszy stan długo trwającej operacji. Klienci mogą używać tej metody do sprawdzania wyniku operacji w interwałach zalecanych przez usługę API.

Punkt końcowy

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

Parametry ścieżki

name string

Nazwa zasobu operacji. Ma on postać batches/{batches}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation.

Metoda: batches.list

Wyświetla listę operacji zgodnych z określonym w żądaniu filtrem. Jeśli serwer nie obsługuje tej metody, zwraca wartość UNIMPLEMENTED.

Punkt końcowy

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

Parametry ścieżki

name string

Nazwa zasobu nadrzędnego operacji. Ma on postać batches.

Parametry zapytania

filter string

Standardowy filtr listy.

pageSize integer

Standardowy rozmiar strony listy.

pageToken string

Standardowy token strony z listą.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu ListOperationsResponse.

Metoda: batches.cancel

Rozpoczyna asynchroniczne anulowanie długotrwałej operacji. Serwer podejmuje próbę anulowania operacji, ale nie gwarantuje, że się to uda. Jeśli serwer nie obsługuje tej metody, zwraca wartość google.rpc.Code.UNIMPLEMENTED. Klienci mogą używać metody Operations.GetOperation lub innych metod, aby sprawdzić, czy anulowanie się powiodło lub czy operacja została zakończona pomimo anulowania. Po pomyślnym anulowaniu operacja nie jest usuwana, ale staje się operacją o wartości Operation.error z wartością google.rpc.Status.code równą 1, co odpowiada Code.CANCELLED.

Punkt końcowy

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

Parametry ścieżki

name string

Nazwa zasobu operacji, która ma zostać anulowana. Ma on postać batches/{batches}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pustym obiektem JSON.

Metoda: batches.delete

Usuwa długo trwającą operację. Ta metoda wskazuje, że klient nie jest już zainteresowany wynikiem operacji. Nie anuluje to operacji. Jeśli serwer nie obsługuje tej metody, zwraca wartość google.rpc.Code.UNIMPLEMENTED.

Punkt końcowy

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

Parametry ścieżki

name string

Nazwa zasobu operacji do usunięcia. Ma on postać batches/{batches}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pustym obiektem JSON.