L'API Gemini supporta la generazione di contenuti con immagini, audio, codice, strumenti e altro ancora. Per informazioni dettagliate su ciascuna di queste funzionalità, continua a leggere e consulta il codice campione incentrato sulle attività o leggi le guide complete.
- Generazione di testo
- Vista
- Audio
- Incorporamenti
- Contesto lungo
- Esecuzione di codice
- Modalità JSON
- Chiamata di funzione
- Istruzioni di sistema
Metodo: models.generateContent
- Endpoint
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiesta di esempio
Genera una risposta del modello dato un input GenerateContentRequest. Per informazioni dettagliate sull'utilizzo, consulta la guida alla generazione di testo. Le funzionalità di input variano a seconda dei modelli, inclusi quelli ottimizzati. Per maggiori dettagli, consulta la guida al modello e la guida all'ottimizzazione.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
Parametri del percorso
model
string
Obbligatorio. Il nome del 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:
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 di 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.
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, HARM_CATEGORY_JAILBREAK. Per informazioni dettagliate sulle impostazioni di sicurezza disponibili, consulta la guida. Consulta anche le linee guida per la sicurezza per scoprire come incorporare le considerazioni sulla sicurezza nelle tue applicazioni 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 erogare la previsione. Formato: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
Facoltativo. Il livello di servizio della richiesta.
store
boolean
Facoltativo. Configura il comportamento di logging per una determinata richiesta. Se impostata, ha la precedenza sulla configurazione della registrazione a livello di progetto.
Esempio di richiesta
Testo
Python
Node.js
Go
Conchiglia
Java
Immagine
Python
Node.js
Go
Conchiglia
Java
Audio
Python
Node.js
Go
Conchiglia
Video
Python
Node.js
Go
Conchiglia
Python
Go
Conchiglia
Chat
Python
Node.js
Go
Conchiglia
Java
Cache
Python
Node.js
Go
Modello ottimizzato
Python
Modalità JSON
Python
Node.js
Go
Conchiglia
Java
Eseguire il codice
Python
Go
Java
Chiamata di funzione
Python
Go
Node.js
Conchiglia
Java
Configurazione della generazione
Python
Node.js
Go
Conchiglia
Java
Impostazioni di sicurezza
Python
Node.js
Go
Conchiglia
Java
Istruzione di sistema
Python
Node.js
Go
Conchiglia
Java
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di GenerateContentResponse.
Metodo: models.streamGenerateContent
- Endpoint
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiesta di esempio
Genera una risposta in streaming dal modello dato un input GenerateContentRequest.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
Parametri del percorso
model
string
Obbligatorio. Il nome del 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:
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 di 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.
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, HARM_CATEGORY_JAILBREAK. Per informazioni dettagliate sulle impostazioni di sicurezza disponibili, consulta la guida. Consulta anche le linee guida per la sicurezza per scoprire come incorporare le considerazioni sulla sicurezza nelle tue applicazioni 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 erogare la previsione. Formato: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
Facoltativo. Il livello di servizio della richiesta.
store
boolean
Facoltativo. Configura il comportamento di logging per una determinata richiesta. Se impostata, ha la precedenza sulla configurazione della registrazione a livello di progetto.
Esempio di richiesta
Testo
Python
Node.js
Go
Conchiglia
Java
Immagine
Python
Node.js
Go
Conchiglia
Java
Audio
Python
Go
Conchiglia
Video
Python
Node.js
Go
Conchiglia
Python
Go
Conchiglia
Chat
Python
Node.js
Go
Conchiglia
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un flusso di istanze GenerateContentResponse.
GenerateContentResponse
Risposta del modello che supporta più risposte candidate.
Le valutazioni di sicurezza e il filtro dei contenuti vengono segnalati sia per il prompt in GenerateContentResponse.prompt_feedback sia per ogni candidato in finishReason e in safetyRatings. L'API: - Restituisce tutti i candidati richiesti o nessuno - Non restituisce alcun candidato solo se si è verificato un problema con il prompt (controlla promptFeedback) - Riporta il feedback su ogni candidato in finishReason e safetyRatings.
candidates[]
object (Candidate)
Risposte candidate del modello.
promptFeedback
object (PromptFeedback)
Restituisce il feedback del prompt relativo ai filtri dei contenuti.
usageMetadata
object (UsageMetadata)
Solo output. Metadati sull'utilizzo dei token delle richieste di generazione.
modelVersion
string
Solo output. La versione del modello utilizzata per generare la risposta.
responseId
string
Solo output. responseId viene utilizzato per identificare ogni risposta.
modelStatus
object (ModelStatus)
Solo output. Lo stato attuale del modello.
| Rappresentazione JSON |
|---|
{ "candidates": [ { object ( |
PromptFeedback
Un insieme di metadati del feedback specificati nel prompt in GenerateContentRequest.content.
blockReason
enum (BlockReason)
Facoltativo. Se impostato, il prompt è stato bloccato e non vengono restituiti candidati. Riformula il prompt.
safetyRatings[]
object (SafetyRating)
Valutazioni della sicurezza del prompt. È presente al massimo una classificazione per categoria.
| Rappresentazione JSON |
|---|
{ "blockReason": enum ( |
BlockReason
Specifica il motivo per cui la richiesta è stata bloccata.
| Enum | |
|---|---|
BLOCK_REASON_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
SAFETY |
Il prompt è stato bloccato per motivi di sicurezza. Ispeziona safetyRatings per capire da quale categoria di sicurezza è stato bloccato. |
OTHER |
Il prompt è stato bloccato per motivi sconosciuti. |
BLOCKLIST |
Il prompt è stato bloccato a causa dei termini inclusi nell'elenco bloccato della terminologia. |
PROHIBITED_CONTENT |
Il prompt è stato bloccato a causa di contenuti vietati. |
IMAGE_SAFETY |
Candidati bloccati a causa di contenuti di generazione di immagini non sicuri. |
UsageMetadata
Metadati sull'utilizzo dei token della richiesta di generazione.
promptTokenCount
integer
Numero di token nel prompt. Quando cachedContent è impostato, questa è comunque la dimensione effettiva totale del prompt, il che significa che include il numero di token nei contenuti memorizzati nella cache.
cachedContentTokenCount
integer
Numero di token nella parte memorizzata nella cache del prompt (i contenuti memorizzati nella cache)
candidatesTokenCount
integer
Numero totale di token in tutte le risposte candidate generate.
toolUsePromptTokenCount
integer
Solo output. Numero di token presenti nei prompt di utilizzo degli strumenti.
thoughtsTokenCount
integer
Solo output. Numero di token di pensieri per i modelli di pensiero.
totalTokenCount
integer
Il conteggio totale dei token per la richiesta di generazione (prompt + pensieri + candidati alla risposta).
promptTokensDetails[]
object (ModalityTokenCount)
Solo output. Elenco delle modalità elaborate nell'input della richiesta.
cacheTokensDetails[]
object (ModalityTokenCount)
Solo output. Elenco delle modalità dei contenuti memorizzati nella cache nell'input della richiesta.
candidatesTokensDetails[]
object (ModalityTokenCount)
Solo output. Elenco delle modalità restituite nella risposta.
toolUsePromptTokensDetails[]
object (ModalityTokenCount)
Solo output. Elenco delle modalità elaborate per gli input delle richieste di utilizzo degli strumenti.
serviceTier
enum (ServiceTier)
Solo output. Livello di servizio della richiesta.
| Rappresentazione JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
ModelStatus
Lo stato del modello sottostante. Viene utilizzato per indicare la fase del modello sottostante e l'ora di ritiro, se applicabile.
modelStage
enum (ModelStage)
La fase del modello sottostante.
retirementTime
string (Timestamp format)
L'ora in cui il modello verrà ritirato.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".
message
string
Un messaggio che spiega lo stato del modello.
| Rappresentazione JSON |
|---|
{
"modelStage": enum ( |
ModelStage
Definisce la fase del modello sottostante.
| Enum | |
|---|---|
MODEL_STAGE_UNSPECIFIED |
Fase del modello non specificata. |
UNSTABLE_EXPERIMENTAL |
Il modello sottostante è soggetto a molte ottimizzazioni. |
EXPERIMENTAL |
I modelli in questa fase sono solo a scopo sperimentale. |
PREVIEW |
I modelli in questa fase sono più maturi rispetto a quelli sperimentali. |
STABLE |
I modelli in questa fase sono considerati stabili e pronti per l'uso in produzione. |
LEGACY |
Se il modello si trova in questa fase, significa che verrà ritirato nel prossimo futuro. Solo i clienti esistenti possono utilizzare questo modello. |
DEPRECATED |
I modelli in questa fase sono deprecati. Questi modelli non possono essere utilizzati. |
RETIRED |
I modelli in questa fase vengono ritirati. Questi modelli non possono essere utilizzati. |
Candidato
- Rappresentazione JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- Immagine
- RetrievedContext
- CustomMetadata
- StringList
- Maps
- PlaceAnswerSources
- ReviewSnippet
- GroundingSupport
- Segmento
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- Candidato
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
Una risposta candidata generata dal modello.
content
object (Content)
Solo output. Contenuti generati restituiti dal modello.
finishReason
enum (FinishReason)
Facoltativo. Solo output. Il motivo per cui il modello ha smesso di generare token.
Se è vuoto, il modello non ha interrotto la generazione di token.
safetyRatings[]
object (SafetyRating)
Elenco delle valutazioni per la sicurezza di una risposta candidata.
È presente al massimo una classificazione per categoria.
citationMetadata
object (CitationMetadata)
Solo output. Informazioni sulla citazione per il candidato generato dal modello.
Questo campo può essere compilato con informazioni sulla recitazione per qualsiasi testo incluso in content. Si tratta di passaggi "recitati" da materiale protetto da copyright nei dati di addestramento del modello LLM di base.
tokenCount
integer
Solo output. Conteggio dei token per questo candidato.
groundingAttributions[]
object (GroundingAttribution)
Solo output. Informazioni sull'attribuzione delle fonti che hanno contribuito a una risposta basata sui dati.
Questo campo viene compilato per le chiamate GenerateAnswer.
groundingMetadata
object (GroundingMetadata)
Solo output. Metadati di base per il candidato.
Questo campo viene compilato per le chiamate GenerateContent.
avgLogprobs
number
Solo output. Punteggio di probabilità logaritmica medio del candidato.
logprobsResult
object (LogprobsResult)
Solo output. Punteggi di log-verosimiglianza per i token di risposta e i token principali
urlContextMetadata
object (UrlContextMetadata)
Solo output. Metadati relativi allo strumento di recupero del contesto URL.
index
integer
Solo output. Indice del candidato nell'elenco dei candidati per la risposta.
finishMessage
string
Facoltativo. Solo output. Specifica il motivo per cui il modello ha smesso di generare token. Questo campo viene compilato solo quando è impostato finishReason.
| Rappresentazione JSON |
|---|
{ "content": { object ( |
FinishReason
Definisce il motivo per cui il modello ha smesso di generare token.
| Enum | |
|---|---|
FINISH_REASON_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
STOP |
Punto di interruzione naturale del modello o sequenza di interruzione fornita. |
MAX_TOKENS |
È stato raggiunto il numero massimo di token specificato nella richiesta. |
SAFETY |
I contenuti della risposta candidata sono stati segnalati per motivi di sicurezza. |
RECITATION |
I contenuti del candidato alla risposta sono stati segnalati per motivi di recitazione. |
LANGUAGE |
I contenuti della risposta candidata sono stati segnalati per l'utilizzo di una lingua non supportata. |
OTHER |
Motivo sconosciuto. |
BLOCKLIST |
La generazione di token è stata interrotta perché i contenuti includono termini vietati. |
PROHIBITED_CONTENT |
La generazione di token è stata interrotta perché potrebbero contenere contenuti vietati. |
SPII |
La generazione di token è stata interrotta perché i contenuti potrebbero contenere informazioni sensibili che consentono l'identificazione personale (SPII). |
MALFORMED_FUNCTION_CALL |
La chiamata di funzione generata dal modello non è valida. |
IMAGE_SAFETY |
La generazione di token è stata interrotta perché le immagini generate contengono violazioni della sicurezza. |
IMAGE_PROHIBITED_CONTENT |
La generazione di immagini è stata interrotta perché le immagini generate contengono altri contenuti vietati. |
IMAGE_OTHER |
La generazione di immagini è stata interrotta a causa di un altro problema generico. |
NO_IMAGE |
Il modello avrebbe dovuto generare un'immagine, ma non ne è stata generata nessuna. |
IMAGE_RECITATION |
La generazione di immagini è stata interrotta a causa della recitazione. |
UNEXPECTED_TOOL_CALL |
Il modello ha generato una chiamata di strumento, ma non sono stati abilitati strumenti nella richiesta. |
TOO_MANY_TOOL_CALLS |
Il modello ha chiamato troppi strumenti consecutivamente, quindi il sistema ha interrotto l'esecuzione. |
MISSING_THOUGHT_SIGNATURE |
Nella richiesta manca almeno una firma del pensiero. |
MALFORMED_RESPONSE |
Terminato a causa di una risposta con formato non valido. |
ESCALATION |
La richiesta è stata filtrata da una regola di riassegnazione. |
GroundingAttribution
Attribuzione di una fonte che ha contribuito a una risposta.
sourceId
object (AttributionSourceId)
Solo output. Identificatore dell'origine che contribuisce a questa attribuzione.
content
object (Content)
Contenuti dell'origine di base che compongono questa attribuzione.
| Rappresentazione JSON |
|---|
{ "sourceId": { object ( |
AttributionSourceId
Identificatore dell'origine che contribuisce a questa attribuzione.
source
Union type
source può essere solo uno dei seguenti tipi:groundingPassage
object (GroundingPassageId)
Identificatore di un passaggio in linea.
semanticRetrieverChunk
object (SemanticRetrieverChunk)
Identificatore di un Chunk recuperato tramite Semantic Retriever.
| Rappresentazione JSON |
|---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
Identificatore di una parte all'interno di un GroundingPassage.
passageId
string
Solo output. ID del passaggio corrispondente al GroundingPassage.id del GenerateAnswerRequest.
partIndex
integer
Solo output. Indice della parte all'interno di GroundingPassage.content di GenerateAnswerRequest.
| Rappresentazione JSON |
|---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
Identificatore di un Chunk recuperato tramite Semantic Retriever specificato in GenerateAnswerRequest utilizzando SemanticRetrieverConfig.
source
string
Solo output. Il nome dell'origine corrispondente al valore SemanticRetrieverConfig.source della richiesta. Esempio: corpora/123 o corpora/123/documents/abc
chunk
string
Solo output. Nome di Chunk contenente il testo attribuito. Esempio: corpora/123/documents/abc/chunks/xyz
| Rappresentazione JSON |
|---|
{ "source": string, "chunk": string } |
GroundingMetadata
Metadati restituiti al client quando è abilitata la base.
groundingChunks[]
object (GroundingChunk)
Elenco dei riferimenti di supporto recuperati dall'origine di grounding specificata. Durante lo streaming, contiene solo i chunk di grounding che non sono stati inclusi nei metadati di grounding delle risposte precedenti.
groundingSupports[]
object (GroundingSupport)
Elenco del supporto per il grounding.
webSearchQueries[]
string
Query di ricerca web per la ricerca web successiva.
imageSearchQueries[]
string
Query di ricerca immagini utilizzate per il grounding.
searchEntryPoint
object (SearchEntryPoint)
Facoltativo. Voce della Ricerca Google per le ricerche sul web successive.
retrievalMetadata
object (RetrievalMetadata)
Metadati relativi al recupero nel flusso di grounding.
googleMapsWidgetContextToken
string
Facoltativo. Nome della risorsa del token di contesto del widget Google Maps che può essere utilizzato con il widget PlacesContextElement per eseguire il rendering dei dati contestuali. Viene compilato solo se è attivato il grounding con Google Maps.
| Rappresentazione JSON |
|---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Punto di accesso alla Ricerca Google.
renderedContent
string
Facoltativo. Snippet di contenuti web che può essere incorporato in una pagina web o in una webview di un'app.
sdkBlob
string (bytes format)
Facoltativo. JSON codificato in base64 che rappresenta l'array di tuple <termine di ricerca, URL di ricerca>.
Una stringa con codifica in base64.
| Rappresentazione JSON |
|---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
Un GroundingChunk rappresenta un segmento di prove a sostegno che giustificano la risposta del modello. Può trattarsi di un frammento del web, di un contesto recuperato da un file o di informazioni di Google Maps.
chunk_type
Union type
chunk_type può essere solo uno dei seguenti tipi:web
object (Web)
Chunk di grounding dal web.
image
object (Image)
Facoltativo. Chunk di fondatezza della ricerca immagini.
retrievedContext
object (RetrievedContext)
Facoltativo. Chunk di grounding dal contesto recuperato dallo strumento di ricerca dei file.
maps
object (Maps)
Facoltativo. Chunk di grounding da Google Maps.
| Rappresentazione JSON |
|---|
{ // chunk_type "web": { object ( |
Web
Brano dal web.
uri
string
Solo output. Riferimento URI del blocco.
title
string
Solo output. Il titolo del segmento.
| Rappresentazione JSON |
|---|
{ "uri": string, "title": string } |
Immagine
Chunk dalla ricerca immagini.
sourceUri
string
L'URI della pagina web per l'attribuzione.
imageUri
string
L'URL dell'asset immagine.
title
string
Il titolo della pagina web da cui proviene l'immagine.
domain
string
Il dominio principale della pagina web da cui proviene l'immagine, ad esempio "example.com".
| Rappresentazione JSON |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
RetrievedContext
Il blocco dal contesto recuperato dallo strumento di ricerca dei file.
customMetadata[]
object (CustomMetadata)
Facoltativo. Metadati forniti dall'utente sul contesto recuperato.
uri
string
Facoltativo. Riferimento URI del documento di recupero semantico.
title
string
Facoltativo. Il titolo del documento.
text
string
Facoltativo. Il testo del segmento.
fileSearchStore
string
Facoltativo. Nome del FileSearchStore contenente il documento. Esempio: fileSearchStores/123
pageNumber
integer
Facoltativo. Numero di pagina del contesto recuperato, se applicabile.
mediaId
string
Facoltativo. Il nome della risorsa blob multimediale per i risultati della ricerca di file multimodali. Formato: fileSearchStores/{file_search_store_id}/media/{blobId}
| Rappresentazione JSON |
|---|
{
"customMetadata": [
{
object ( |
CustomMetadata
Metadati forniti dall'utente relativi a GroundingFact.
key
string
La chiave dei metadati.
value
Union type
value può essere solo uno dei seguenti tipi:stringValue
string
Facoltativo. Il valore stringa dei metadati.
stringListValue
object (StringList)
Facoltativo. Un elenco di valori stringa per i metadati.
numericValue
number
Facoltativo. Il valore numerico dei metadati. L'intervallo previsto per questo valore dipende dal key specifico utilizzato.
| Rappresentazione JSON |
|---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
Un elenco di valori stringa.
values[]
string
I valori stringa dell'elenco.
| Rappresentazione JSON |
|---|
{ "values": [ string ] } |
Maps
Un chunk di grounding di Google Maps. Un blocco di Maps corrisponde a un singolo luogo.
uri
string
Riferimento URI del luogo.
title
string
Titolo del luogo.
text
string
Descrizione testuale della risposta del luogo.
placeId
string
L'ID del luogo, nel formato places/{placeId}. Un utente può utilizzare questo ID per cercare il luogo.
placeAnswerSources
object (PlaceAnswerSources)
Fonti che forniscono risposte sulle caratteristiche di un determinato luogo in Google Maps.
| Rappresentazione JSON |
|---|
{
"uri": string,
"title": string,
"text": string,
"placeId": string,
"placeAnswerSources": {
object ( |
PlaceAnswerSources
Raccolta di fonti che forniscono risposte sulle caratteristiche di un determinato luogo in Google Maps. Ogni messaggio PlaceAnswerSources corrisponde a un luogo specifico in Google Maps. Lo strumento Google Maps ha utilizzato queste fonti per rispondere a domande sulle caratteristiche del luogo (ad es. "Il bar Foo ha il Wi-Fi?" o "Il bar Foo è accessibile alle persone con disabilità motoria?"). Al momento supportiamo solo gli snippet delle recensioni come fonti.
reviewSnippets[]
object (ReviewSnippet)
Snippet di recensioni utilizzati per generare risposte sulle caratteristiche di un determinato luogo in Google Maps.
| Rappresentazione JSON |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
Contiene un estratto di una recensione utente che risponde a una domanda sulle caratteristiche di un luogo specifico in Google Maps.
reviewId
string
L'ID dello snippet recensione.
googleMapsUri
string
Un link che corrisponde alla recensione dell'utente su Google Maps.
title
string
Titolo della recensione.
| Rappresentazione JSON |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
GroundingSupport
Supporto per il grounding.
groundingChunkIndices[]
integer
Facoltativo. Un elenco di indici (in "grounding_chunk" in response.candidate.grounding_metadata) che specificano le citazioni associate alla rivendicazione. Ad esempio, [1,3,4] significa che grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] sono i contenuti recuperati attribuiti all'affermazione. Se la risposta è in streaming, groundingChunkIndices si riferisce agli indici di tutte le risposte. È responsabilità del client accumulare i chunk di grounding di tutte le risposte (mantenendo lo stesso ordine).
confidenceScores[]
number
Facoltativo. Punteggio di confidenza dei riferimenti di supporto. Intervallo da 0 a 1. 1 indica la massima confidenza. Questo elenco deve avere le stesse dimensioni di groundingChunkIndices.
renderedParts[]
integer
Solo output. Indici nel campo parts dei contenuti del candidato. Questi indici specificano quali parti sottoposte a rendering sono associate a questa fonte di supporto.
segment
object (Segment)
Segmento dei contenuti a cui appartiene questo supporto.
| Rappresentazione JSON |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"renderedParts": [
integer
],
"segment": {
object ( |
Segmento
Segmento dei contenuti.
partIndex
integer
L'indice di un oggetto Part all'interno dell'oggetto Content principale.
startIndex
integer
Indice iniziale nella parte specificata, misurato in byte. Offset dall'inizio della parte, incluso, a partire da zero.
endIndex
integer
Indice finale nella parte specificata, misurato in byte. Offset dall'inizio della parte, esclusivo, a partire da zero.
text
string
Il testo corrispondente al segmento della risposta.
| Rappresentazione JSON |
|---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
Metadati relativi al recupero nel flusso di grounding.
googleSearchDynamicRetrievalScore
number
Facoltativo. Punteggio che indica la probabilità che le informazioni della Ricerca Google possano contribuire a rispondere al prompt. Il punteggio è compreso nell'intervallo [0, 1], dove 0 è il meno probabile e 1 è il più probabile. Questo punteggio viene compilato solo quando sono abilitati il grounding della Ricerca Google e il recupero dinamico. Verrà confrontato con la soglia per determinare se attivare la Ricerca Google.
| Rappresentazione JSON |
|---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Risultato Logprobs
topCandidates[]
object (TopCandidates)
Lunghezza = numero totale di passaggi di decodifica.
chosenCandidates[]
object (Candidate)
Lunghezza = numero totale di passaggi di decodifica. I candidati scelti potrebbero essere presenti o meno in topCandidates.
logProbabilitySum
number
Somma delle probabilità logaritmiche per tutti i token.
| Rappresentazione JSON |
|---|
{ "topCandidates": [ { object ( |
TopCandidates
I candidati con le probabilità logaritmiche più alte a ogni passaggio di decodifica.
candidates[]
object (Candidate)
Ordinate in base alla probabilità logaritmica in ordine decrescente.
| Rappresentazione JSON |
|---|
{
"candidates": [
{
object ( |
Candidato
Candidato per il token e il punteggio logprobs.
token
string
Il valore stringa del token del candidato.
tokenId
integer
Il valore dell'ID token del candidato.
logProbability
number
La probabilità logaritmica del candidato.
| Rappresentazione JSON |
|---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
Metadati relativi allo strumento di recupero del contesto URL.
urlMetadata[]
object (UrlMetadata)
Elenco del contesto URL.
| Rappresentazione JSON |
|---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
Contesto del recupero di un singolo URL.
retrievedUrl
string
URL recuperato dallo strumento.
urlRetrievalStatus
enum (UrlRetrievalStatus)
Stato del recupero dell'URL.
| Rappresentazione JSON |
|---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
Stato del recupero dell'URL.
| Enum | |
|---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
URL_RETRIEVAL_STATUS_SUCCESS |
Il recupero dell'URL è riuscito. |
URL_RETRIEVAL_STATUS_ERROR |
Il recupero dell'URL non è riuscito a causa di un errore. |
URL_RETRIEVAL_STATUS_PAYWALL |
Il recupero dell'URL non è riuscito perché i contenuti sono protetti da un paywall. |
URL_RETRIEVAL_STATUS_UNSAFE |
Il recupero dell'URL non è riuscito perché i contenuti non sono sicuri. |
CitationMetadata
Una raccolta di attribuzioni delle fonti per un contenuto.
citationSources[]
object (CitationSource)
Citazioni delle fonti per una risposta specifica.
| Rappresentazione JSON |
|---|
{
"citationSources": [
{
object ( |
CitationSource
Una citazione di una fonte per una parte di una risposta specifica.
startIndex
integer
Facoltativo. Inizio del segmento della risposta attribuito a questa fonte.
L'indice indica l'inizio del segmento, misurato in byte.
endIndex
integer
Facoltativo. Fine del segmento attribuito, escluso.
uri
string
Facoltativo. URI attribuito come fonte per una parte del testo.
license
string
Facoltativo. Licenza per il progetto GitHub attribuito come origine del segmento.
Le informazioni sulla licenza sono obbligatorie per le citazioni di codice.
| Rappresentazione JSON |
|---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
HarmCategory
La categoria di una classificazione.
Queste categorie coprono vari tipi di danni che gli sviluppatori potrebbero voler modificare.
| Enum | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
La categoria non è specificata. |
HARM_CATEGORY_DEROGATORY |
PaLM: commenti negativi o dannosi rivolti all'identità e/o agli attributi protetti. |
HARM_CATEGORY_TOXICITY |
PaLM: contenuti maleducati, irrispettosi o profani. |
HARM_CATEGORY_VIOLENCE |
PaLM: descrive scenari che rappresentano violenza contro un individuo o un gruppo oppure descrizioni generali di scene cruente. |
HARM_CATEGORY_SEXUAL |
PaLM: contiene riferimenti ad atti sessuali o ad altri contenuti osceni. |
HARM_CATEGORY_MEDICAL |
PaLM: promuove consigli medici non verificati. |
HARM_CATEGORY_DANGEROUS |
PaLM: contenuti pericolosi che promuovono, favoriscono o incoraggiano azioni dannose. |
HARM_CATEGORY_HARASSMENT |
Gemini - Contenuti molesti. |
HARM_CATEGORY_HATE_SPEECH |
Gemini: incitamento all'odio e contenuti. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini - Contenuti sessualmente espliciti. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini - Contenuti pericolosi. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini: contenuti che possono essere utilizzati per danneggiare l'integrità civica. DEPRECATO: utilizza enableEnhancedCivicAnswers. |
HARM_CATEGORY_JAILBREAK |
Gemini: prompt che tentano di bypassare o sovvertire le linee guida sulla sicurezza del modello (tentativi di jailbreak). |
ModalityTokenCount
Rappresenta le informazioni sul conteggio dei token per una singola modalità.
modality
enum (Modality)
La modalità associata a questo conteggio dei token.
tokenCount
integer
Numero di token.
| Rappresentazione JSON |
|---|
{
"modality": enum ( |
Modalità
Modalità Parte del contenuto
| Enum | |
|---|---|
MODALITY_UNSPECIFIED |
Modalità non specificata. |
TEXT |
Testo normale. |
IMAGE |
Immagine. |
VIDEO |
Video. |
AUDIO |
Audio. |
DOCUMENT |
Documento, ad esempio PDF. |
SafetyRating
Valutazione di sicurezza per un contenuto.
La valutazione di sicurezza contiene la categoria di danno e il livello di probabilità di danno in quella categoria per un contenuto. I contenuti vengono classificati in base alla sicurezza in diverse categorie di danni e qui è inclusa la probabilità della classificazione del danno.
category
enum (HarmCategory)
Obbligatorio. La categoria per questa classificazione.
probability
enum (HarmProbability)
Obbligatorio. La probabilità di danni per questi contenuti.
blocked
boolean
Questi contenuti sono stati bloccati a causa di questa classificazione?
| Rappresentazione JSON |
|---|
{ "category": enum ( |
HarmProbability
La probabilità che un contenuto sia dannoso.
Il sistema di classificazione indica la probabilità che i contenuti non siano sicuri. Ciò non indica la gravità del danno per un determinato contenuto.
| Enum | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED |
La probabilità non è specificata. |
NEGLIGIBLE |
I contenuti hanno una probabilità trascurabile di essere non sicuri. |
LOW |
I contenuti hanno una bassa probabilità di essere non sicuri. |
MEDIUM |
I contenuti hanno una probabilità media di essere non sicuri. |
HIGH |
I contenuti hanno un'alta probabilità di non essere sicuri. |
SafetySetting
Impostazione di sicurezza che influisce sul comportamento di blocco della sicurezza.
Se superi un'impostazione di sicurezza per una categoria, la probabilità consentita che i contenuti vengano bloccati cambia.
category
enum (HarmCategory)
Obbligatorio. La categoria per questa impostazione.
threshold
enum (HarmBlockThreshold)
Obbligatorio. Controlla la soglia di probabilità in corrispondenza della quale vengono bloccati i danni.
| Rappresentazione JSON |
|---|
{ "category": enum ( |
HarmBlockThreshold
Blocca i contenuti in corrispondenza e al di sopra di una probabilità di danno specificata.
| Enum | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
La soglia non è specificata. |
BLOCK_LOW_AND_ABOVE |
I contenuti con classificazione NEGLIGIBILE saranno consentiti. |
BLOCK_MEDIUM_AND_ABOVE |
I contenuti con classificazione NEGLIGIBILE e BASSA saranno consentiti. |
BLOCK_ONLY_HIGH |
I contenuti con classificazione NEGLIGIBILE, BASSO e MEDIO saranno consentiti. |
BLOCK_NONE |
Tutti i contenuti saranno consentiti. |
OFF |
Disattiva il filtro di sicurezza. |
ServiceTier
Livello di servizio della richiesta.
| Enum | |
|---|---|
unspecified |
Livello di servizio predefinito, ovvero Standard. |
standard |
Livello di servizio Standard. |
flex |
Livello di servizio Flex. |
priority |
Livello di servizio prioritario. |
Contenuti
- Rappresentazione JSON
- Parte
- Blob
- FunctionCall
- FunctionResponse
- FunctionResponsePart
- FunctionResponseBlob
- Pianificazione
- FileData
- ExecutableCode
- Lingua
- CodeExecutionResult
- Risultato
- ToolCall
- ToolType
- ToolResponse
- VideoMetadata
- MediaResolution
- Livello
- MediaProcessing
Il tipo di dati strutturati di base contenente i contenuti in più parti di un messaggio.
Un Content include un campo role che indica il producer del Content e un campo parts contenente dati in più parti che includono il contenuto del turno del messaggio.
parts[]
object (Part)
Parts ordinati che costituiscono un unico messaggio. Le parti possono avere tipi MIME diversi.
role
string
Facoltativo. Il produttore dei contenuti. Deve essere "user" o "model".
Utile per le conversazioni a più turni, altrimenti può essere lasciato vuoto o non impostato.
| Rappresentazione JSON |
|---|
{
"parts": [
{
object ( |
Parte
Un tipo di dati contenente contenuti multimediali che fanno parte di un messaggio Content in più parti.
Un Part è costituito da dati a cui è associato un tipo di dati. Un Part può contenere solo uno dei tipi accettati in Part.data.
Un Part deve avere un tipo MIME IANA fisso che identifichi il tipo e il sottotipo del media se il campo inlineData è compilato con byte non elaborati.
thought
boolean
Facoltativo. Indica se la parte è stata pensata dal modello.
thoughtSignature
string (bytes format)
Facoltativo. Una firma opaca per il pensiero, in modo che possa essere riutilizzato nelle richieste successive.
Una stringa con codifica in base64.
partMetadata
object (Struct format)
Metadati personalizzati associati alla parte. Gli agenti che utilizzano genai.Part come rappresentazione dei contenuti potrebbero dover tenere traccia delle informazioni aggiuntive. Ad esempio, può essere il nome di un file/origine da cui ha origine la parte o un modo per multiplexare più flussi di parti.
mediaResolution
object (MediaResolution)
Facoltativo. Risoluzione dei contenuti multimediali per i contenuti multimediali di input.
mediaProcessing
enum (MediaProcessing)
Facoltativo. Come il modello elabora i contenuti multimediali di questa parte per la comprensione. Significativo solo per le parti video (inlineData o fileData con MIME video). Le parti non video ignorano questo campo.
data
Union type
data può essere solo uno dei seguenti tipi:text
string
Testo in linea.
inlineData
object (Blob)
Byte multimediali in linea.
functionCall
object (FunctionCall)
Un FunctionCall previsto restituito dal modello che contiene una stringa che rappresenta FunctionDeclaration.name con gli argomenti e i relativi valori.
functionResponse
object (FunctionResponse)
L'output del risultato di un FunctionCall che contiene una stringa che rappresenta FunctionDeclaration.name e un oggetto JSON strutturato contenente qualsiasi output della funzione viene utilizzato come contesto per il modello.
fileData
object (FileData)
Dati basati sull'URI.
executableCode
object (ExecutableCode)
Codice generato dal modello che deve essere eseguito.
codeExecutionResult
object (CodeExecutionResult)
Risultato dell'esecuzione di ExecutableCode.
toolCall
object (ToolCall)
Chiamata allo strumento lato server. Questo campo viene compilato quando il modello prevede una chiamata allo strumento che deve essere eseguita sul server. Il client deve restituire questo messaggio all'API.
toolResponse
object (ToolResponse)
L'output di un'esecuzione ToolCall lato server. Questo campo viene compilato dal client con i risultati dell'esecuzione del ToolCall corrispondente.
metadata
Union type
metadata può essere solo uno dei seguenti tipi:videoMetadata
object (VideoMetadata)
Facoltativo. Metadati del video. I metadati devono essere specificati solo mentre i dati video vengono presentati in inlineData o fileData.
| Rappresentazione JSON |
|---|
{ "thought": boolean, "thoughtSignature": string, "partMetadata": { object }, "mediaResolution": { object ( |
Blob
Byte multimediali non elaborati.
Il testo non deve essere inviato come byte non elaborati, utilizza il campo "text".
mimeType
string
Il tipo MIME standard IANA dei dati di origine. Esempi di tipi supportati: - Immagini: image/png, image/jpeg, image/jpg, image/webp, image/heic, image/heif, image/gif, image/avif - Audio: audio/*, video/audio/s16le, video/audio/wav - Video: video/* - Testo: text/plain, text/html, text/css, text/javascript, text/x-typescript, text/csv, text/markdown, text/x-python, text/xml, text/rtf, video/text/timestamp - Applicazioni: application/x-javascript, application/x-typescript, application/x-python-code, application/json, application/x-ipynb+json, application/rtf, application/pdf Per ulteriori informazioni, consulta Formati di file supportati. //
data
string (bytes format)
Byte non elaborati per i formati multimediali.
Una stringa con codifica in base64.
| Rappresentazione JSON |
|---|
{ "mimeType": string, "data": string } |
FunctionCall
Un FunctionCall previsto restituito dal modello che contiene una stringa che rappresenta FunctionDeclaration.name con gli argomenti e i relativi valori.
id
string
Facoltativo. Identificatore univoco della chiamata di funzione. Se compilato, il client deve eseguire functionCall e restituire la risposta con id corrispondente.
name
string
Obbligatorio. Il nome della funzione da chiamare. Deve essere a-z, A-Z, 0-9 o contenere trattini bassi e trattini, con una lunghezza massima di 128 caratteri.
args
object (Struct format)
Facoltativo. I parametri e i valori della funzione in formato oggetto JSON.
| Rappresentazione JSON |
|---|
{ "id": string, "name": string, "args": { object } } |
FunctionResponse
L'output del risultato di un FunctionCall che contiene una stringa che rappresenta FunctionDeclaration.name e un oggetto JSON strutturato contenente qualsiasi output della funzione viene utilizzato come contesto per il modello. Deve contenere il risultato di un FunctionCall creato in base alla previsione del modello.
id
string
Facoltativo. L'identificatore della chiamata di funzione a cui si riferisce questa risposta. Compilato dal client in modo che corrisponda alla chiamata di funzione id.
name
string
Obbligatorio. Il nome della funzione da chiamare. Deve essere a-z, A-Z, 0-9 o contenere trattini bassi e trattini, con una lunghezza massima di 128 caratteri.
response
object (Struct format)
Obbligatorio. La risposta della funzione in formato oggetto JSON. I chiamanti possono utilizzare qualsiasi chiave a loro scelta che si adatti alla sintassi della funzione per restituire l'output della funzione, ad es. "output", "result" e così via. In particolare, se la chiamata di funzione non è stata eseguita, la risposta può avere una chiave "error" per restituire i dettagli dell'errore al modello.
I contenuti multimediali possono essere inclusi utilizzando un sotto-oggetto contenente una singola chiave "$ref" il cui valore è l'inlineData.display_name di un FunctionResponsePart contenente i contenuti multimediali. Consulta https://ai.google.dev/gemini-api/docs/function-calling#multimodal.
parts[]
object (FunctionResponsePart)
Facoltativo. Parts ordinati che costituiscono una risposta di funzione. Le parti possono avere tipi MIME IANA diversi.
willContinue
boolean
Facoltativo. Indicatori che la chiamata di funzione continua e che verranno restituite altre risposte, trasformando la chiamata di funzione in un generatore. Si applica solo alle chiamate di funzione NON_BLOCKING, altrimenti viene ignorato. Se viene impostato su false, le risposte future non verranno prese in considerazione. È consentito restituire response vuoto con willContinue=False per segnalare che la chiamata di funzione è terminata. Ciò potrebbe comunque attivare la generazione del modello. Per evitare di attivare la generazione e completare la chiamata di funzione, imposta anche scheduling su SILENT.
scheduling
enum (Scheduling)
Facoltativo. Specifica come deve essere pianificata la risposta nella conversazione. Applicabile solo alle chiamate di funzioni NON_BLOCKING, altrimenti viene ignorato. Il valore predefinito è WHEN_IDLE.
| Rappresentazione JSON |
|---|
{ "id": string, "name": string, "response": { object }, "parts": [ { object ( |
FunctionResponsePart
Un tipo di dati contenente contenuti multimediali che fanno parte di un messaggio FunctionResponse.
Un FunctionResponsePart è costituito da dati a cui è associato un tipo di dati. Un FunctionResponsePart può contenere solo uno dei tipi accettati in FunctionResponsePart.data.
Un FunctionResponsePart deve avere un tipo MIME IANA fisso che identifichi il tipo e il sottotipo del media se il campo inlineData è compilato con byte non elaborati.
data
Union type
data può essere solo uno dei seguenti tipi:inlineData
object (FunctionResponseBlob)
Byte multimediali in linea.
| Rappresentazione JSON |
|---|
{
// data
"inlineData": {
object ( |
FunctionResponseBlob
Byte multimediali non elaborati per la risposta di funzione.
Il testo non deve essere inviato come byte non elaborati, utilizza il campo "FunctionResponse.response".
mimeType
string
Il tipo MIME standard IANA dei dati di origine. Esempi: - image/png - image/jpeg Se viene fornito un tipo MIME non supportato, verrà restituito un errore. Per un elenco completo dei tipi supportati, consulta Formati di file supportati.
data
string (bytes format)
Byte non elaborati per i formati multimediali.
Una stringa con codifica in base64.
| Rappresentazione JSON |
|---|
{ "mimeType": string, "data": string } |
Programmazione
Specifica come deve essere pianificata la risposta nella conversazione.
| Enum | |
|---|---|
SCHEDULING_UNSPECIFIED |
Questo valore non viene utilizzato. |
SILENT |
Aggiungi il risultato solo al contesto della conversazione, non interrompere o attivare la generazione. |
WHEN_IDLE |
Aggiungi il risultato al contesto della conversazione e chiedi di generare l'output senza interrompere la generazione in corso. |
INTERRUPT |
Aggiungi il risultato al contesto della conversazione, interrompi la generazione in corso e chiedi di generare l'output. |
FileData
Dati basati sull'URI.
mimeType
string
Facoltativo. Il tipo MIME standard IANA dei dati di origine.
fileUri
string
Obbligatorio. URI.
| Rappresentazione JSON |
|---|
{ "mimeType": string, "fileUri": string } |
ExecutableCode
Codice generato dal modello che deve essere eseguito e il risultato restituito al modello.
Generato solo quando si utilizza lo strumento CodeExecution, in cui il codice verrà eseguito automaticamente e verrà generato anche un CodeExecutionResult corrispondente.
id
string
Facoltativo. Identificatore univoco della parte ExecutableCode. Il server restituisce CodeExecutionResult con id corrispondente.
language
enum (Language)
Obbligatorio. Linguaggio di programmazione di code.
code
string
Obbligatorio. Il codice da eseguire.
| Rappresentazione JSON |
|---|
{
"id": string,
"language": enum ( |
Lingua
Linguaggi di programmazione supportati per il codice generato.
| Enum | |
|---|---|
LANGUAGE_UNSPECIFIED |
Lingua non specificata. Questo valore non deve essere utilizzato. |
PYTHON |
Python >= 3.10, con numpy e simpy disponibili. Python è la lingua predefinita. |
CodeExecutionResult
Risultato dell'esecuzione di ExecutableCode.
Generato solo quando viene utilizzato lo strumento CodeExecution.
id
string
Facoltativo. L'identificatore della parte ExecutableCode a cui si riferisce questo risultato. Viene compilato solo se il ExecutableCode corrispondente ha un ID.
outcome
enum (Outcome)
Obbligatorio. Risultato dell'esecuzione del codice.
output
string
Facoltativo. Contiene stdout quando l'esecuzione del codice va a buon fine, stderr o un'altra descrizione in caso contrario.
| Rappresentazione JSON |
|---|
{
"id": string,
"outcome": enum ( |
Risultato
Enumerazione dei possibili risultati dell'esecuzione del codice.
| Enum | |
|---|---|
OUTCOME_UNSPECIFIED |
Stato non specificato. Questo valore non deve essere utilizzato. |
OUTCOME_OK |
Esecuzione del codice completata correttamente. output contiene stdout, se presente. |
OUTCOME_FAILED |
Esecuzione del codice non riuscita. output contiene stderr e stdout, se presenti. |
OUTCOME_DEADLINE_EXCEEDED |
L'esecuzione del codice è durata troppo a lungo ed è stata annullata. Potrebbe essere presente o meno una output parziale. |
ToolCall
Un ToolCall lato server previsto restituito dal modello. Questo messaggio contiene informazioni su uno strumento che il modello vuole richiamare. Il client NON deve eseguire questo ToolCall. Il client deve invece passare questo ToolCall all'API in un turno successivo all'interno di un messaggio Content, insieme al ToolResponse corrispondente.
id
string
Facoltativo. Identificatore univoco della chiamata allo strumento. Il server restituisce la risposta dello strumento con il id corrispondente.
toolName
string
Facoltativo. Il nome dello strumento chiamato.
toolType
enum (ToolType)
Obbligatorio. Il tipo di strumento chiamato.
args
object (Struct format)
Facoltativo. Gli argomenti della chiamata allo strumento. Esempio: {"arg1" : "value1", "arg2" : "value2" , ...}
| Rappresentazione JSON |
|---|
{
"id": string,
"toolName": string,
"toolType": enum ( |
ToolType
Il tipo di strumento nella chiamata di funzione.
| Enum | |
|---|---|
TOOL_TYPE_UNSPECIFIED |
Tipo di strumento non specificato. |
GOOGLE_SEARCH_WEB |
Strumento di ricerca Google, mappato a Tool.google_search.search_types.web_search. |
GOOGLE_SEARCH_IMAGE |
Strumento di ricerca immagini, mappato a Tool.google_search.search_types.image_search. |
URL_CONTEXT |
Strumento Contesto URL, mappato a Tool.url_context. |
GOOGLE_MAPS |
Strumento Google Maps, mappato a Tool.google_maps. |
FILE_SEARCH |
Strumento di ricerca di file, mappato a Tool.file_search. |
ToolResponse
L'output di un'esecuzione ToolCall lato server. Questo messaggio contiene i risultati di una chiamata allo strumento avviata da un ToolCall del modello. Il client deve passare questo ToolResponse all'API in un turno successivo all'interno di un messaggio Content, insieme al ToolCall corrispondente.
id
string
Facoltativo. L'identificatore della chiamata allo strumento a cui si riferisce questa risposta.
toolType
enum (ToolType)
Obbligatorio. Il tipo di strumento chiamato, corrispondente a toolType nel ToolCall corrispondente.
response
object (Struct format)
Facoltativo. La risposta dello strumento.
| Rappresentazione JSON |
|---|
{
"id": string,
"toolType": enum ( |
VideoMetadata
Deprecato: utilizza GenerateContentRequest.processing_options. I metadati descrivono i contenuti video di input.
startOffset
string (Duration format)
Facoltativo. L'offset iniziale del video.
Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
endOffset
string (Duration format)
Facoltativo. L'offset finale del video.
Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
fps
number
Facoltativo. La frequenza fotogrammi del video inviato al modello. Se non è specificato, il valore predefinito è 1.0. L'intervallo di fps è (0.0, 24.0].
| Rappresentazione JSON |
|---|
{ "startOffset": string, "endOffset": string, "fps": number } |
MediaResolution
Risoluzione dei contenuti multimediali per la tokenizzazione.
value
Union type
value può essere solo uno dei seguenti tipi:level
enum (Level)
La qualità della tokenizzazione utilizzata per i contenuti multimediali specifici.
| Rappresentazione JSON |
|---|
{
// value
"level": enum ( |
Livello
Il livello di risoluzione dei contenuti multimediali.
| Enum | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
La risoluzione dei contenuti multimediali non è stata impostata. |
MEDIA_RESOLUTION_LOW |
La risoluzione dei contenuti multimediali è impostata su bassa. |
MEDIA_RESOLUTION_MEDIUM |
La risoluzione dei contenuti multimediali è impostata su media. |
MEDIA_RESOLUTION_HIGH |
Risoluzione dei contenuti multimediali impostata su Alta. |
MEDIA_RESOLUTION_ULTRA_HIGH |
La risoluzione dei contenuti multimediali è impostata su Ultra HD. |
MediaProcessing
Come il modello elabora i contenuti multimediali di input per la comprensione.
| Enum | |
|---|---|
MEDIA_PROCESSING_UNSPECIFIED |
Predefinita. Utilizza l'elaborazione specifica del modello (3.5 Pro+ -> AGENTIC, modelli precedenti -> STATIC). |
STATIC |
Estrazione di frame a tariffa fissa. Tutti i frame inseriti nel contesto. |
AGENTIC |
Navigazione dinamica basata su modelli. Consigliato per la maggior parte dei casi d'uso. |
Ambiente
Un ambiente di esecuzione per un agente.
id
string
Obbligatorio. Solo output. L'ID dell'ambiente.
sources[]
object (Source)
Le origini da montare nell'ambiente.
created
string
Solo output. L'ora in cui è stato creato l'ambiente nel formato ISO 8601 (AAAA-MM-GGThh:mm:ssZ).
updated
string
Solo output. L'ora in cui l'ambiente è stato aggiornato l'ultima volta nel formato ISO 8601 (AAAA-MM-GGThh:mm:ssZ).
lastAccessed
string
Solo output. L'ora in cui è stato eseguito l'ultimo accesso all'ambiente nel formato ISO 8601 (AAAA-MM-GGThh:mm:ssZ).
status
enum (Status)
Solo output. Lo stato del container dell'ambiente.
fileCount
string (int64 format)
Solo output. Il numero di file nell'ambiente, solo output.
sizeBytes
string (int64 format)
Solo output. Le dimensioni totali dei file dell'ambiente in byte, solo output.
network
Union type
network può essere solo uno dei seguenti tipi:networkAllowlist
object (EnvironmentNetworkEgressAllowlist)
Consenti solo domini specifici.
networkMode
enum (NetworkMode)
Modalità di traffico in uscita dalla rete.
| Rappresentazione JSON |
|---|
{ "id": string, "sources": [ { object ( |
Stato
Stato dell'ambiente.
| Enum | |
|---|---|
STATUS_UNSPECIFIED |
|
ACTIVE |
|
EXPIRED |
|
NetworkMode
Modalità di uscita dalla rete per le configurazioni non incluse nella lista consentita.
| Enum | |
|---|---|
NETWORK_MODE_UNSPECIFIED |
Valore predefinito. Non utilizzata. |
DISABLED |
Tutto il traffico di rete in uscita è bloccato. |
Schema
L'oggetto Schema consente di definire i tipi di dati di input e output. Questi tipi possono essere oggetti, ma anche primitive e array. Rappresenta un sottoinsieme selezionato di un oggetto schema OpenAPI 3.0.
type
enum (Type)
Obbligatorio. Tipo di dati.
format
string
Facoltativo. Il formato dei dati. È consentito qualsiasi valore, ma la maggior parte non attiva funzionalità speciali.
title
string
Facoltativo. Il titolo dello schema.
description
string
Facoltativo. Una breve descrizione del parametro. Potrebbe contenere esempi di utilizzo. La descrizione del parametro può essere formattata come Markdown.
nullable
boolean
Facoltativo. Indica se il valore può essere null.
enum[]
string
Facoltativo. Valori possibili dell'elemento di Type.STRING con formato enum. Ad esempio, possiamo definire un'enumerazione Direction come : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
maxItems
string (int64 format)
Facoltativo. Numero massimo di elementi per Type.ARRAY.
minItems
string (int64 format)
Facoltativo. Numero minimo di elementi per Type.ARRAY.
properties
map (key: string, value: object (Schema))
Facoltativo. Proprietà di Type.OBJECT.
Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]
string
Facoltativo. Proprietà obbligatorie di Type.OBJECT.
minProperties
string (int64 format)
Facoltativo. Numero minimo di proprietà per Type.OBJECT.
maxProperties
string (int64 format)
Facoltativo. Numero massimo di proprietà per Type.OBJECT.
minLength
string (int64 format)
Facoltativo. CAMPI SCHEMA PER TIPO STRINGA Lunghezza minima di Type.STRING
maxLength
string (int64 format)
Facoltativo. Lunghezza massima di Type.STRING
pattern
string
Facoltativo. Pattern di Type.STRING per limitare una stringa a un'espressione regolare.
example
value (Value format)
Facoltativo. Esempio dell'oggetto. Verrà compilato solo quando l'oggetto è la radice.
anyOf[]
object (Schema)
Facoltativo. Il valore deve essere convalidato rispetto a uno o più sottoschema nell'elenco.
propertyOrdering[]
string
Facoltativo. L'ordine delle proprietà. Non è un campo standard nella specifica OpenAPI. Viene utilizzato per determinare l'ordine delle proprietà nella risposta.
default
value (Value format)
Facoltativo. Valore predefinito del campo. In base allo schema JSON, questo campo è destinato ai generatori di documentazione e non influisce sulla convalida. Pertanto, è incluso qui e ignorato in modo che gli sviluppatori che inviano schemi con un campo default non ricevano errori di campo sconosciuto.
items
object (Schema)
Facoltativo. Schema degli elementi di Type.ARRAY.
minimum
number
Facoltativo. CAMPI SCHEMA PER TIPO INTEGER e NUMBER Valore minimo di Type.INTEGER e Type.NUMBER
maximum
number
Facoltativo. Valore massimo di Type.INTEGER e Type.NUMBER
| Rappresentazione JSON |
|---|
{ "type": enum ( |
Tipo
Type contiene l'elenco dei tipi di dati OpenAPI definiti da https://spec.openapis.org/oas/v3.0.3#data-types
| Enum | |
|---|---|
TYPE_UNSPECIFIED |
Non specificato, non deve essere utilizzato. |
STRING |
Tipo di stringa. |
NUMBER |
Tipo di numero. |
INTEGER |
Tipo di numero intero. |
BOOLEAN |
Tipo booleano. |
ARRAY |
Tipo di array. |
OBJECT |
Tipo di oggetto. |
NULL |
Tipo null. |
Strumento
- Rappresentazione JSON
- FunctionDeclaration
- Comportamento
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- Modalità
- CodeExecution
- GoogleSearch
- Intervallo
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- Ambiente
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
Dettagli dello strumento che il modello può utilizzare per generare la risposta.
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 del modello.
ID successivo: 17
functionDeclarations[]
object (FunctionDeclaration)
Facoltativo. Un elenco di FunctionDeclarations disponibili per il modello che possono essere utilizzati per la chiamata di funzione.
Il modello o il sistema non esegue la funzione. La funzione definita può invece essere restituita come FunctionCall con argomenti al lato client per l'esecuzione. Il modello può decidere di chiamare un sottoinsieme di queste funzioni compilando FunctionCall nella risposta. Il turno di conversazione successivo potrebbe contenere un FunctionResponse con il contesto di generazione della "funzione" Content.role per il turno successivo del modello.
googleSearchRetrieval
object (GoogleSearchRetrieval)
Facoltativo. Strumento di recupero basato sulla Ricerca Google.
codeExecution
object (CodeExecution)
Facoltativo. Consente al modello di eseguire il codice durante la generazione.
googleSearch
object (GoogleSearch)
Facoltativo. Tipo di strumento GoogleSearch. Strumento per supportare la Ricerca Google in Model. Con tecnologia Google.
computerUse
object (ComputerUse)
Facoltativo. Strumento per supportare l'interazione del modello direttamente con il computer. Se attivata, compila automaticamente le dichiarazioni di funzione specifiche per l'utilizzo del computer.
urlContext
object (UrlContext)
Facoltativo. Strumento per supportare il recupero del contesto URL.
fileSearch
object (FileSearch)
Facoltativo. Tipo di strumento FileSearch. Strumento per recuperare le conoscenze dai corpus di recupero semantico.
mcpServers[]
object (McpServer)
Facoltativo. Server MCP a cui connettersi.
googleMaps
object (GoogleMaps)
Facoltativo. Strumento che consente di basare la risposta del modello su un contesto geospaziale correlato alla query dell'utente.
| Rappresentazione JSON |
|---|
{ "functionDeclarations": [ { object ( |
FunctionDeclaration
Rappresentazione strutturata di una dichiarazione di funzione come definita dalla specifica OpenAPI 3.03. In questa dichiarazione sono inclusi il nome e i parametri della funzione. Questa FunctionDeclaration è una rappresentazione di un blocco di codice che può essere utilizzato come Tool dal modello ed eseguito dal client.
name
string
Obbligatorio. Il nome della funzione. Deve essere a-z, A-Z, 0-9 o contenere trattini bassi, due punti, punti e trattini, con una lunghezza massima di 128 caratteri.
description
string
Obbligatorio. Una breve descrizione della funzione.
behavior
enum (Behavior)
Facoltativo. Specifica il comportamento della funzione. Al momento è supportato solo dal metodo BidiGenerateContent.
parameters
object (Schema)
Facoltativo. Descrive i parametri di questa funzione. Riflette la chiave stringa dell'oggetto parametro Open API 3.03: il nome del parametro. I nomi dei parametri sono sensibili alle maiuscole. Valore schema: lo schema che definisce il tipo utilizzato per il parametro.
parametersJsonSchema
value (Value format)
Facoltativo. Descrive i parametri della funzione nel formato dello schema JSON. Lo schema deve descrivere un oggetto in cui le proprietà sono i parametri della funzione. Ad esempio:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
Questo campo si esclude a vicenda con parameters.
response
object (Schema)
Facoltativo. Descrive l'output di questa funzione in formato JSON Schema. Riflette l'oggetto risposta Open API 3.03. Lo schema definisce il tipo utilizzato per il valore di risposta della funzione.
responseJsonSchema
value (Value format)
Facoltativo. Descrive l'output di questa funzione in formato JSON Schema. Il valore specificato dallo schema è il valore di risposta della funzione.
Questo campo si esclude a vicenda con response.
Comportamento
Definisce il comportamento della funzione. Il valore predefinito è BLOCKING.
| Enum | |
|---|---|
UNSPECIFIED |
Questo valore non viene utilizzato. |
BLOCKING |
Se impostato, il sistema attenderà di ricevere la risposta della funzione prima di continuare la conversazione. |
NON_BLOCKING |
Se impostato, il sistema non attenderà la ricezione della risposta della funzione. Tenterà invece di gestire le risposte delle funzioni non appena saranno disponibili, mantenendo la conversazione tra l'utente e il modello. |
GoogleSearchRetrieval
Strumento per recuperare dati web pubblici per il grounding, basato su Google.
dynamicRetrievalConfig
object (DynamicRetrievalConfig)
Specifica la configurazione del recupero dinamico per l'origine specificata.
| Rappresentazione JSON |
|---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
Descrive le opzioni per personalizzare il recupero dinamico.
mode
enum (Mode)
La modalità del predittore da utilizzare nel recupero dinamico.
dynamicThreshold
number
La soglia da utilizzare nel recupero dinamico. Se non viene impostato, viene utilizzato un valore predefinito del sistema.
| Rappresentazione JSON |
|---|
{
"mode": enum ( |
Modalità
La modalità del predittore da utilizzare nel recupero dinamico.
| Enum | |
|---|---|
MODE_UNSPECIFIED |
Attiva sempre il recupero. |
MODE_DYNAMIC |
Esegui il recupero solo quando il sistema lo ritiene necessario. |
CodeExecution
Questo tipo non contiene campi.
Strumento che esegue il codice generato dal modello e restituisce automaticamente il risultato al modello.
Vedi anche ExecutableCode e CodeExecutionResult, che vengono generati solo quando utilizzi questo strumento.
GoogleSearch
Tipo di strumento GoogleSearch. Strumento per supportare la Ricerca Google in Model. Con tecnologia Google.
timeRangeFilter
object (Interval)
Facoltativo. Filtrare i risultati di ricerca in base a un intervallo di tempo specifico. Se i clienti impostano un'ora di inizio, devono impostare anche un'ora di fine (e viceversa).
searchTypes
object (SearchTypes)
Facoltativo. L'insieme di tipi di ricerca da attivare. Se non viene impostata, la ricerca nel web è attivata per impostazione predefinita.
| Rappresentazione JSON |
|---|
{ "timeRangeFilter": { object ( |
Intervallo
Rappresenta un intervallo di tempo, codificato come timestamp di inizio (incluso) e timestamp di fine (escluso).
L'inizio deve essere inferiore o uguale alla fine. Se l'inizio è uguale alla fine, l'intervallo è vuoto (non corrisponde a nessun orario). Se non vengono specificati né l'inizio né la fine, l'intervallo corrisponde a qualsiasi orario.
startTime
string (Timestamp format)
Facoltativo. Inizio inclusivo dell'intervallo.
Se specificato, un timestamp corrispondente a questo intervallo dovrà essere uguale o successivo all'inizio.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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)
Facoltativo. Fine esclusiva dell'intervallo.
Se specificato, un timestamp corrispondente a questo intervallo dovrà essere precedente alla fine.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".
| Rappresentazione JSON |
|---|
{ "startTime": string, "endTime": string } |
SearchTypes
Diversi tipi di ricerca che possono essere attivati nello strumento GoogleSearch.
webSearch
object (WebSearch)
Facoltativo. Attiva la ricerca web. Vengono restituiti solo risultati di testo.
imageSearch
object (ImageSearch)
Facoltativo. Attiva la ricerca immagini. Vengono restituiti i byte dell'immagine.
| Rappresentazione JSON |
|---|
{ "webSearch": { object ( |
WebSearch
Questo tipo non contiene campi.
Ricerca web standard per il grounding e le configurazioni correlate.
ImageSearch
Questo tipo non contiene campi.
Ricerca immagini per il grounding e configurazioni correlate.
ComputerUse
Tipo di strumento di utilizzo del computer.
environment
enum (Environment)
Obbligatorio. L'ambiente in cui viene eseguita l'operazione.
excludedPredefinedFunctions[]
string
Facoltativo. Per impostazione predefinita, le funzioni predefinite sono incluse nella chiamata del modello finale. Alcuni possono essere esclusi esplicitamente dall'inclusione automatica. Questo può servire a due scopi: 1. Utilizzo di uno spazio di azioni più limitato / diverso. 2. Miglioramento delle definizioni / istruzioni delle funzioni predefinite.
enablePromptInjectionDetection
boolean
Facoltativo. Se attivare il controllo del rilevamento di prompt injection nella richiesta di utilizzo del computer.
disabledSafetyPolicies[]
enum (SafetyPolicy)
Facoltativo. Policy di sicurezza disattivate per l'utilizzo del computer.
| Rappresentazione JSON |
|---|
{ "environment": enum ( |
Ambiente
Rappresenta l'ambiente in cui viene eseguita l'operazione, ad esempio un browser web.
| Enum | |
|---|---|
ENVIRONMENT_UNSPECIFIED |
Il valore predefinito è browser. |
ENVIRONMENT_BROWSER |
Funziona in un browser web. |
ENVIRONMENT_MOBILE |
Funziona in un ambiente mobile. |
ENVIRONMENT_DESKTOP |
Funziona in un ambiente desktop. |
SafetyPolicy
Norme di sicurezza predefinite per l'utilizzo del computer.
| Enum | |
|---|---|
SAFETY_POLICY_UNSPECIFIED |
Norme di sicurezza non specificate. |
FINANCIAL_TRANSACTIONS |
Norme di sicurezza per le transazioni finanziarie. |
SENSITIVE_DATA_MODIFICATION |
Norme di sicurezza per la modifica dei dati sensibili. |
COMMUNICATION_TOOL |
Norme di sicurezza per gli strumenti di comunicazione (ad es. Gmail, Chat, Meet). |
ACCOUNT_CREATION |
Norme di sicurezza per la creazione di account. |
DATA_MODIFICATION |
Norme di sicurezza per la modifica dei dati. |
USER_CONSENT_MANAGEMENT |
Norme di sicurezza per la gestione del consenso degli utenti. |
LEGAL_TERMS_AND_AGREEMENTS |
Norme di sicurezza per termini e accordi legali. |
UrlContext
Questo tipo non contiene campi.
Strumento per supportare il recupero del contesto URL.
FileSearch
Lo strumento FileSearch che recupera le conoscenze dai corpus di Semantic Retrieval. I file vengono importati nei corpus di Semantic Retrieval utilizzando l'API ImportFile.
fileSearchStoreNames[]
string
Obbligatorio. I nomi degli archivi fileSearchStores da recuperare. Esempio: fileSearchStores/my-file-search-store-123
metadataFilter
string
Facoltativo. Filtro dei metadati da applicare ai documenti e ai chunk di recupero semantico.
topK
integer
Facoltativo. Il numero di blocchi di recupero semantico da recuperare.
| Rappresentazione JSON |
|---|
{ "fileSearchStoreNames": [ string ], "metadataFilter": string, "topK": integer } |
McpServer
Un server MCP è un server che può essere chiamato dal modello per eseguire azioni. È un server che implementa il protocollo MCP. ID successivo: 6
name
string
Il nome di MCPServer.
transport
Union type
transport può essere solo uno dei seguenti tipi:streamableHttpTransport
object (StreamableHttpTransport)
Un trasporto in grado di trasmettere in streaming richieste e risposte HTTP.
| Rappresentazione JSON |
|---|
{
"name": string,
// transport
"streamableHttpTransport": {
object ( |
StreamableHttpTransport
Un trasporto in grado di trasmettere in streaming richieste e risposte HTTP. ID successivo: 6
url
string
L'URL completo dell'endpoint MCPServer. Esempio: "https://api.example.com/mcp"
headers
map (key: string, value: string)
(Facoltativo) Campi per intestazioni di autenticazione, timeout e così via, se necessario.
Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
timeout
string (Duration format)
Timeout HTTP per le operazioni regolari.
Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
sseReadTimeout
string (Duration format)
Timeout per le operazioni di lettura SSE.
Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
terminateOnClose
boolean
Indica se chiudere la sessione client quando viene chiuso il trasporto.
| Rappresentazione JSON |
|---|
{ "url": string, "headers": { string: string, ... }, "timeout": string, "sseReadTimeout": string, "terminateOnClose": boolean } |
GoogleMaps
Lo strumento Google Maps che fornisce il contesto geospaziale per la query dell'utente.
enableWidget
boolean
Facoltativo. Indica se restituire un token di contesto del widget in GroundingMetadata della risposta. Gli sviluppatori possono utilizzare il token di contesto del widget per eseguire il rendering di un widget di Google Maps con contesto geospaziale correlato ai luoghi a cui fa riferimento il modello nella risposta.
| Rappresentazione JSON |
|---|
{ "enableWidget": boolean } |
Risorsa REST: auth_tokens
- Risorsa: AuthToken
- BidiGenerateContentSetup
- GenerationConfig
- Modalità
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
- ResponseFormatConfig
- TextResponseFormat
- MimeType
- AudioResponseFormat
- MimeType
- Pubblicazione
- ImageResponseFormat
- MimeType
- Pubblicazione
- AspectRatio
- ImageSize
- TranslationConfig
- AudioTranscriptionConfig
- LanguageAuto
- LanguageHints
- RealtimeInputConfig
- AutomaticActivityDetection
- StartSensitivity
- EndSensitivity
- ActivityHandling
- TurnCoverage
- SessionResumptionConfig
- ContextWindowCompressionConfig
- SlidingWindow
- HistoryConfig
- Metodi
Risorsa: AuthToken
Una richiesta per creare un token di autenticazione effimero.
name
string
Solo output. Identificatore. Il token stesso.
expireTime
string (Timestamp format)
Facoltativo. Solo input. Immutabile. Un orario facoltativo dopo il quale, quando si utilizza il token risultante, i messaggi nelle sessioni BidiGenerateContent verranno rifiutati. Gemini potrebbe chiudere la sessione in anticipo dopo questo periodo di tempo.
Se non viene impostato, il valore predefinito è 30 minuti nel futuro. Se impostato, questo valore deve essere inferiore a 20 ore nel futuro.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".
newSessionExpireTime
string (Timestamp format)
Facoltativo. Solo input. Immutabile. Il periodo di tempo dopo il quale le nuove sessioni dell'API Live che utilizzano il token risultante da questa richiesta verranno rifiutate.
Se non viene impostato, il valore predefinito è 60 secondi. Se impostato, questo valore deve essere inferiore a 20 ore nel futuro.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".
fieldMask
string (FieldMask format)
Facoltativo. Solo input. Immutabile. Se fieldMask è vuoto e bidiGenerateContentSetup non è presente, il messaggio BidiGenerateContentSetup effettivo viene recuperato dalla connessione API Live.
Se fieldMask è vuoto e bidiGenerateContentSetup è presente, il messaggio BidiGenerateContentSetup effettivo viene preso interamente da bidiGenerateContentSetup in questa richiesta. Il messaggio di configurazione della connessione API Live viene ignorato.
Se fieldMask non è vuoto, i campi corrispondenti di bidiGenerateContentSetup sovrascriveranno i campi del messaggio di configurazione nella connessione API live.
Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
config
Union type
config può essere solo uno dei seguenti tipi:bidiGenerateContentSetup
object (BidiGenerateContentSetup)
Facoltativo. Solo input. Immutabile. Configurazione specifica per BidiGenerateContent.
uses
integer
Facoltativo. Solo input. Immutabile. Il numero di volte in cui è possibile utilizzare il token. Se questo valore è zero, non viene applicato alcun limite. La ripresa di una sessione dell'API Live non viene conteggiata come utilizzo. Se non specificato, il valore predefinito è 1.
| Rappresentazione JSON |
|---|
{
"name": string,
"expireTime": string,
"newSessionExpireTime": string,
"fieldMask": string,
// config
"bidiGenerateContentSetup": {
object ( |
BidiGenerateContentSetup
Messaggio da inviare nel primo (e solo nel primo) BidiGenerateContentClientMessage. Contiene la configurazione che verrà applicata per la durata della RPC di streaming.
I client devono attendere un messaggio BidiGenerateContentSetupComplete prima di inviare altri messaggi.
model
string
Obbligatorio. Il nome della risorsa del modello. che funge da ID da utilizzare per il modello.
Formato: models/{model}
generationConfig
object (GenerationConfig)
Facoltativo. Configurazione della generazione.
I seguenti campi non sono supportati:
responseLogprobsresponseMimeTypelogprobsresponseSchemaresponseJsonSchemastop_sequenceskipResponseCacherouting_configaudio_timestamp
systemInstruction
object (Content)
Facoltativo. L'utente ha fornito istruzioni di sistema per il modello.
Nota: nelle parti deve essere utilizzato solo testo e i contenuti di ogni parte saranno in un paragrafo separato.
tools[]
object (Tool)
Facoltativo. Un elenco di Tools che il modello 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 del modello.
realtimeInputConfig
object (RealtimeInputConfig)
Facoltativo. Configura la gestione dell'input in tempo reale.
sessionResumption
object (SessionResumptionConfig)
Facoltativo. Configura il meccanismo di ripresa della sessione.
Se incluso, il server invierà SessionResumptionUpdate messaggi.
contextWindowCompression
object (ContextWindowCompressionConfig)
Facoltativo. Configura un meccanismo di compressione della finestra contestuale.
Se incluso, il server ridurrà automaticamente le dimensioni del contesto quando superano la lunghezza configurata.
inputAudioTranscription
object (AudioTranscriptionConfig)
Facoltativo. Se impostata, attiva la trascrizione dell'input vocale. La trascrizione è allineata alla lingua dell'audio di input, se configurata.
outputAudioTranscription
object (AudioTranscriptionConfig)
Facoltativo. Se impostata, attiva la trascrizione dell'output audio del modello. La trascrizione è allineata al codice della lingua specificato per l'audio di output, se configurato.
historyConfig
object (HistoryConfig)
Facoltativo. Configura lo scambio della cronologia tra il client e il server.
| Rappresentazione JSON |
|---|
{ "model": string, "generationConfig": { object ( |
GenerationConfig
Opzioni di configurazione per la generazione e gli output del modello. Non tutti i parametri sono configurabili per ogni modello.
stopSequences[]
string
Facoltativo. Il set di sequenze di caratteri (fino a 5) che interromperanno la generazione dell'output. Se specificato, l'API si interromperà alla prima occorrenza di un stop_sequence. La sequenza di interruzione non verrà inclusa nella risposta.
responseMimeType
string
Facoltativo. Tipo MIME del testo candidato generato. I tipi MIME supportati sono: text/plain: (impostazione predefinita) output di testo. application/json: risposta JSON nei candidati alla risposta. text/x.enum: ENUM come risposta stringa nei candidati alla risposta. Consulta la documentazione per un elenco di tutti i tipi MIME di testo supportati.
responseSchema
(deprecated)
object (Schema)
Facoltativo. Schema di output del testo candidato generato. Gli schemi devono essere un sottoinsieme dello schema OpenAPI e possono essere oggetti, primitive o array.
Se impostato, deve essere impostato anche un responseMimeType compatibile. Tipi MIME compatibili: application/json: schema per la risposta JSON. Per ulteriori dettagli, consulta la guida alla generazione di testo JSON.
_responseJsonSchema
(deprecated)
value (Value format)
Facoltativo. Schema di output della risposta generata. Si tratta di un'alternativa a responseSchema che accetta lo schema JSON.
Se impostato, responseSchema deve essere omesso, ma responseMimeType è obbligatorio.
Sebbene possa essere inviato lo schema JSON completo, non tutte le funzionalità sono supportate. Nello specifico, sono supportate solo le seguenti proprietà:
$id$defs$ref$anchortypeformattitledescriptionenum(per stringhe e numeri)itemsprefixItemsminItemsmaxItemsminimummaximumanyOfoneOf(interpretato comeanyOf)propertiesadditionalPropertiesrequired
Può essere impostata anche la proprietà non standard propertyOrdering.
I riferimenti ciclici vengono srotolati in misura limitata e, pertanto, possono essere utilizzati solo all'interno di proprietà non obbligatorie. (Le proprietà Nullable non sono sufficienti.) Se $ref è impostato su un sottoschema, non è possibile impostare altre proprietà, ad eccezione di quelle che iniziano con $.
responseJsonSchema
value (Value format)
Facoltativo. Un dettaglio interno. Utilizza responseJsonSchema anziché questo campo.
responseModalities[]
enum (Modality)
Facoltativo. Le modalità di risposta richieste. Rappresenta l'insieme di modalità che il modello può restituire e che devono essere previste nella risposta. Questa è una corrispondenza esatta con le modalità della risposta.
Un modello può avere più combinazioni di modalità supportate. Se le modalità richieste non corrispondono a nessuna delle combinazioni supportate, verrà restituito un errore.
Un elenco vuoto equivale a richiedere solo il testo.
candidateCount
integer
Facoltativo. Numero di risposte generate da restituire. Se non viene impostato, il valore predefinito è 1. Tieni presente che questa operazione non funziona per i modelli di generazione precedente (famiglia Gemini 1.0).
maxOutputTokens
integer
Facoltativo. Il numero massimo di token da includere in una risposta candidata.
Nota: il valore predefinito varia in base al modello. Consulta l'attributo Model.output_token_limit di Model restituito dalla funzione getModel.
temperature
number
Facoltativo. Controlla la casualità dell'output.
Nota: il valore predefinito varia in base al modello. Consulta l'attributo Model.temperature di Model restituito dalla funzione getModel.
I valori possono variare da [0.0, 2.0].
topP
number
Facoltativo. La probabilità cumulativa massima dei token da considerare durante il campionamento.
Il modello utilizza il campionamento combinato Top-k e Top-p (nucleo).
I token vengono ordinati in base alle probabilità assegnate, in modo che vengano presi in considerazione solo i token più probabili. Il campionamento top-k limita direttamente il numero massimo di token da considerare, mentre il campionamento Nucleus limita il numero di token in base alla probabilità cumulativa.
Nota: il valore predefinito varia in base a Model ed è specificato dall'attributo Model.top_p restituito dalla funzione getModel. Un attributo topK vuoto indica che il modello non applica il campionamento top-k e non consente di impostare topK nelle richieste.
topK
integer
Facoltativo. Il numero massimo di token da considerare durante il campionamento.
I modelli Gemini utilizzano il campionamento Top-p (nucleo) o una combinazione di campionamento Top-k e del nucleo. Il campionamento Top-K considera l'insieme dei topK token più probabili. I modelli in esecuzione con il campionamento del nucleo non consentono l'impostazione di topK.
Nota: il valore predefinito varia in base a Model ed è specificato dall'attributo Model.top_p restituito dalla funzione getModel. Un attributo topK vuoto indica che il modello non applica il campionamento top-k e non consente di impostare topK nelle richieste.
seed
integer
Facoltativo. Seed utilizzato nella decodifica. Se non viene impostato, la richiesta utilizza un seme generato in modo casuale.
presencePenalty
number
Facoltativo. Penalità di presenza applicata alle probabilità logaritmiche del token successivo se il token è già stato visualizzato nella risposta.
Questa sanzione è binaria (on/off) e non dipende dal numero di volte in cui viene utilizzato il token (dopo la prima). Utilizza frequencyPenalty per una penalità che aumenta a ogni utilizzo.
Una penalità positiva scoraggerà l'uso di token già utilizzati nella risposta, aumentando il vocabolario.
Una penalità negativa incoraggerà l'uso di token già utilizzati nella risposta, riducendo il vocabolario.
frequencyPenalty
number
Facoltativo. Penalità di frequenza applicata ai logprob del token successivo, moltiplicata per il numero di volte in cui ogni token è stato visualizzato finora nella risposta.
Una penalità positiva scoraggia l'uso di token già utilizzati, in proporzione al numero di volte in cui il token è stato utilizzato: più un token viene utilizzato, più è difficile per il modello riutilizzarlo, aumentando il vocabolario delle risposte.
Attenzione: una penalità negativa incoraggerà il modello a riutilizzare i token in proporzione al numero di volte in cui sono stati utilizzati. Valori negativi piccoli riducono il vocabolario di una risposta. Valori negativi più grandi faranno sì che il modello inizi a ripetere un token comune fino a raggiungere il limite di maxOutputTokens.
responseLogprobs
boolean
Facoltativo. Se è true, esporta i risultati di logprobs nella risposta.
logprobs
integer
Facoltativo. Valido solo se responseLogprobs=True. Imposta il numero di logprob principali, incluso il candidato scelto, da restituire a ogni passaggio di decodifica in Candidate.logprobs_result. Il numero deve essere compreso nell'intervallo [0, 20].
enableEnhancedCivicAnswers
boolean
Facoltativo. Attiva le risposte civiche avanzate. Potrebbe non essere disponibile per tutti i modelli.
speechConfig
object (SpeechConfig)
Facoltativo. La configurazione della generazione vocale.
thinkingConfig
object (ThinkingConfig)
Facoltativo. Configurazione delle funzionalità di pensiero. Verrà restituito un errore se questo campo è impostato per i modelli che non supportano il pensiero.
imageConfig
object (ImageConfig)
Facoltativo. Configurazione per la generazione di immagini. Verrà restituito un errore se questo campo è impostato per i modelli che non supportano queste opzioni di configurazione.
mediaResolution
enum (MediaResolution)
Facoltativo. Se specificata, verrà utilizzata la risoluzione dei contenuti multimediali specificata.
enableAffectiveDialog
boolean
Facoltativo. Se abilitata, il modello rileverà le emozioni e adatterà le sue risposte di conseguenza.
responseFormat
object (ResponseFormatConfig)
Facoltativo. Configurazione per il formato di output della risposta. Consente di specificare la configurazione di output per modalità (testo, audio, immagine) in una struttura piatta.
translationConfig
object (TranslationConfig)
Facoltativo. Configurazione per la traduzione.
audioTranscriptionConfig
object (AudioTranscriptionConfig)
Facoltativo. Configurazione per la trascrizione audio (riconoscimento vocale).
| Rappresentazione JSON |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Modalità
Modalità supportate della risposta.
| Enum | |
|---|---|
MODALITY_UNSPECIFIED |
Valore predefinito. |
TEXT |
Indica che il modello deve restituire testo. |
IMAGE |
Indica che il modello deve restituire immagini. |
AUDIO |
Indica che il modello deve restituire l'audio. |
SpeechConfig
Configurazione per la generazione e la trascrizione della sintesi vocale.
voiceConfig
object (VoiceConfig)
La configurazione in caso di output a una sola voce.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig)
Facoltativo. La configurazione per la configurazione multi-speaker. Si esclude a vicenda con il campo voiceConfig.
languageCode
string
Facoltativo. Il codice lingua BCP-47 IETF che l'utente ha configurato per l'utilizzo dell'app. Utilizzato per il riconoscimento vocale e la sintesi vocale.
I valori validi sono: de-DE, en-AU, en-GB, en-IN, en-US, es-US, fr-FR, hi-IN, pt-BR, ar-XA, es-ES, fr-CA, id-ID, it-IT, ja-JP, tr-TR, vi-VN, bn-IN, gu-IN, kn-IN, ml-IN, mr-IN, ta-IN, te-IN, nl-NL, ko-KR, cmn-CN, pl-PL, ru-RU e th-TH.
| Rappresentazione JSON |
|---|
{ "voiceConfig": { object ( |
VoiceConfig
La configurazione della voce da utilizzare.
voice_config
Union type
voice_config può essere solo uno dei seguenti tipi:prebuiltVoiceConfig
object (PrebuiltVoiceConfig)
La configurazione della voce predefinita da utilizzare.
| Rappresentazione JSON |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
La configurazione da utilizzare per lo speaker predefinito.
voiceName
string
Il nome della voce preimpostata da utilizzare.
| Rappresentazione JSON |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
La configurazione per la configurazione multi-speaker.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig)
Obbligatorio. Tutte le voci del relatore attivate.
| Rappresentazione JSON |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
La configurazione per un singolo speaker in una configurazione multi-speaker.
speaker
string
Obbligatorio. Il nome dell'oratore da utilizzare. Deve essere uguale a quello del prompt.
voiceConfig
object (VoiceConfig)
Obbligatorio. La configurazione della voce da utilizzare.
| Rappresentazione JSON |
|---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Configurazione delle funzionalità di pensiero.
includeThoughts
boolean
Indica se includere i pensieri nella risposta. Se true, i pensieri vengono restituiti solo quando sono disponibili.
thinkingBudget
integer
Il numero di token di pensiero che il modello deve generare.
thinkingLevel
enum (ThinkingLevel)
Facoltativo. Controlla la profondità massima del processo di ragionamento interno del modello prima che produca una risposta. Il valore predefinito dipende dal modello. Per maggiori dettagli, consulta la guida ai livelli di pensiero. Consigliato per Gemini 3 o modelli successivi. L'utilizzo con modelli precedenti genera un errore.
| Rappresentazione JSON |
|---|
{
"includeThoughts": boolean,
"thinkingBudget": integer,
"thinkingLevel": enum ( |
ThinkingLevel
Consenti all'utente di specificare quanto pensare utilizzando l'enumerazione anziché il budget intero.
| Enum | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
Valore predefinito. |
MINIMAL |
Poco o nessun pensiero. |
LOW |
Livello di ragionamento basso. |
MEDIUM |
Livello di ragionamento medio. |
HIGH |
Livello di ragionamento elevato. |
ImageConfig
Configurazione per le funzionalità di generazione di immagini.
aspectRatio
string
Facoltativo. Le proporzioni dell'immagine da generare. Formati supportati: 1:1, 1:4, 4:1, 1:8, 8:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9 o 21:9.
Se non specificato, il modello sceglierà un formato predefinito in base alle immagini di riferimento fornite.
imageSize
string
Facoltativo. Specifica le dimensioni delle immagini generate. I valori supportati sono 512, 1K, 2K e 4K. Se non specificato, il modello utilizzerà il valore predefinito 1K.
| Rappresentazione JSON |
|---|
{ "aspectRatio": string, "imageSize": string } |
MediaResolution
Risoluzione dei contenuti multimediali per i contenuti multimediali di input.
| Enum | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
La risoluzione dei contenuti multimediali non è stata impostata. |
MEDIA_RESOLUTION_LOW |
Risoluzione dei contenuti multimediali impostata su bassa (64 token). |
MEDIA_RESOLUTION_MEDIUM |
La risoluzione dei contenuti multimediali è impostata su media (256 token). |
MEDIA_RESOLUTION_HIGH |
Risoluzione dei contenuti multimediali impostata su Alta (ricomposizione con zoom con 256 token). |
ResponseFormatConfig
Configurazione per il formato di output della risposta. Si tratta di un oggetto semplice in cui ogni sottocampo facoltativo configura una modalità di output specifica.
text
object (TextResponseFormat)
Facoltativo. Configurazione del formato di output del testo.
audio
object (AudioResponseFormat)
Facoltativo. Configurazione del formato di uscita audio.
image
object (ImageResponseFormat)
Facoltativo. Configurazione del formato di output dell'immagine.
| Rappresentazione JSON |
|---|
{ "text": { object ( |
TextResponseFormat
Configurazione del formato di output del testo.
mimeType
enum (MimeType)
Facoltativo. Il tipo MIME dell'output di testo.
schema
value (Value format)
Facoltativo. Lo schema JSON a cui deve essere conforme l'output. Applicabile solo quando mimeType è APPLICATION_JSON.
| Rappresentazione JSON |
|---|
{
"mimeType": enum ( |
MimeType
Tipi MIME supportati per l'output di testo.
| Enum | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
APPLICATION_JSON |
Formato di output JSON. |
TEXT_PLAIN |
Formato di output di testo non crittografato. |
AudioResponseFormat
Configurazione per il formato di uscita audio.
mimeType
enum (MimeType)
Facoltativo. Il tipo MIME dell'uscita audio.
delivery
enum (Delivery)
Facoltativo. La modalità di invio per l'uscita audio.
sampleRate
integer
Facoltativo. Frequenza di campionamento in Hz.
bitRate
integer
Facoltativo. Velocità in bit in bit al secondo (bps). Applicabile solo per i formati compressi (MP3, Opus).
MimeType
Tipi MIME supportati per l'uscita audio.
| Enum | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
AUDIO_MP3 |
Formato audio MP3. |
AUDIO_OGG_OPUS |
Formato audio OGG Opus. |
AUDIO_L16 |
Formato audio PCM non elaborato (L16). |
AUDIO_WAV |
Formato audio WAV. |
AUDIO_ALAW |
Formato audio A-law. |
AUDIO_MULAW |
Formato audio Mu-law. |
Invio
Modalità di invio per l'uscita audio.
| Enum | |
|---|---|
DELIVERY_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
INLINE |
I dati audio vengono restituiti in linea nella risposta. |
URI |
I dati audio vengono restituiti come URI. |
ImageResponseFormat
Configurazione per il formato di output dell'immagine.
mimeType
enum (MimeType)
Facoltativo. Il tipo MIME dell'output dell'immagine.
delivery
enum (Delivery)
Facoltativo. La modalità di invio dell'output dell'immagine.
aspectRatio
enum (AspectRatio)
Facoltativo. Le proporzioni dell'output dell'immagine.
imageSize
enum (ImageSize)
Facoltativo. Le dimensioni dell'output dell'immagine.
| Rappresentazione JSON |
|---|
{ "mimeType": enum ( |
MimeType
Tipi MIME supportati per l'output delle immagini.
| Enum | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
IMAGE_JPEG |
Formato immagine JPEG. |
Invio
Modalità di invio per l'output dell'immagine.
| Enum | |
|---|---|
DELIVERY_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
INLINE |
I dati dell'immagine vengono restituiti in linea nella risposta. |
URI |
I dati dell'immagine vengono restituiti come URI. |
AspectRatio
Proporzioni supportate per l'output immagine.
| Enum | |
|---|---|
ASPECT_RATIO_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
ASPECT_RATIO_ONE_BY_ONE |
Proporzioni 1:1. |
ASPECT_RATIO_TWO_BY_THREE |
Proporzioni 2:3. |
ASPECT_RATIO_THREE_BY_TWO |
Proporzioni 3:2. |
ASPECT_RATIO_THREE_BY_FOUR |
Proporzioni 3:4. |
ASPECT_RATIO_FOUR_BY_THREE |
Proporzioni 4:3. |
ASPECT_RATIO_FOUR_BY_FIVE |
Proporzioni 4:5. |
ASPECT_RATIO_FIVE_BY_FOUR |
Proporzioni 5:4. |
ASPECT_RATIO_NINE_BY_SIXTEEN |
Proporzioni 9:16. |
ASPECT_RATIO_SIXTEEN_BY_NINE |
Proporzioni 16:9. |
ASPECT_RATIO_TWENTY_ONE_BY_NINE |
Proporzioni 21:9. |
ASPECT_RATIO_ONE_BY_EIGHT |
Proporzioni 1:8. |
ASPECT_RATIO_EIGHT_BY_ONE |
Proporzioni 8:1. |
ASPECT_RATIO_ONE_BY_FOUR |
Proporzioni 1:4. |
ASPECT_RATIO_FOUR_BY_ONE |
Proporzioni 4:1. |
ImageSize
Dimensioni delle immagini supportate per l'output delle immagini.
| Enum | |
|---|---|
IMAGE_SIZE_UNSPECIFIED |
Valore predefinito. Questo valore non viene utilizzato. |
IMAGE_SIZE_FIVE_TWELVE |
Dimensioni dell'immagine: 512 px. |
IMAGE_SIZE_ONE_K |
Dimensioni dell'immagine 1K. |
IMAGE_SIZE_TWO_K |
Dimensioni delle immagini 2K. |
IMAGE_SIZE_FOUR_K |
Dimensioni delle immagini in 4K. |
TranslationConfig
Configurazione delle funzionalità di traduzione.
targetLanguageCode
string
Obbligatorio. La lingua di destinazione della traduzione. I valori supportati sono i codici lingua BCP-47 (ad es. "en", "es", "fr").
echoTargetLanguage
boolean
Facoltativo. Se è true, il modello genererà l'audio quando viene pronunciata la lingua di destinazione, essenzialmente ripeterà l'input. Se il valore è false, non verrà prodotto audio per la lingua di destinazione.
| Rappresentazione JSON |
|---|
{ "targetLanguageCode": string, "echoTargetLanguage": boolean } |
AudioTranscriptionConfig
La configurazione della trascrizione audio.
languageCodes[]
string
Facoltativo. Codici lingua BCP-47 che forniscono suggerimenti sulle lingue presenti nell'audio. Se omesso o vuoto, il valore predefinito è il rilevamento automatico della lingua.
adaptationPhrases[]
(deprecated)
string
Facoltativo. Un elenco di frasi utilizzate per l'adattamento vocale, che influenza il modello ASR per migliorare il riconoscimento di questi termini specifici.
customVocabulary[]
string
Facoltativo. Un elenco di frasi del vocabolario personalizzato per orientare il modello di riconoscimento vocale verso il riconoscimento di termini specifici (nomi di prodotti, nomi propri, tecnicismi).
wordTimestamp
boolean
Facoltativo. Configura la generazione di timestamp a livello di parola.
diarization
boolean
Facoltativo. Configura la diarizzazione degli interlocutori.
language_config
Union type
language_codes di primo livello. language_config può essere solo uno dei seguenti tipi:languageAuto
(deprecated)
object (LanguageAuto)
Facoltativo. Il modello rileverà automaticamente la lingua.
languageHints
(deprecated)
object (LanguageHints)
Facoltativo. Specifica una o più lingue nell'audio.
| Rappresentazione JSON |
|---|
{ "languageCodes": [ string ], "adaptationPhrases": [ string ], "customVocabulary": [ string ], "wordTimestamp": boolean, "diarization": boolean, // language_config "languageAuto": { object ( |
LanguageAuto
Questo tipo non contiene campi.
Indica che la lingua dell'audio deve essere rilevata automaticamente.
LanguageHints
Fornisce suggerimenti al modello sulle possibili lingue presenti nell'audio.
languageCodes[]
(deprecated)
string
Obbligatorio. Codici lingua BCP-47.
| Rappresentazione JSON |
|---|
{ "languageCodes": [ string ] } |
RealtimeInputConfig
Configura il comportamento di input in tempo reale in BidiGenerateContent.
automaticActivityDetection
object (AutomaticActivityDetection)
Facoltativo. Se non viene impostato, il rilevamento automatico dell'attività è abilitato per impostazione predefinita. Se il rilevamento vocale automatico è disattivato, il client deve inviare segnali di attività.
activityHandling
enum (ActivityHandling)
Facoltativo. Definisce l'effetto dell'attività.
turnCoverage
enum (TurnCoverage)
Facoltativo. Definisce quale input è incluso nel turno dell'utente.
| Rappresentazione JSON |
|---|
{ "automaticActivityDetection": { object ( |
AutomaticActivityDetection
Configura il rilevamento automatico dell'attività.
disabled
boolean
Facoltativo. Se l'opzione è attiva (impostazione predefinita), l'input vocale e di testo rilevato viene conteggiato come attività. Se disattivato, il client deve inviare indicatori di attività.
startOfSpeechSensitivity
enum (StartSensitivity)
Facoltativo. Determina la probabilità che il parlato venga rilevato.
prefixPaddingMs
integer
Facoltativo. La durata richiesta del discorso rilevato prima dell'inizio del discorso. Più basso è questo valore, più sensibile è il rilevamento dell'inizio del discorso e più breve può essere il discorso riconosciuto. Tuttavia, questo aumenta anche la probabilità di falsi positivi.
endOfSpeechSensitivity
enum (EndSensitivity)
Facoltativo. Determina la probabilità che il discorso rilevato sia terminato.
silenceDurationMs
integer
Facoltativo. La durata richiesta del non parlato rilevato (ad es. silenzio) prima che venga eseguito il commit della fine del parlato. Maggiore è questo valore, più lunghi possono essere i silenzi nel discorso senza interrompere l'attività dell'utente, ma ciò aumenterà la latenza del modello.
| Rappresentazione JSON |
|---|
{ "disabled": boolean, "startOfSpeechSensitivity": enum ( |
StartSensitivity
Determina come viene rilevato l'inizio del discorso.
| Enum | |
|---|---|
START_SENSITIVITY_UNSPECIFIED |
Il valore predefinito è START_SENSITIVITY_HIGH. |
START_SENSITIVITY_HIGH |
Il rilevamento automatico rileverà più spesso l'inizio del discorso. |
START_SENSITIVITY_LOW |
Il rilevamento automatico rileverà l'inizio della conversazione meno spesso. |
EndSensitivity
Determina come viene rilevata la fine della conversazione.
| Enum | |
|---|---|
END_SENSITIVITY_UNSPECIFIED |
Il valore predefinito è END_SENSITIVITY_HIGH. |
END_SENSITIVITY_HIGH |
Il rilevamento automatico termina più spesso il discorso. |
END_SENSITIVITY_LOW |
Il rilevamento automatico termina il discorso meno spesso. |
ActivityHandling
I diversi modi di gestire l'attività utente.
| Enum | |
|---|---|
ACTIVITY_HANDLING_UNSPECIFIED |
Se non specificato, il comportamento predefinito è START_OF_ACTIVITY_INTERRUPTS. |
START_OF_ACTIVITY_INTERRUPTS |
Se il valore è true, l'inizio dell'attività interromperà la risposta del modello (anche chiamata "interruzione"). La risposta attuale del modello verrà interrotta nel momento dell'interruzione. Questo è il comportamento predefinito. |
NO_INTERRUPTION |
La risposta del modello non verrà interrotta. |
TurnCoverage
Opzioni relative all'input incluso nel turno dell'utente.
| Enum | |
|---|---|
TURN_COVERAGE_UNSPECIFIED |
Se non specificato, viene selezionato un comportamento predefinito in base al modello. Ad esempio, per Gemini 2.5, il valore predefinito è TURN_INCLUDES_ONLY_ACTIVITY, mentre per Gemini 3.1 e versioni successive è TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO. |
TURN_INCLUDES_ONLY_ACTIVITY |
Include l'attività dall'ultimo turno, escludendo l'inattività (ad es. il silenzio nello stream audio). |
TURN_INCLUDES_ALL_INPUT |
Include tutti gli input in tempo reale dall'ultimo turno, inclusa l'inattività (ad es. silenzio nello stream audio). |
TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO |
Include l'attività audio e tutti i video dall'ultimo turno. Con il rilevamento automatico dell'attività, l'attività audio si riferisce alla voce ed esclude il silenzio. |
SessionResumptionConfig
Configurazione della ripresa delle sessioni.
Questo messaggio è incluso nella configurazione della sessione come BidiGenerateContentSetup.session_resumption. Se configurato, il server invierà SessionResumptionUpdate messaggi.
handle
string
L'handle di una sessione precedente. Se non è presente, viene creata una nuova sessione.
Gli handle di sessione provengono dai valori SessionResumptionUpdate.token delle connessioni precedenti.
| Rappresentazione JSON |
|---|
{ "handle": string } |
ContextWindowCompressionConfig
Attiva la compressione della finestra contestuale, un meccanismo per gestire la finestra contestuale del modello in modo che non superi una determinata lunghezza.
compression_mechanism
Union type
compression_mechanism può essere solo uno dei seguenti tipi:slidingWindow
object (SlidingWindow)
Un meccanismo di finestra scorrevole.
triggerTokens
string (int64 format)
Il numero di token (prima di eseguire un turno) necessario per attivare una compressione della finestra contestuale.
Può essere utilizzato per bilanciare la qualità rispetto alla latenza, poiché finestre contestuali più brevi possono comportare risposte del modello più rapide. Tuttavia, qualsiasi operazione di compressione causerà un aumento temporaneo della latenza, pertanto non devono essere attivate di frequente.
Se non viene impostato, il valore predefinito è l'80% del limite della finestra contestuale del modello. Il 20% rimane disponibile per la successiva richiesta dell'utente/risposta del modello.
| Rappresentazione JSON |
|---|
{
// compression_mechanism
"slidingWindow": {
object ( |
SlidingWindow
Il metodo SlidingWindow funziona eliminando i contenuti all'inizio della finestra contestuale. Il contesto risultante inizierà sempre all'inizio del turno del ruolo UTENTE. Le istruzioni di sistema e qualsiasi BidiGenerateContentSetup.prefix_turns rimarranno sempre all'inizio del risultato.
targetTokens
string (int64 format)
Il numero di token di destinazione da conservare. Il valore predefinito è triggerTokens/2.
L'eliminazione di parti della finestra contestuale causa un aumento temporaneo della latenza, pertanto questo valore deve essere calibrato per evitare operazioni di compressione frequenti.
| Rappresentazione JSON |
|---|
{ "targetTokens": string } |
HistoryConfig
Configurazione della cronologia.
Questo messaggio è incluso nella configurazione della sessione come BidiGenerateContentSetup.history_config. Configura lo scambio di messaggi della cronologia.
initialHistoryInClientContent
boolean
Facoltativo. Se true, dopo l'invio di setupComplete, il server attenderà e inizialmente elaborerà clientContent messaggi finché turnComplete non sarà true. Questa cronologia iniziale non attiverà una chiamata del modello e potrebbe terminare con il ruolo MODEL. Dopo che turnComplete è true, il client può avviare la conversazione in tempo reale tramite realtimeInput.
| Rappresentazione JSON |
|---|
{ "initialHistoryInClientContent": boolean } |
Metodo: auth_tokens.create
Crea un token che può essere utilizzato per limitare il comportamento di una sessione BidiGenerateContent.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /auth_tokens
Corpo della richiesta
Il corpo della richiesta contiene un'istanza di AuthToken.
expireTime
string (Timestamp format)
Facoltativo. Solo input. Immutabile. Un orario facoltativo dopo il quale, quando si utilizza il token risultante, i messaggi nelle sessioni BidiGenerateContent verranno rifiutati. Gemini potrebbe chiudere la sessione in anticipo dopo questo periodo di tempo.
Se non viene impostato, il valore predefinito è 30 minuti nel futuro. Se impostato, questo valore deve essere inferiore a 20 ore nel futuro.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".
newSessionExpireTime
string (Timestamp format)
Facoltativo. Solo input. Immutabile. Il periodo di tempo dopo il quale le nuove sessioni dell'API Live che utilizzano il token risultante da questa richiesta verranno rifiutate.
Se non viene impostato, il valore predefinito è 60 secondi. Se impostato, questo valore deve essere inferiore a 20 ore nel futuro.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".
fieldMask
string (FieldMask format)
Facoltativo. Solo input. Immutabile. Se fieldMask è vuoto e bidiGenerateContentSetup non è presente, il messaggio BidiGenerateContentSetup effettivo viene recuperato dalla connessione API Live.
Se fieldMask è vuoto e bidiGenerateContentSetup è presente, il messaggio BidiGenerateContentSetup effettivo viene preso interamente da bidiGenerateContentSetup in questa richiesta. Il messaggio di configurazione della connessione API Live viene ignorato.
Se fieldMask non è vuoto, i campi corrispondenti di bidiGenerateContentSetup sovrascriveranno i campi del messaggio di configurazione nella connessione API live.
Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
config
Union type
config può essere solo uno dei seguenti tipi:bidiGenerateContentSetup
object (BidiGenerateContentSetup)
Facoltativo. Solo input. Immutabile. Configurazione specifica per BidiGenerateContent.
uses
integer
Facoltativo. Solo input. Immutabile. Il numero di volte in cui è possibile utilizzare il token. Se questo valore è zero, non viene applicato alcun limite. La ripresa di una sessione dell'API Live non viene conteggiata come utilizzo. Se non specificato, il valore predefinito è 1.
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di AuthToken appena creata.