Method: models.streamGenerateContent

Genera una risposta in modalità flusso dal modello a cui è stato assegnato un input GenerateContentRequest.

Richiesta HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:streamGenerateContent

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
model

string

Obbligatoria. Il nome del campo Model da utilizzare per generare il completamento.

Formato: name=models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

object (Content)

Obbligatoria. I contenuti della conversazione corrente con il modello.

Per le query a turno singolo, si tratta di una singola istanza. Per le query in più passaggi, si tratta di un campo ripetuto contenente la cronologia delle conversazioni e l'ultima richiesta.

tools[]

object (Tool)

Campo facoltativo. Un elenco di Tools che il modello potrebbe utilizzare per generare la risposta successiva.

Un'Tool è una porzione di codice che consente al sistema di interagire con sistemi esterni per eseguire un'azione o un insieme di azioni, al di fuori della conoscenza e dell'ambito del modello. Attualmente l'unico strumento supportato è Function.

toolConfig

object (ToolConfig)

Campo facoltativo. Configurazione dello strumento per qualsiasi Tool specificato nella richiesta.

safetySettings[]

object (SafetySetting)

Campo facoltativo. Un elenco di istanze SafetySetting univoche per il blocco di contenuti non sicuri.

Questa impostazione verrà applicata a GenerateContentRequest.contents e GenerateContentResponse.candidates. Non deve esistere 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 nelle Impostazioni di sicurezza. Se nell'elenco non è specificato alcun valore SafetySetting per un determinato SafetyCategory, l'API utilizzerà l'impostazione di sicurezza predefinita per quella categoria. Le categorie di danni HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT e HARM_CATEGORY_HARASSMENT sono supportate.

systemInstruction

object (Content)

Campo facoltativo. Istruzione di sistema impostata dallo sviluppatore. Al momento solo di testo.

generationConfig

object (GenerationConfig)

Campo facoltativo. Opzioni di configurazione per la generazione e gli output del modello.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un flusso di GenerateContentResponse istanze.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.