L'API Gemini permet de générer du contenu avec des images, de l'audio, du code, des outils et plus encore. Pour en savoir plus sur chacune de ces fonctionnalités, lisez la suite et consultez l'exemple de code axé sur les tâches, ou lisez les guides complets.
- Génération de texte
- Vision
- Audio
- Embeddings
- Contexte long
- Exécution de code
- Mode JSON
- Appel de fonction
- Instructions système
Méthode : models.generateContent
- Point de terminaison
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Niveaux d'accès des autorisations
- Exemple de requête
Génère une réponse de modèle à partir d'une entrée GenerateContentRequest. Pour en savoir plus sur l'utilisation, consultez le guide de génération de texte. Les capacités d'entrée diffèrent d'un modèle à l'autre, y compris pour les modèles réglés. Pour en savoir plus, consultez le guide des modèles et le guide de réglage.
Point de terminaison
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
Paramètres de chemin d'accès
model
string
Obligatoire. Nom du Model à utiliser pour générer la complétion.
Format : models/{model}. Il se présente sous la forme models/{model}.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
tools[]
object (Tool)
Facultatif. Liste de Tools que le Model peut utiliser pour générer la réponse suivante.
Tool est une portion de code qui permet au système d'interagir avec des systèmes externes pour effectuer une action ou un ensemble d'actions en dehors du champ d'application et des connaissances du Model. Les Tool compatibles sont Function et codeExecution. Pour en savoir plus, consultez les guides Appel de fonction et Exécution de code.
toolConfig
object (ToolConfig)
Facultatif. Configuration de l'outil pour tout Tool spécifié dans la requête. Consultez le guide sur l'appel de fonction pour obtenir un exemple d'utilisation.
safetySettings[]
object (SafetySetting)
Facultatif. Liste d'instances SafetySetting uniques pour bloquer le contenu non sécurisé.
Cette mesure sera appliquée le GenerateContentRequest.contents et le GenerateContentResponse.candidates. Il ne doit pas y avoir plus d'un paramètre pour chaque type SafetyCategory. L'API bloquera tous les contenus et réponses qui ne respectent pas les seuils définis par ces paramètres. Cette liste remplace les paramètres par défaut de chaque SafetyCategory spécifié dans safetySettings. Si aucun SafetySetting n'est fourni pour un SafetyCategory donné dans la liste, l'API utilisera le paramètre de sécurité par défaut pour cette catégorie. Les catégories de préjudice HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY et HARM_CATEGORY_JAILBREAK sont acceptées. Consultez le guide pour en savoir plus sur les paramètres de sécurité disponibles. Consultez également les consignes de sécurité pour savoir comment intégrer des considérations de sécurité dans vos applications d'IA.
continuationToken
string (bytes format)
Facultatif. Jeton de continuation opaque utilisé pour reprendre la génération à partir d'une réponse models.generateContent ou models.streamGenerateContent précédente qui s'est arrêtée avec finishReason défini sur CONTINUATION. Notez que contents est obligatoire et doit reproduire à l'identique la requête et l'historique de la conversation de la requête initiale lorsqu'un jeton de continuation est fourni dans une requête.
Chaîne encodée en base64.
labels
map (key: string, value: string)
Facultatif. Étiquettes avec des métadonnées définies par l'utilisateur pour la requête.
Facultatif. Les étiquettes doivent respecter les exigences standards des étiquettes Cloud unifiées : les clés d'étiquette doivent commencer par une lettre. - Les clés et les valeurs d'étiquette ne peuvent pas dépasser 63 caractères (points de code Unicode) et ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. - Les caractères internationaux sont acceptés.
Utilisation : identifiants de sécurité des agrégateurs : utilisez la clé safety_identifier (par exemple, {"safety_identifier": "user_session_123"})
Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
systemInstruction
object (Content)
Facultatif. Instructions système définies par le développeur. Actuellement, seul le texte est accepté.
generationConfig
object (GenerationConfig)
Facultatif. Options de configuration pour la génération et les sorties du modèle.
cachedContent
string
Facultatif. Nom du contenu mis en cache à utiliser comme contexte pour réaliser la prédiction. Format : cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
Facultatif. Niveau de service de la requête.
store
boolean
Facultatif. Configure le comportement de journalisation pour une requête donnée. S'il est défini, il prévaut sur la configuration de journalisation au niveau du projet.
Exemple de requête
Texte
Python
Node.js
Go
Shell
Java
Image
Python
Node.js
Go
Shell
Java
Audio
Python
Node.js
Go
Shell
Vidéo
Python
Node.js
Go
Shell
Python
Go
Shell
Chat
Python
Node.js
Go
Shell
Java
Cache
Python
Node.js
Go
Modèle réglé
Python
Mode JSON
Python
Node.js
Go
Shell
Java
Exécution de code
Python
Go
Java
Appel de fonction
Python
Go
Node.js
Shell
Java
Configuration de la génération
Python
Node.js
Go
Shell
Java
Paramètres de sécurité
Python
Node.js
Go
Shell
Java
Instruction système
Python
Node.js
Go
Shell
Java
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de GenerateContentResponse.
Méthode : models.streamGenerateContent
- Point de terminaison
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Niveaux d'accès des autorisations
- Exemple de requête
Génère une réponse en streaming à partir du modèle en fonction d'une entrée GenerateContentRequest.
Point de terminaison
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
Paramètres de chemin d'accès
model
string
Obligatoire. Nom du Model à utiliser pour générer la complétion.
Format : models/{model}. Il se présente sous la forme models/{model}.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
tools[]
object (Tool)
Facultatif. Liste de Tools que le Model peut utiliser pour générer la réponse suivante.
Tool est une portion de code qui permet au système d'interagir avec des systèmes externes pour effectuer une action ou un ensemble d'actions en dehors du champ d'application et des connaissances du Model. Les Tool compatibles sont Function et codeExecution. Pour en savoir plus, consultez les guides Appel de fonction et Exécution de code.
toolConfig
object (ToolConfig)
Facultatif. Configuration de l'outil pour tout Tool spécifié dans la requête. Consultez le guide sur l'appel de fonction pour obtenir un exemple d'utilisation.
safetySettings[]
object (SafetySetting)
Facultatif. Liste d'instances SafetySetting uniques pour bloquer le contenu non sécurisé.
Cette mesure sera appliquée le GenerateContentRequest.contents et le GenerateContentResponse.candidates. Il ne doit pas y avoir plus d'un paramètre pour chaque type SafetyCategory. L'API bloquera tous les contenus et réponses qui ne respectent pas les seuils définis par ces paramètres. Cette liste remplace les paramètres par défaut de chaque SafetyCategory spécifié dans safetySettings. Si aucun SafetySetting n'est fourni pour un SafetyCategory donné dans la liste, l'API utilisera le paramètre de sécurité par défaut pour cette catégorie. Les catégories de préjudice HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY et HARM_CATEGORY_JAILBREAK sont acceptées. Consultez le guide pour en savoir plus sur les paramètres de sécurité disponibles. Consultez également les consignes de sécurité pour savoir comment intégrer des considérations de sécurité dans vos applications d'IA.
continuationToken
string (bytes format)
Facultatif. Jeton de continuation opaque utilisé pour reprendre la génération à partir d'une réponse models.generateContent ou models.streamGenerateContent précédente qui s'est arrêtée avec finishReason défini sur CONTINUATION. Notez que contents est obligatoire et doit reproduire à l'identique la requête et l'historique de la conversation de la requête initiale lorsqu'un jeton de continuation est fourni dans une requête.
Chaîne encodée en base64.
labels
map (key: string, value: string)
Facultatif. Étiquettes avec des métadonnées définies par l'utilisateur pour la requête.
Facultatif. Les étiquettes doivent respecter les exigences standards des étiquettes Cloud unifiées : les clés d'étiquette doivent commencer par une lettre. - Les clés et les valeurs d'étiquette ne peuvent pas dépasser 63 caractères (points de code Unicode) et ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. - Les caractères internationaux sont acceptés.
Utilisation : identifiants de sécurité des agrégateurs : utilisez la clé safety_identifier (par exemple, {"safety_identifier": "user_session_123"})
Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
systemInstruction
object (Content)
Facultatif. Instructions système définies par le développeur. Actuellement, seul le texte est accepté.
generationConfig
object (GenerationConfig)
Facultatif. Options de configuration pour la génération et les sorties du modèle.
cachedContent
string
Facultatif. Nom du contenu mis en cache à utiliser comme contexte pour réaliser la prédiction. Format : cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
Facultatif. Niveau de service de la requête.
store
boolean
Facultatif. Configure le comportement de journalisation pour une requête donnée. S'il est défini, il prévaut sur la configuration de journalisation au niveau du projet.
Exemple de requête
Texte
Python
Node.js
Go
Shell
Java
Image
Python
Node.js
Go
Shell
Java
Audio
Python
Go
Shell
Vidéo
Python
Node.js
Go
Shell
Python
Go
Shell
Chat
Python
Node.js
Go
Shell
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient un flux d'instances GenerateContentResponse.
GenerateContentResponse
Réponse du modèle compatible avec plusieurs réponses candidates.
Les évaluations de sécurité et le filtrage du contenu sont signalés pour la requête dans GenerateContentResponse.prompt_feedback, et pour chaque candidat dans finishReason et safetyRatings. L'API : - Renvoie tous les candidats demandés ou aucun d'entre eux - Ne renvoie aucun candidat uniquement si la requête comportait un problème (vérifiez promptFeedback) - Renvoie des commentaires sur chaque candidat dans finishReason et safetyRatings.
candidates[]
object (Candidate)
Réponses candidates du modèle.
promptFeedback
object (PromptFeedback)
Renvoie les commentaires de la requête liés aux filtres de contenu.
usageMetadata
object (UsageMetadata)
Uniquement en sortie. Métadonnées sur l'utilisation des jetons des requêtes de génération.
modelVersion
string
Uniquement en sortie. Version du modèle utilisée pour générer la réponse.
responseId
string
Uniquement en sortie. responseId permet d'identifier chaque réponse.
modelStatus
object (ModelStatus)
Uniquement en sortie. État actuel de ce modèle.
| Représentation JSON |
|---|
{ "candidates": [ { object ( |
PromptFeedback
Ensemble de métadonnées de commentaires spécifié par la requête dans GenerateContentRequest.content.
blockReason
enum (BlockReason)
Facultatif. Si cette option est définie, la requête a été bloquée et aucun candidat n'est renvoyé. Reformulez la requête.
safetyRatings[]
object (SafetyRating)
Évaluations de la sécurité de la requête. Il n'y a qu'une seule note par catégorie.
| Représentation JSON |
|---|
{ "blockReason": enum ( |
BlockReason
Spécifie la raison pour laquelle la requête a été bloquée.
| Enums | |
|---|---|
BLOCK_REASON_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
SAFETY |
La requête a été bloquée pour des raisons de sécurité. Inspectez safetyRatings pour comprendre quelle catégorie de sécurité l'a bloqué. |
OTHER |
La requête a été bloquée pour des raisons inconnues. |
BLOCKLIST |
La requête a été bloquée en raison des termes inclus dans la liste de blocage de terminologie. |
PROHIBITED_CONTENT |
La requête a été bloquée en raison de contenu interdit. |
IMAGE_SAFETY |
Candidats bloqués en raison d'un contenu de génération d'images dangereux. |
UsageMetadata
Métadonnées sur l'utilisation des jetons de la requête de génération.
promptTokenCount
integer
Nombre de jetons dans la requête. Lorsque cachedContent est défini, il s'agit toujours de la taille totale effective de la requête, ce qui signifie qu'elle inclut le nombre de jetons dans le contenu mis en cache.
cachedContentTokenCount
integer
Nombre de jetons dans la partie mise en cache de la requête (le contenu mis en cache)
candidatesTokenCount
integer
Nombre total de jetons pour toutes les réponses candidates générées.
toolUsePromptTokenCount
integer
Uniquement en sortie. Nombre de jetons présents dans les requêtes d'utilisation d'outils.
thoughtsTokenCount
integer
Uniquement en sortie. Nombre de jetons de pensées pour les modèles à raisonnement.
totalTokenCount
integer
Nombre total de jetons pour la requête de génération (prompt + prompt d'utilisation de l'outil + pensées + candidats de réponse).
promptTokensDetails[]
object (ModalityTokenCount)
Uniquement en sortie. Liste des modalités traitées dans l'entrée de la requête.
cacheTokensDetails[]
object (ModalityTokenCount)
Uniquement en sortie. Liste des modalités du contenu mis en cache dans l'entrée de la requête.
candidatesTokensDetails[]
object (ModalityTokenCount)
Uniquement en sortie. Liste des modalités renvoyées dans la réponse.
toolUsePromptTokensDetails[]
object (ModalityTokenCount)
Uniquement en sortie. Liste des modalités traitées pour les entrées de requête d'utilisation d'outils.
serviceTier
enum (ServiceTier)
Uniquement en sortie. Niveau de service de la requête.
| Représentation JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
ModelStatus
État du modèle sous-jacent. Il permet d'indiquer l'étape du modèle sous-jacent et l'heure de retrait, le cas échéant.
modelStage
enum (ModelStage)
Étape du modèle sous-jacent.
retirementTime
string (Timestamp format)
Date et heure auxquelles le modèle sera retiré.
Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
message
string
Message expliquant l'état du modèle.
| Représentation JSON |
|---|
{
"modelStage": enum ( |
ModelStage
Définit l'étape du modèle sous-jacent.
| Enums | |
|---|---|
MODEL_STAGE_UNSPECIFIED |
Étape de modèle non spécifiée. |
UNSTABLE_EXPERIMENTAL |
Le modèle sous-jacent fait l'objet de nombreux réglages. |
EXPERIMENTAL |
Les modèles à ce stade sont destinés uniquement à des fins expérimentales. |
PREVIEW |
Les modèles à ce stade sont plus matures que les modèles expérimentaux. |
STABLE |
Les modèles à ce stade sont considérés comme stables et prêts à être utilisés en production. |
LEGACY |
Si le modèle se trouve à ce stade, cela signifie qu'il sera bientôt obsolète. Seuls les clients existants peuvent utiliser ce modèle. |
DEPRECATED |
Les modèles à ce stade sont obsolètes. Ces modèles ne peuvent pas être utilisés. |
RETIRED |
Les modèles à ce stade sont retirés. Ces modèles ne peuvent pas être utilisés. |
Candidat
- Représentation JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- Image
- RetrievedContext
- CustomMetadata
- StringList
- Maps
- PlaceAnswerSources
- ReviewSnippet
- GroundingSupport
- Segment
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- Candidat
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
Réponse candidate générée à partir du modèle.
content
object (Content)
Uniquement en sortie. Contenu généré renvoyé par le modèle.
finishReason
enum (FinishReason)
Facultatif. Uniquement en sortie. Raison pour laquelle le modèle a cessé de générer des jetons.
Si ce champ est vide, le modèle n'a pas cessé de générer des jetons.
safetyRatings[]
object (SafetyRating)
Liste des notes de sécurité d'une réponse candidate.
Il n'y a qu'une seule note par catégorie.
citationMetadata
object (CitationMetadata)
Uniquement en sortie. Informations de citation pour le candidat généré par le modèle.
Ce champ peut être renseigné avec des informations de récitation pour tout texte inclus dans content. Il s'agit de passages "récités" à partir de contenus protégés par des droits d'auteur dans les données d'entraînement du LLM de base.
tokenCount
integer
Uniquement en sortie. Nombre de jetons pour ce candidat.
groundingAttributions[]
object (GroundingAttribution)
Uniquement en sortie. Informations d'attribution pour les sources qui ont contribué à une réponse ancrée.
Ce champ est renseigné pour les appels GenerateAnswer.
groundingMetadata
object (GroundingMetadata)
Uniquement en sortie. Métadonnées d'ancrage pour le candidat.
Ce champ est renseigné pour les appels GenerateContent.
avgLogprobs
number
Uniquement en sortie. Score de probabilité logarithmique moyen du candidat.
logprobsResult
object (LogprobsResult)
Uniquement en sortie. Scores de log-vraisemblance pour les jetons de réponse et les jetons principaux
urlContextMetadata
object (UrlContextMetadata)
Uniquement en sortie. Métadonnées liées à l'outil de récupération du contexte de l'URL.
continuationToken
string (bytes format)
Jeton de continuation opaque facultatif renvoyé lorsque finishReason est CONTINUATION. Les clients peuvent transmettre ce jeton dans un GenerateContentRequest ultérieur pour poursuivre la génération.
Chaîne encodée en base64.
index
integer
Uniquement en sortie. Index du candidat dans la liste des candidats de la réponse.
finishMessage
string
Facultatif. Uniquement en sortie. Détaille la raison pour laquelle le modèle a cessé de générer des jetons. Ce champ n'est renseigné que lorsque finishReason est défini.
| Représentation JSON |
|---|
{ "content": { object ( |
FinishReason
Définit la raison pour laquelle le modèle a cessé de générer des jetons.
| Enums | |
|---|---|
FINISH_REASON_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
STOP |
Point d'arrêt naturel du modèle ou séquence d'arrêt fournie. |
MAX_TOKENS |
Le nombre maximal de jetons spécifié dans la requête a été atteint. |
SAFETY |
Le contenu de la réponse candidate a été signalé pour des raisons de sécurité. |
RECITATION |
Le contenu de la réponse candidate a été signalé pour des raisons de récitation. |
LANGUAGE |
Le contenu de la réponse candidate a été signalé, car il utilise une langue non acceptée. |
OTHER |
Raison inconnue. |
BLOCKLIST |
La génération de jetons a été arrêtée, car le contenu comporte des termes interdits. |
PROHIBITED_CONTENT |
La génération de jetons a été arrêtée, car elle est susceptible de contenir du contenu interdit. |
SPII |
La génération de jetons a été arrêtée, car le contenu peut contenir des informations personnelles sensibles. |
MALFORMED_FUNCTION_CALL |
L'appel de fonction généré par le modèle n'est pas valide. |
IMAGE_SAFETY |
La génération de jetons a été arrêtée, car les images générées ne respectent pas les règles de sécurité. |
IMAGE_PROHIBITED_CONTENT |
La génération d'images a été arrêtée, car les images générées comportent d'autres contenus interdits. |
IMAGE_OTHER |
La génération d'images a été arrêtée en raison d'un autre problème. |
NO_IMAGE |
Le modèle devait générer une image, mais aucune n'a été générée. |
IMAGE_RECITATION |
La génération d'images a été arrêtée en raison d'une récitation. |
UNEXPECTED_TOOL_CALL |
Le modèle a généré un appel d'outil, mais aucun outil n'était activé dans la requête. |
TOO_MANY_TOOL_CALLS |
Le modèle a appelé trop d'outils consécutivement. Le système a donc arrêté l'exécution. |
MISSING_THOUGHT_SIGNATURE |
Il manque au moins une signature de pensée dans la requête. |
MALFORMED_RESPONSE |
Terminé en raison d'une réponse mal rédigée. |
ESCALATION |
La requête a été filtrée par une règle d'escalade. |
PUP_LIMITED_DISABLED |
Indique que la génération de jetons s'est arrêtée, car le compte utilisateur est limité ou désactivé en raison d'un non-respect du Règlement sur les utilisations interdites. |
CONTINUATION |
La génération de jetons a été arrêtée, car la réponse a atteint la limite de jetons par requête, mais la génération n'est pas encore terminée. La réponse du modèle peut être poursuivie via une requête ultérieure à l'aide du continuationToken renvoyé. Notez que maxOutputTokens est cumulatif sur les sauts de continuation et doit être augmenté de manière monotone ou omis. |
GroundingAttribution
Attribution d'une source ayant contribué à une réponse.
sourceId
object (AttributionSourceId)
Uniquement en sortie. Identifiant de la source contribuant à cette attribution.
content
object (Content)
Contenu de la source d'ancrage qui constitue cette attribution.
| Représentation JSON |
|---|
{ "sourceId": { object ( |
AttributionSourceId
Identifiant de la source contribuant à cette attribution.
source
Union type
groundingPassage
object (GroundingPassageId)
Identifiant d'un passage intégré.
semanticRetrieverChunk
object (SemanticRetrieverChunk)
Identifiant d'un Chunk récupéré via Semantic Retriever.
| Représentation JSON |
|---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
Identifiant d'une partie dans un GroundingPassage.
passageId
string
Uniquement en sortie. ID du passage correspondant à l'GroundingPassage.id de l'GenerateAnswerRequest.
partIndex
integer
Uniquement en sortie. Index de la partie dans le GroundingPassage.content de GenerateAnswerRequest.
| Représentation JSON |
|---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
Identifiant d'un Chunk récupéré via Semantic Retriever spécifié dans GenerateAnswerRequest à l'aide de SemanticRetrieverConfig.
source
string
Uniquement en sortie. Nom de la source correspondant au SemanticRetrieverConfig.source de la requête. Exemple : corpora/123 ou corpora/123/documents/abc
chunk
string
Uniquement en sortie. Nom de l'Chunk contenant le texte attribué. Exemple : corpora/123/documents/abc/chunks/xyz
| Représentation JSON |
|---|
{ "source": string, "chunk": string } |
GroundingMetadata
Métadonnées renvoyées au client lorsque l'ancrage est activé.
groundingChunks[]
object (GroundingChunk)
Liste des références complémentaires récupérées à partir de la source d'ancrage spécifiée. Lors du streaming, ce champ ne contient que les fragments d'ancrage qui n'ont pas été inclus dans les métadonnées d'ancrage des réponses précédentes.
groundingSupports[]
object (GroundingSupport)
Liste des supports d'ancrage.
webSearchQueries[]
string
Requêtes de recherche sur le Web pour la recherche sur le Web suivante.
imageSearchQueries[]
string
Requêtes de recherche d'images utilisées pour l'ancrage.
searchEntryPoint
object (SearchEntryPoint)
Facultatif. Entrée de recherche Google pour les recherches sur le Web suivantes.
retrievalMetadata
object (RetrievalMetadata)
Métadonnées liées à la récupération dans le flux d'ancrage.
googleMapsWidgetContextToken
string
Facultatif. Nom de ressource du jeton de contexte du widget Google Maps qui peut être utilisé avec le widget PlacesContextElement pour afficher des données contextuelles. N'est renseigné que si l'ancrage avec Google Maps est activé.
| Représentation JSON |
|---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Point d'entrée de la recherche Google.
renderedContent
string
Facultatif. Extrait de contenu Web pouvant être intégré à une page Web ou à une WebView d'application.
sdkBlob
string (bytes format)
Facultatif. JSON encodé en base64 représentant un tableau de tuples <terme de recherche, URL de recherche>.
Chaîne encodée en base64.
| Représentation JSON |
|---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
Un GroundingChunk représente un segment de preuve qui justifie la réponse du modèle. Il peut s'agir d'un extrait du Web, d'un contexte récupéré à partir d'un fichier ou d'informations provenant de Google Maps.
chunk_type
Union type
web
object (Web)
Segment d'ancrage issu du Web.
image
object (Image)
Facultatif. Fragment d'ancrage issu de la recherche d'images.
retrievedContext
object (RetrievedContext)
Facultatif. Segment d'ancrage du contexte récupéré par l'outil de recherche de fichiers.
maps
object (Maps)
Facultatif. Segment d'ancrage de Google Maps.
| Représentation JSON |
|---|
{ // chunk_type "web": { object ( |
Web
Extrait du Web.
uri
string
Uniquement en sortie. Référence URI du fragment.
title
string
Uniquement en sortie. Titre du fragment.
| Représentation JSON |
|---|
{ "uri": string, "title": string } |
Image
Extrait de la recherche d'images.
sourceUri
string
URI de la page Web pour l'attribution.
imageUri
string
URL du composant Image.
title
string
Titre de la page Web d'où provient l'image.
domain
string
Domaine racine de la page Web d'où provient l'image (par exemple, "example.com").
| Représentation JSON |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
RetrievedContext
Segment du contexte récupéré par l'outil de recherche de fichiers.
customMetadata[]
object (CustomMetadata)
Facultatif. Métadonnées fournies par l'utilisateur sur le contexte récupéré.
uri
string
Facultatif. Référence URI du document de récupération sémantique.
title
string
Facultatif. Titre du document.
text
string
Facultatif. Texte du fragment.
fileSearchStore
string
Facultatif. Nom de l'FileSearchStore contenant le document. Exemple : fileSearchStores/123
pageNumber
integer
Facultatif. Numéro de page du contexte récupéré, le cas échéant.
mediaId
string
Facultatif. Nom de ressource du blob multimédia pour les résultats de recherche de fichiers multimodaux. Format : fileSearchStores/{file_search_store_id}/media/{blobId}
| Représentation JSON |
|---|
{
"customMetadata": [
{
object ( |
CustomMetadata
Métadonnées fournies par l'utilisateur sur le GroundingFact.
key
string
Clé des métadonnées.
value
Union type
stringValue
string
Facultatif. Valeur de chaîne des métadonnées.
stringListValue
object (StringList)
Facultatif. Liste de valeurs de chaîne pour les métadonnées.
numericValue
number
Facultatif. Valeur numérique des métadonnées. La plage attendue pour cette valeur dépend de l'key utilisé.
| Représentation JSON |
|---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
Liste de valeurs de chaîne.
values[]
string
Valeurs de chaîne de la liste.
| Représentation JSON |
|---|
{ "values": [ string ] } |
Maps
Segment d'ancrage de Google Maps. Un fragment Maps correspond à un seul lieu.
uri
string
Référence URI du lieu.
title
string
Titre du lieu.
text
string
Description textuelle de la réponse concernant le lieu.
placeId
string
ID du lieu, au format places/{placeId}. Un utilisateur peut utiliser cet ID pour rechercher ce lieu.
placeAnswerSources
object (PlaceAnswerSources)
Sources qui fournissent des réponses sur les caractéristiques d'un lieu donné dans Google Maps.
| Représentation JSON |
|---|
{
"uri": string,
"title": string,
"text": string,
"placeId": string,
"placeAnswerSources": {
object ( |
PlaceAnswerSources
Ensemble de sources fournissant des réponses sur les caractéristiques d'un lieu donné dans Google Maps. Chaque message PlaceAnswerSources correspond à un lieu spécifique dans Google Maps. L'outil Google Maps a utilisé ces sources pour répondre à des questions sur les caractéristiques du lieu (par exemple, "Le Bar Foo propose-t-il le Wi-Fi ?" ou "Le Foo Bar est-il accessible en fauteuil roulant ?"). Pour le moment, nous n'acceptons que les extraits d'avis comme sources.
reviewSnippets[]
object (ReviewSnippet)
Extraits d'avis utilisés pour générer des réponses sur les caractéristiques d'un lieu donné dans Google Maps.
| Représentation JSON |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
Encapsule un extrait d'un avis utilisateur qui répond à une question sur les caractéristiques d'un lieu spécifique dans Google Maps.
reviewId
string
ID de l'extrait d'avis.
googleMapsUri
string
Lien correspondant à l'avis de l'utilisateur sur Google Maps.
title
string
Titre de l'avis.
| Représentation JSON |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
GroundingSupport
Compatibilité avec l'ancrage.
groundingChunkIndices[]
integer
Facultatif. Liste d'indices (dans "grounding_chunk" dans response.candidate.grounding_metadata) spécifiant les citations associées à l'affirmation. Par exemple, [1,3,4] signifie que grounding_chunk[1], grounding_chunk[3] et grounding_chunk[4] sont les contenus récupérés attribués à l'affirmation. Si la réponse est diffusée en streaming, les groundingChunkIndices font référence aux indices de toutes les réponses. Il incombe au client d'accumuler les fragments d'ancrage de toutes les réponses (tout en conservant le même ordre).
confidenceScores[]
number
Facultatif. Score de confiance des références d'assistance. Les valeurs vont de 0 à 1. 1 est le niveau de confiance le plus élevé. Cette liste doit avoir la même taille que groundingChunkIndices.
renderedParts[]
integer
Uniquement en sortie. Indices dans le champ parts du contenu du candidat. Ces indices spécifient les parties affichées qui sont associées à cette source d'assistance.
segment
object (Segment)
Segment du contenu auquel ce support appartient.
| Représentation JSON |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"renderedParts": [
integer
],
"segment": {
object ( |
Segment
Segment du contenu.
partIndex
integer
Index d'un objet Part dans son objet Content parent.
startIndex
integer
Index de début dans la partie donnée, mesuré en octets. Décalage par rapport au début de la partie, inclusif, commençant à zéro.
endIndex
integer
Index de fin dans la partie donnée, mesuré en octets. Décalage à partir du début de la partie, exclusif, commençant à zéro.
text
string
Texte correspondant au segment de la réponse.
| Représentation JSON |
|---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
Métadonnées liées à la récupération dans le flux d'ancrage.
googleSearchDynamicRetrievalScore
number
Facultatif. Score indiquant la probabilité que les informations de la recherche Google puissent aider à répondre à la requête. Le score est compris dans la plage [0, 1], où 0 est le moins probable et 1 est le plus probable. Ce score n'est renseigné que lorsque l'ancrage dans la recherche Google et la récupération dynamique sont activés. Il sera comparé au seuil pour déterminer s'il faut déclencher la recherche Google.
| Représentation JSON |
|---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Résultat des probabilités logarithmiques
topCandidates[]
object (TopCandidates)
Longueur = nombre total d'étapes de décodage.
chosenCandidates[]
object (Candidate)
Longueur = nombre total d'étapes de décodage. Les candidats choisis peuvent se trouver ou non dans topCandidates.
logProbabilitySum
number
Somme des probabilités logarithmiques pour tous les jetons.
| Représentation JSON |
|---|
{ "topCandidates": [ { object ( |
TopCandidates
Candidats ayant les probabilités logarithmiques les plus élevées à chaque étape de décodage.
candidates[]
object (Candidate)
Trié par probabilité de journal dans l'ordre décroissant.
| Représentation JSON |
|---|
{
"candidates": [
{
object ( |
Candidat
Candidat pour le jeton et le score logprobs.
token
string
Valeur de chaîne du jeton du candidat.
tokenId
integer
Valeur de l'ID de jeton du candidat.
logProbability
number
Probabilité logarithmique du candidat.
| Représentation JSON |
|---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
Métadonnées liées à l'outil de récupération du contexte de l'URL.
urlMetadata[]
object (UrlMetadata)
Liste des contextes d'URL.
| Représentation JSON |
|---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
Contexte de la récupération d'une seule URL.
retrievedUrl
string
URL récupérée par l'outil.
urlRetrievalStatus
enum (UrlRetrievalStatus)
État de la récupération de l'URL.
| Représentation JSON |
|---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
État de la récupération de l'URL.
| Enums | |
|---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
URL_RETRIEVAL_STATUS_SUCCESS |
La récupération de l'URL a réussi. |
URL_RETRIEVAL_STATUS_ERROR |
Échec de la récupération de l'URL en raison d'une erreur. |
URL_RETRIEVAL_STATUS_PAYWALL |
Échec de la récupération de l'URL, car le contenu se trouve derrière un paywall. |
URL_RETRIEVAL_STATUS_UNSAFE |
Échec de la récupération de l'URL, car le contenu n'est pas sûr. |
CitationMetadata
Ensemble d'attributions de sources pour un contenu.
citationSources[]
object (CitationSource)
Citations des sources pour une réponse spécifique.
| Représentation JSON |
|---|
{
"citationSources": [
{
object ( |
CitationSource
Une citation d'une source pour une partie d'une réponse spécifique.
startIndex
integer
Facultatif. Début du segment de la réponse attribué à cette source.
L'index indique le début du segment, mesuré en octets.
endIndex
integer
Facultatif. Fin du segment attribué, exclusive.
uri
string
Facultatif. URI attribué en tant que source pour une partie du texte.
license
string
Facultatif. Licence du projet GitHub attribué comme source du segment.
Les informations de licence sont requises pour les citations de code.
| Représentation JSON |
|---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
HarmCategory
Catégorie d'une classification.
Ces catégories couvrent différents types de préjudices que les développeurs peuvent souhaiter ajuster.
| Enums | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
La catégorie n'est pas spécifiée. |
HARM_CATEGORY_DEROGATORY |
PaLM : commentaires négatifs ou dangereux ciblant l'identité et/ou les attributs protégés. OBSOLÈTE : catégorie réservée à PaLM, non compatible avec les modèles Gemini. |
HARM_CATEGORY_TOXICITY |
PaLM : contenu offensant, irrespectueux ou grossier. OBSOLÈTE : catégorie réservée à PaLM, non compatible avec les modèles Gemini. |
HARM_CATEGORY_VIOLENCE |
PaLM : descriptions de scénarios représentant des actes de violence contre un individu ou un groupe, ou descriptions générales de contenus sanglants. OBSOLÈTE : catégorie réservée à PaLM, non compatible avec les modèles Gemini. |
HARM_CATEGORY_SEXUAL |
PaLM : contient des références à des actes sexuels ou à d'autres contenus obscènes. OBSOLÈTE : catégorie réservée à PaLM, non compatible avec les modèles Gemini. |
HARM_CATEGORY_MEDICAL |
PaLM : promeut des conseils médicaux non vérifiés. OBSOLÈTE : catégorie réservée à PaLM, non compatible avec les modèles Gemini. |
HARM_CATEGORY_DANGEROUS |
PaLM : contenu dangereux qui promeut, facilite ou encourage des actes dangereux. OBSOLÈTE : catégorie réservée à PaLM, non compatible avec les modèles Gemini. |
HARM_CATEGORY_HARASSMENT |
Gemini : contenu relevant du harcèlement. |
HARM_CATEGORY_HATE_SPEECH |
Gemini : incitation à la haine et contenus haineux. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini : contenu à caractère sexuel explicite. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini : contenu dangereux. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini : contenu susceptible d'être utilisé pour nuire à l'intégrité civique. OBSOLÈTE : utilisez enableEnhancedCivicAnswers à la place. |
HARM_CATEGORY_JAILBREAK |
Gemini : prompts tentant de contourner ou de subvertir les consignes de sécurité du modèle (tentatives de jailbreak). |
ModalityTokenCount
Représente les informations de comptage de jetons pour une seule modalité.
modality
enum (Modality)
Modalité associée à ce nombre de jetons.
tokenCount
integer
Nombre de jetons.
| Représentation JSON |
|---|
{
"modality": enum ( |
Modalité
Modalité Content Part
| Enums | |
|---|---|
MODALITY_UNSPECIFIED |
Modalité non spécifiée. |
TEXT |
Texte brut. |
IMAGE |
Image. |
VIDEO |
Vidéo. |
AUDIO |
Audio. |
DOCUMENT |
Document, par exemple un PDF. |
SafetyRating
Évaluation de sécurité d'un contenu.
L'évaluation de sécurité contient la catégorie de préjudice et le niveau de probabilité de préjudice dans cette catégorie pour un contenu. Le contenu est classé par sécurité dans un certain nombre de catégories de préjudice, et la probabilité de la classification des préjudices est incluse ici.
category
enum (HarmCategory)
Obligatoire. Catégorie de cette note.
probability
enum (HarmProbability)
Obligatoire. Probabilité de préjudice pour ce contenu.
blocked
boolean
Ce contenu a-t-il été bloqué en raison de cette classification ?
| Représentation JSON |
|---|
{ "category": enum ( |
HarmProbability
Probabilité qu'un contenu soit nuisible.
Le système de classification indique la probabilité que le contenu soit dangereux. Cela n'indique pas la gravité du préjudice causé par un contenu.
| Enums | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED |
La probabilité n'est pas spécifiée. |
NEGLIGIBLE |
Le contenu présente une probabilité négligeable d'être non sécurisé. |
LOW |
Le contenu présente peu de risques d'être non sécurisé. |
MEDIUM |
Le contenu présente une probabilité moyenne d'être non sécurisé. |
HIGH |
Le contenu est très susceptible d'être non sécurisé. |
SafetySetting
Paramètre de sécurité, qui affecte le comportement de blocage de sécurité.
La transmission d'un paramètre de sécurité pour une catégorie modifie la probabilité autorisée de blocage du contenu.
category
enum (HarmCategory)
Obligatoire. Catégorie de ce paramètre.
threshold
enum (HarmBlockThreshold)
Obligatoire. Contrôle le seuil de probabilité à partir duquel le contenu nuisible est bloqué.
| Représentation JSON |
|---|
{ "category": enum ( |
HarmBlockThreshold
Bloquer à partir d'une probabilité de préjudice spécifiée.
| Enums | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
Le seuil n'est pas spécifié. |
BLOCK_LOW_AND_ABOVE |
Les contenus avec un niveau de risque NÉGLIGEABLE seront autorisés. |
BLOCK_MEDIUM_AND_ABOVE |
Les contenus dont le niveau de risque est NEGLIGIBLE (NÉGLIGEABLE) et LOW (FAIBLE) seront autorisés. |
BLOCK_ONLY_HIGH |
Les contenus dont le niveau de risque est NEGLIGIBLE, LOW et MEDIUM seront autorisés. |
BLOCK_NONE |
Tous les contenus seront autorisés. |
OFF |
Désactivez le filtre de sécurité. |
ServiceTier
Niveau de service de la requête.
| Enums | |
|---|---|
unspecified |
Niveau de service par défaut, qui est standard. |
standard |
Niveau de service Standard. |
flex |
Niveau de service Flex. |
priority |
Niveau de service prioritaire. |
Contenu
- Représentation JSON
- Part
- Blob
- FunctionCall
- FunctionResponse
- FunctionResponsePart
- FunctionResponseBlob
- Planification
- FileData
- ExecutableCode
- Langue
- CodeExecutionResult
- Résultat
- ToolCall
- ToolType
- ToolResponse
- VideoMetadata
- MediaResolution
- Niveau
- MediaProcessing
- AudioTranscription
- WordInfo
- SpeechMetadata
Type de données structurées de base comportant le contenu en plusieurs parties d'un message.
Un Content inclut un champ role désignant le producteur du Content et un champ parts contenant des données en plusieurs parties qui contiennent le contenu du tour de message.
parts[]
object (Part)
Parts ordonnés qui constituent un seul message. Les parties peuvent avoir différents types MIME.
role
string
Facultatif. Producteur du contenu. La valeur doit être "user" ou "model".
Utile pour les conversations multitours. Sinon, peut être vide ou non défini.
| Représentation JSON |
|---|
{
"parts": [
{
object ( |
Partie
Type de données comportant du contenu multimédia qui fait partie d'un message Content en plusieurs parties.
Un Part se compose de données auxquelles est associé un type de données. Un Part ne peut contenir qu'un seul des types acceptés dans Part.data.
Un Part doit avoir un type MIME IANA fixe identifiant le type et le sous-type du média si le champ inlineData est rempli avec des octets bruts.
thought
boolean
Facultatif. Indique si la partie est une réflexion du modèle.
thoughtSignature
string (bytes format)
Facultatif. Signature opaque de la pensée, qui peut être réutilisée dans les requêtes ultérieures.
Chaîne encodée en base64.
partMetadata
object (Struct format)
Métadonnées personnalisées associées à la pièce. Les agents qui utilisent genai.Part comme représentation de contenu peuvent avoir besoin de suivre les informations supplémentaires. Par exemple, il peut s'agir du nom d'un fichier/d'une source d'où provient la partie ou d'un moyen de multiplexer plusieurs flux de parties.
mediaResolution
object (MediaResolution)
Facultatif. Résolution du contenu multimédia d'entrée.
mediaProcessing
enum (MediaProcessing)
Facultatif. Comment le modèle traite le contenu multimédia de cette partie pour le comprendre. Ne s'applique qu'aux parties vidéo (inlineData ou fileData avec un type MIME vidéo). Les parties non vidéo ignorent ce champ.
audioTranscription
object (AudioTranscription)
Facultatif. Transcription audio (entrée ou sortie). Ce champ n'est défini que lorsque cette partie contient des données audio.
speechMetadata
object (SpeechMetadata)
Facultatif. Métadonnées appliquées à des parties de texte pour personnaliser la façon dont elles doivent être prononcées ou synthétisées, par exemple en spécifiant l'identité du locuteur ou le style de parole.
data
Union type
text
string
Texte intégré.
inlineData
object (Blob)
Octets multimédias intégrés.
functionCall
object (FunctionCall)
FunctionCall prédit renvoyé par le modèle et qui contient une chaîne représentant le FunctionDeclaration.name avec les arguments et leurs valeurs.
functionResponse
object (FunctionResponse)
Le résultat d'un FunctionCall contenant une chaîne représentant la FunctionDeclaration.name et un objet JSON structuré contenant tout résultat de la fonction est utilisé comme contexte pour le modèle.
fileData
object (FileData)
Données basées sur l'URI.
executableCode
object (ExecutableCode)
Code généré par le modèle destiné à être exécuté.
codeExecutionResult
object (CodeExecutionResult)
Résultat de l'exécution de ExecutableCode.
toolCall
object (ToolCall)
Appel d'outil côté serveur. Ce champ est renseigné lorsque le modèle prédit l'appel d'un outil qui doit être exécuté sur le serveur. Le client doit renvoyer ce message à l'API.
toolResponse
object (ToolResponse)
Sortie d'une exécution ToolCall côté serveur. Ce champ est renseigné par le client avec les résultats de l'exécution de l'ToolCall correspondant.
metadata
Union type
inline_data ou file_data est présent pour configurer le prétraitement des contenus multimédias statiques par partie. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :videoMetadata
object (VideoMetadata)
Facultatif. Métadonnées de vidéo. Vous ne devez spécifier les métadonnées que lorsque les données vidéo sont présentées dans inlineData ou fileData.
| Représentation JSON |
|---|
{ "thought": boolean, "thoughtSignature": string, "partMetadata": { object }, "mediaResolution": { object ( |
Blob
Octets multimédias bruts.
Le texte ne doit pas être envoyé sous forme d'octets bruts. Utilisez le champ "text".
mimeType
string
Type MIME standard IANA des données sources. Exemples de types acceptés : - Images : image/png, image/jpeg, image/jpg, image/webp, image/heic, image/heif, image/gif, image/avif - Audio : audio/*, video/audio/s16le, video/audio/wav - Vidéo : video/* - Texte : 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 - Applications : application/x-javascript, application/x-typescript, application/x-python-code, application/json, application/x-ipynb+json, application/rtf, application/pdf Pour en savoir plus, consultez Formats de fichiers acceptés. //
data
string (bytes format)
Octets bruts pour les formats multimédias.
Chaîne encodée en base64.
displayName
string
Facultatif. Spécifie le nom utilisé pour faire référence à ce blob dans le modèle (par exemple, "my_blob.png"). Utilisé comme identifiant de référence du blob lorsque verbalizationMode est défini sur REFERENCE_ONLY.
| Représentation JSON |
|---|
{ "mimeType": string, "data": string, "displayName": string } |
FunctionCall
FunctionCall prédit renvoyé par le modèle et qui contient une chaîne représentant le FunctionDeclaration.name avec les arguments et leurs valeurs.
id
string
Facultatif. Identifiant unique de l'appel de fonction. Si ce champ est renseigné, le client doit exécuter les functionCall et renvoyer la réponse avec les id correspondants.
name
string
Obligatoire. Nom de la fonction à appeler. Il doit être composé de a-z, A-Z, 0-9, ou contenir des traits de soulignement et des tirets, avec une longueur maximale de 128.
args
object (Struct format)
Facultatif. Paramètres et valeurs de la fonction au format d'objet JSON.
| Représentation JSON |
|---|
{ "id": string, "name": string, "args": { object } } |
FunctionResponse
Le résultat d'une FunctionCall contenant une chaîne représentant la FunctionDeclaration.name et un objet JSON structuré contenant tout résultat de la fonction est utilisé comme contexte pour le modèle. Doit contenir le résultat d'une opération FunctionCall effectuée en fonction de la prédiction du modèle.
id
string
Facultatif. Identifiant de l'appel de fonction auquel cette réponse est destinée. Renseigné par le client pour correspondre à l'appel de fonction id correspondant.
name
string
Obligatoire. Nom de la fonction à appeler. Il doit être composé de a-z, A-Z, 0-9, ou contenir des traits de soulignement et des tirets, avec une longueur maximale de 128.
response
object (Struct format)
Obligatoire. Réponse de la fonction au format d'objet JSON. Les appelants peuvent utiliser les clés de leur choix qui correspondent à la syntaxe de la fonction pour renvoyer la sortie de la fonction, par exemple "output", "result", etc. En particulier, si l'appel de fonction n'a pas pu s'exécuter, la réponse peut comporter une clé "error" pour renvoyer les détails de l'erreur au modèle.
Vous pouvez inclure du contenu multimédia à l'aide d'un sous-objet contenant une seule clé "$ref" dont la valeur est le inlineData.display_name d'un FunctionResponsePart contenant le contenu multimédia. Consultez https://ai.google.dev/gemini-api/docs/function-calling#multimodal.
parts[]
object (FunctionResponsePart)
Facultatif. Parts ordonnés qui constituent une réponse de fonction. Les parties peuvent avoir différents types MIME IANA.
willContinue
boolean
Facultatif. Indique que l'appel de fonction se poursuit et que d'autres réponses seront renvoyées, transformant l'appel de fonction en générateur. S'applique uniquement aux appels de fonction NON_BLOCKING, est ignoré dans le cas contraire. Si la valeur est "false", les réponses futures ne seront pas prises en compte. Il est autorisé de renvoyer un response vide avec willContinue=False pour signaler que l'appel de fonction est terminé. Cela peut toujours déclencher la génération du modèle. Pour éviter de déclencher la génération et terminer l'appel de fonction, définissez également scheduling sur SILENT.
scheduling
enum (Scheduling)
Facultatif. Spécifie comment la réponse doit être planifiée dans la conversation. S'applique uniquement aux appels de fonction NON_BLOCKING. Sinon, il est ignoré. La valeur par défaut est WHEN_IDLE.
| Représentation JSON |
|---|
{ "id": string, "name": string, "response": { object }, "parts": [ { object ( |
FunctionResponsePart
Type de données contenant du contenu multimédia faisant partie d'un message FunctionResponse.
Un FunctionResponsePart se compose de données auxquelles est associé un type de données. Un FunctionResponsePart ne peut contenir qu'un seul des types acceptés dans FunctionResponsePart.data.
Un FunctionResponsePart doit avoir un type MIME IANA fixe identifiant le type et le sous-type du média si le champ inlineData est rempli avec des octets bruts.
data
Union type
inlineData
object (FunctionResponseBlob)
Octets multimédias intégrés.
| Représentation JSON |
|---|
{
// data
"inlineData": {
object ( |
FunctionResponseBlob
Octets multimédias bruts pour la réponse de la fonction.
Le texte ne doit pas être envoyé sous forme d'octets bruts. Utilisez le champ "FunctionResponse.response".
mimeType
string
Type MIME standard IANA des données sources. Exemples : - image/png - image/jpeg. Si un type MIME non compatible est fourni, une erreur est renvoyée. Pour obtenir la liste complète des types de fichiers compatibles, consultez Formats de fichiers compatibles.
data
string (bytes format)
Octets bruts pour les formats multimédias.
Chaîne encodée en base64.
| Représentation JSON |
|---|
{ "mimeType": string, "data": string } |
Planification
Spécifie comment la réponse doit être planifiée dans la conversation.
| Enums | |
|---|---|
SCHEDULING_UNSPECIFIED |
Cette valeur n'est pas utilisée. |
SILENT |
Ajoutez uniquement le résultat au contexte de la conversation, n'interrompez pas ni ne déclenchez la génération. |
WHEN_IDLE |
Ajoutez le résultat au contexte de la conversation et demandez à générer une sortie sans interrompre la génération en cours. |
INTERRUPT |
Ajoutez le résultat au contexte de la conversation, interrompez la génération en cours et demandez à générer une sortie. |
FileData
Données basées sur l'URI.
mimeType
string
Facultatif. Type MIME standard IANA des données sources.
fileUri
string
Obligatoire. URI.
displayName
string
Facultatif. Spécifie le nom utilisé pour faire référence à ce fichier dans le modèle (par exemple, "mon_fichier.pdf"). Utilisé comme identifiant de référence de fichier lorsque verbalizationMode est défini sur REFERENCE_ONLY.
| Représentation JSON |
|---|
{ "mimeType": string, "fileUri": string, "displayName": string } |
ExecutableCode
Code généré par le modèle destiné à être exécuté, et résultat renvoyé au modèle.
Généré uniquement lors de l'utilisation de l'outil CodeExecution, dans lequel le code sera exécuté automatiquement, et un CodeExecutionResult correspondant sera également généré.
id
string
Facultatif. Identifiant unique de la partie ExecutableCode. Le serveur renvoie le CodeExecutionResult avec le id correspondant.
language
enum (Language)
Obligatoire. Langage de programmation de code.
code
string
Obligatoire. Code à exécuter.
| Représentation JSON |
|---|
{
"id": string,
"language": enum ( |
Langue
Langages de programmation compatibles avec le code généré.
| Enums | |
|---|---|
LANGUAGE_UNSPECIFIED |
Langue non précisée. Cette valeur ne doit pas être utilisée. |
PYTHON |
Python >= 3.10, avec numpy et simpy disponibles. Python est le langage par défaut. |
CodeExecutionResult
Résultat de l'exécution de ExecutableCode.
Généré uniquement lorsque l'outil CodeExecution est utilisé.
id
string
Facultatif. Identifiant de la partie ExecutableCode à laquelle ce résultat est destiné. N'est renseigné que si l'élément ExecutableCode correspondant possède un ID.
outcome
enum (Outcome)
Obligatoire. Résultat de l'exécution de code.
output
string
Facultatif. Contient stdout lorsque l'exécution de code réussit, stderr ou une autre description dans le cas contraire.
| Représentation JSON |
|---|
{
"id": string,
"outcome": enum ( |
Résultat
Énumération des résultats possibles de l'exécution de code.
| Enums | |
|---|---|
OUTCOME_UNSPECIFIED |
État non spécifié. Cette valeur ne doit pas être utilisée. |
OUTCOME_OK |
Le code a bien été exécuté. output contient la sortie standard, le cas échéant. |
OUTCOME_FAILED |
Échec de l'exécution de code. output contient les erreurs standards (stderr) et les sorties standards (stdout), le cas échéant. |
OUTCOME_DEADLINE_EXCEEDED |
L'exécution du code a duré trop longtemps et a été annulée. Il peut y avoir ou non un output partiel. |
ToolCall
Une valeur ToolCall côté serveur prédite renvoyée par le modèle. Ce message contient des informations sur un outil que le modèle souhaite appeler. Le client n'est PAS censé exécuter ce ToolCall. Le client doit plutôt renvoyer ce ToolCall à l'API lors d'un tour ultérieur dans un message Content, ainsi que le ToolResponse correspondant.
id
string
Facultatif. Identifiant unique de l'appel d'outil. Le serveur renvoie la réponse de l'outil avec l'id correspondant.
toolName
string
Facultatif. Nom de l'outil appelé.
toolType
enum (ToolType)
Obligatoire. Type d'outil appelé.
args
object (Struct format)
Facultatif. Arguments de l'appel d'outil. Exemple : {"arg1" : "value1", "arg2" : "value2" , ...}
| Représentation JSON |
|---|
{
"id": string,
"toolName": string,
"toolType": enum ( |
ToolType
Type d'outil dans l'appel de fonction.
| Enums | |
|---|---|
TOOL_TYPE_UNSPECIFIED |
Type d'outil non spécifié. |
GOOGLE_SEARCH_WEB |
Outil de recherche Google, mappé sur Tool.google_search.search_types.web_search. |
GOOGLE_SEARCH_IMAGE |
Outil de recherche d'images, mappé sur Tool.google_search.search_types.image_search. |
URL_CONTEXT |
Outil de contexte d'URL, mappé sur Tool.url_context. |
GOOGLE_MAPS |
Outil Google Maps, mappé sur Tool.google_maps. |
FILE_SEARCH |
Outil de recherche de fichiers, mappé à Tool.file_search. |
ToolResponse
Sortie d'une exécution ToolCall côté serveur. Ce message contient les résultats d'un appel d'outil initié par un ToolCall du modèle. Le client doit renvoyer ce ToolResponse à l'API lors d'un tour ultérieur dans un message Content, ainsi que le ToolCall correspondant.
id
string
Facultatif. Identifiant de l'appel d'outil auquel cette réponse est destinée.
toolType
enum (ToolType)
Obligatoire. Type d'outil appelé, correspondant à toolType dans le ToolCall correspondant.
response
object (Struct format)
Facultatif. Réponse de l'outil.
| Représentation JSON |
|---|
{
"id": string,
"toolType": enum ( |
VideoMetadata
Les métadonnées décrivent le contenu vidéo d'entrée. Définissez cette option dans Part.video_metadata ou FunctionResponsePart.video_metadata lorsque inlineData ou fileData contient une vidéo pour configurer le prétraitement vidéo statique (par exemple, le découpage temporel, la fréquence d'images, le nombre maximal d'images ou les couches de contenu extraites).
startOffset
string (Duration format)
Facultatif. Décalage de début de la vidéo.
Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
endOffset
string (Duration format)
Facultatif. Décalage de fin de la vidéo.
Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
fps
number
Facultatif. Fréquence d'images de la vidéo envoyée au modèle. Si aucune valeur n'est spécifiée, la valeur par défaut est 1.0. La plage de fps est (0.0, 24.0].
| Représentation JSON |
|---|
{ "startOffset": string, "endOffset": string, "fps": number } |
MediaResolution
Résolution multimédia pour la tokenisation.
value
Union type
level
enum (Level)
Qualité de la tokenisation utilisée pour un contenu multimédia donné.
| Représentation JSON |
|---|
{
// value
"level": enum ( |
Niveau
Niveau de résolution des contenus multimédias.
| Enums | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
La résolution multimédia n'a pas été définie. |
MEDIA_RESOLUTION_LOW |
La résolution des contenus multimédias est définie sur "Faible". |
MEDIA_RESOLUTION_MEDIUM |
Résolution multimédia définie sur "moyenne". |
MEDIA_RESOLUTION_HIGH |
La résolution multimédia est définie sur "Élevée". |
MEDIA_RESOLUTION_ULTRA_HIGH |
Résolution multimédia définie sur "Ultra-haute". |
MediaProcessing
Comment le modèle traite les contenus multimédias d'entrée pour les comprendre.
| Enums | |
|---|---|
MEDIA_PROCESSING_UNSPECIFIED |
La valeur par défaut est le traitement spécifique au modèle. |
STATIC |
Extraction d'images à fréquence fixe. Toutes les images placées en contexte. |
AGENTIC |
Navigation dynamique basée sur un modèle. Recommandé pour la plupart des cas d'utilisation. |
AudioTranscription
Transcription d'une partie audio. Pour l'audio avec plusieurs locuteurs, chaque segment de locuteur est une partie distincte avec sa propre AudioTranscription portant le speakerLabel.
text
string
Obligatoire. Texte de transcription de ce segment audio.
speakerLabel
string
Facultatif. Libellé identifiant l'intervenant de ce segment audio (par exemple, "spk_1", "spk_2"). Présent lorsque la diarisation est définie.
words[]
object (WordInfo)
Facultatif. Transcriptions détaillées au niveau des mots et détails de minutage. Présent lorsque wordTimestamp est défini.
| Représentation JSON |
|---|
{
"text": string,
"speakerLabel": string,
"words": [
{
object ( |
WordInfo
Informations sur un seul mot reconnu.
word
string
Obligatoire. Transcription du mot.
startOffset
string (Duration format)
Facultatif. Décalage temporel du début du mot par rapport au début de l'audio.
Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
endOffset
string (Duration format)
Facultatif. Décalage de fin dans le temps du mot par rapport au début de l'audio.
Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
| Représentation JSON |
|---|
{ "word": string, "startOffset": string, "endOffset": string } |
SpeechMetadata
Métadonnées vocales pour les parties text.
speaker
string
Facultatif. Nom de l'intervenant facultatif pour la synthèse multi-intervenants.
style
string
Facultatif. Instruction de style facultative pour la synthèse vocale.
| Représentation JSON |
|---|
{ "speaker": string, "style": string } |
Environnement
Environnement d'exécution d'un agent.
id
string
Obligatoire. Uniquement en sortie. ID de l'environnement.
sources[]
object (Source)
Sources à installer dans l'environnement.
created
string
Uniquement en sortie. Heure à laquelle l'environnement a été créé, au format ISO 8601 (AAAA-MM-JJThh:mm:ssZ).
updated
string
Uniquement en sortie. Heure de la dernière mise à jour de l'environnement au format ISO 8601 (AAAA-MM-JJThh:mm:ssZ).
lastAccessed
string
Uniquement en sortie. Heure du dernier accès à l'environnement au format ISO 8601 (AAAA-MM-JJThh:mm:ssZ).
status
enum (Status)
Uniquement en sortie. État du conteneur d'environnement.
fileCount
string (int64 format)
Uniquement en sortie. Nombre de fichiers dans l'environnement (en sortie uniquement).
sizeBytes
string (int64 format)
Uniquement en sortie. Taille totale des fichiers d'environnement en octets, en sortie uniquement.
network
Union type
networkAllowlist
object (EnvironmentNetworkEgressAllowlist)
Autoriser uniquement des domaines spécifiques.
networkMode
enum (NetworkMode)
Mode de sortie réseau.
| Représentation JSON |
|---|
{ "id": string, "sources": [ { object ( |
État
État de l'environnement.
| Enums | |
|---|---|
STATUS_UNSPECIFIED |
|
ACTIVE |
|
EXPIRED |
|
NetworkMode
Mode de sortie réseau pour les configurations ne figurant pas sur la liste d'autorisation.
| Enums | |
|---|---|
NETWORK_MODE_UNSPECIFIED |
Valeur par défaut. Non utilisé. |
DISABLED |
Toute sortie réseau est bloquée. |
Schéma
L'objet Schema permet de définir les types de données d'entrée et de sortie. Ces types peuvent être des objets, mais aussi des primitives et des tableaux. Représente un sous-ensemble spécifique d'un objet de schéma OpenAPI 3.0.
type
enum (Type)
Obligatoire. Type de données.
format
string
Facultatif. Format des données. Toutes les valeurs sont autorisées, mais la plupart ne déclenchent aucune fonctionnalité spéciale.
title
string
Facultatif. Titre du schéma.
description
string
Facultatif. Brève description du paramètre. Il peut contenir des exemples d'utilisation. La description du paramètre peut être au format Markdown.
nullable
boolean
Facultatif. Indique si la valeur peut être nulle.
enum[]
string
Facultatif. Valeurs possibles de l'élément de type Type.STRING avec le format enum. Par exemple, il est possible de définir une direction d'énumération comme suit : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
maxItems
string (int64 format)
Facultatif. Nombre maximal d'éléments pour Type.ARRAY.
minItems
string (int64 format)
Facultatif. Nombre minimal d'éléments pour Type.ARRAY.
properties
map (key: string, value: object (Schema))
Facultatif. Propriétés de Type.OBJECT.
Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]
string
Facultatif. Propriétés obligatoires de Type.OBJECT.
minProperties
string (int64 format)
Facultatif. Nombre minimal de propriétés pour Type.OBJECT.
maxProperties
string (int64 format)
Facultatif. Nombre maximal de propriétés pour Type.OBJECT.
minLength
string (int64 format)
Facultatif. CHAMPS DE SCHÉMA POUR LE TYPE STRING Longueur minimale du Type.STRING
maxLength
string (int64 format)
Facultatif. Longueur maximale de Type.STRING
pattern
string
Facultatif. Modèle de Type.STRING pour limiter une chaîne à une expression régulière.
example
value (Value format)
Facultatif. Exemple d'objet. N'est renseigné que lorsque l'objet est la racine.
anyOf[]
object (Schema)
Facultatif. La valeur doit être validée par rapport à un ou plusieurs des sous-schémas de la liste.
propertyOrdering[]
string
Facultatif. L'ordre des propriétés. Il ne s'agit pas d'un champ standard dans la spécification OpenAPI. Il permet de déterminer l'ordre des propriétés dans la réponse.
default
value (Value format)
Facultatif. Valeur par défaut du champ. Conformément au schéma JSON, ce champ est destiné aux générateurs de documentation et n'affecte pas la validation. Il est donc inclus ici et ignoré afin que les développeurs qui envoient des schémas avec un champ default ne reçoivent pas d'erreurs de champ inconnu.
items
object (Schema)
Facultatif. Schéma des éléments de Type.ARRAY.
minimum
number
Facultatif. CHAMPS DE SCHÉMA POUR LES TYPES INTEGER ET NUMBER Valeur minimale des types INTEGER et NUMBER
maximum
number
Facultatif. Valeur maximale de Type.INTEGER et Type.NUMBER
| Représentation JSON |
|---|
{ "type": enum ( |
Type
"Type" contient la liste des types de données OpenAPI, tels que définis par https://spec.openapis.org/oas/v3.0.3#data-types.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Non spécifié, ne doit pas être utilisé. |
STRING |
Type de chaîne. |
NUMBER |
Type de nombre. |
INTEGER |
Type entier. |
BOOLEAN |
Type booléen. |
ARRAY |
Type de tableau. |
OBJECT |
Type d'objet. |
NULL |
Type nul. |
Outil
- Représentation JSON
- FunctionDeclaration
- Comportement
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- Mode
- CodeExecution
- GoogleSearch
- Interval
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- Environment
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
Détails de l'outil que le modèle peut utiliser pour générer une réponse.
Tool est une portion de code qui permet au système d'interagir avec des systèmes externes pour effectuer une action ou un ensemble d'actions en dehors du champ d'application et des connaissances du modèle.
functionDeclarations[]
object (FunctionDeclaration)
Facultatif. Liste des FunctionDeclarations disponibles pour le modèle qui peuvent être utilisés pour l'appel de fonction.
Le modèle ou le système n'exécute pas la fonction. À la place, la fonction définie peut être renvoyée en tant que FunctionCall avec des arguments côté client pour l'exécution. Le modèle peut décider d'appeler un sous-ensemble de ces fonctions en renseignant FunctionCall dans la réponse. Le tour de conversation suivant peut contenir un FunctionResponse avec le contexte de génération Content.role "function" pour le tour de modèle suivant.
googleSearchRetrieval
object (GoogleSearchRetrieval)
Facultatif. Outil de récupération optimisé par la recherche Google.
codeExecution
object (CodeExecution)
Facultatif. Permet au modèle d'exécuter du code dans le cadre de la génération.
googleSearch
object (GoogleSearch)
Facultatif. Type d'outil GoogleSearch. Outil permettant d'utiliser la recherche Google dans le modèle. La puissance de la technologie Google
computerUse
object (ComputerUse)
Facultatif. Outil permettant au modèle d'interagir directement avec l'ordinateur. Si cette option est activée, elle remplit automatiquement les déclarations de fonction spécifiques à l'utilisation de l'ordinateur.
urlContext
object (UrlContext)
Facultatif. Outil permettant de récupérer le contexte d'une URL.
fileSearch
object (FileSearch)
Facultatif. Type d'outil FileSearch. Outil permettant de récupérer des connaissances à partir de corpus de récupération sémantique.
mcpServers[]
object (McpServer)
Facultatif. Serveurs MCP auxquels se connecter.
googleMaps
object (GoogleMaps)
Facultatif. Outil permettant d'ancrer la réponse du modèle avec un contexte géospatial lié à la requête de l'utilisateur.
| Représentation JSON |
|---|
{ "functionDeclarations": [ { object ( |
FunctionDeclaration
Représentation structurée d'une déclaration de fonction telle que définie par la spécification OpenAPI 3.03. Cette déclaration inclut le nom et les paramètres de la fonction. Cette FunctionDeclaration est une représentation d'un bloc de code qui peut être utilisé comme Tool par le modèle et exécuté par le client.
name
string
Obligatoire. Nom de la fonction. Il doit comporter 128 caractères maximum et contenir uniquement des lettres (A-Z, a-z), des chiffres (0-9), des traits de soulignement, des deux-points, des points ou des tirets.
description
string
Obligatoire. Brève description de la fonction.
behavior
enum (Behavior)
Facultatif. Spécifie le comportement de la fonction. Actuellement, seule la méthode BidiGenerateContent est compatible.
parameters
object (Schema)
Facultatif. Décrit les paramètres de cette fonction. Reflète la clé de chaîne de l'objet de paramètre Open API 3.03 : le nom du paramètre. Les noms des paramètres sont sensibles à la casse. Valeur du schéma : schéma définissant le type utilisé pour le paramètre.
parametersJsonSchema
value (Value format)
Facultatif. Décrit les paramètres de la fonction au format de schéma JSON. Le schéma doit décrire un objet dont les propriétés sont les paramètres de la fonction. Exemple :
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
Ce champ s'exclut mutuellement avec parameters.
response
object (Schema)
Facultatif. Décrit la sortie de cette fonction au format de schéma JSON. Reflète l'objet de réponse Open API 3.03. Le schéma définit le type utilisé pour la valeur de réponse de la fonction.
responseJsonSchema
value (Value format)
Facultatif. Décrit la sortie de cette fonction au format de schéma JSON. La valeur spécifiée par le schéma est la valeur de réponse de la fonction.
Ce champ s'exclut mutuellement avec response.
Comportement
Définit le comportement de la fonction. La valeur par défaut est BLOCKING.
| Enums | |
|---|---|
UNSPECIFIED |
Cette valeur n'est pas utilisée. |
BLOCKING |
Si cette option est définie, le système attend de recevoir la réponse de la fonction avant de poursuivre la conversation. |
NON_BLOCKING |
Si ce paramètre est défini, le système n'attendra pas de recevoir la réponse de la fonction. Au lieu de cela, il tentera de gérer les réponses de fonction dès qu'elles seront disponibles, tout en maintenant la conversation entre l'utilisateur et le modèle. |
GoogleSearchRetrieval
Outil permettant de récupérer des données Web publiques pour l'ancrage, optimisé par Google.
dynamicRetrievalConfig
object (DynamicRetrievalConfig)
Spécifie la configuration de récupération dynamique pour la source donnée.
| Représentation JSON |
|---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
Décrit les options de personnalisation de la récupération dynamique.
mode
enum (Mode)
Mode du prédicteur à utiliser dans la récupération dynamique.
dynamicThreshold
number
Seuil à utiliser pour la récupération dynamique. Si elle n'est pas définie, une valeur par défaut du système est utilisée.
| Représentation JSON |
|---|
{
"mode": enum ( |
Mode
Mode du prédicteur à utiliser dans la récupération dynamique.
| Enums | |
|---|---|
MODE_UNSPECIFIED |
Toujours déclencher la récupération. |
MODE_DYNAMIC |
Exécuter la récupération uniquement lorsque le système décide que cela est nécessaire. |
CodeExecution
Ce type ne comporte aucun champ.
Outil qui exécute le code généré par le modèle et renvoie automatiquement le résultat au modèle.
Consultez également ExecutableCode et CodeExecutionResult, qui ne sont générés que lorsque vous utilisez cet outil.
GoogleSearch
Type d'outil GoogleSearch. Outil permettant d'utiliser la recherche Google dans le modèle. La puissance de la technologie Google
timeRangeFilter
object (Interval)
Facultatif. Filtrer les résultats de recherche pour une période spécifique. Si les clients définissent une heure de début, ils doivent définir une heure de fin (et inversement).
searchTypes
object (SearchTypes)
Facultatif. Ensemble de types de recherche à activer. Si ce paramètre n'est pas défini, la recherche sur le Web est activée par défaut.
| Représentation JSON |
|---|
{ "timeRangeFilter": { object ( |
Intervalle
Représente un intervalle de temps, encodé sous la forme d'un code temporel de début (inclusif) et d'un code temporel de fin (exclusif).
La valeur de début doit être inférieure ou égale à celle de fin. Lorsque la valeur de début est la même que la valeur de fin, l'intervalle est vide (il ne correspond à aucune durée). Lorsque les heures de début et de fin ne sont pas spécifiées, l'intervalle couvre toutes les heures.
startTime
string (Timestamp format)
Facultatif. Valeur de début (inclusive) de l'intervalle.
Si elle est spécifiée, un code temporel correspondant à cet intervalle devra être égal ou postérieur à l'heure de début.
Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime
string (Timestamp format)
Facultatif. Valeur de fin (exclusive) de l'intervalle.
Si elle est spécifiée, un code temporel correspondant à cet intervalle devra être antérieur à l'heure de fin.
Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
| Représentation JSON |
|---|
{ "startTime": string, "endTime": string } |
SearchTypes
Différents types de recherche pouvant être activés dans l'outil GoogleSearch.
webSearch
object (WebSearch)
Facultatif. Active la recherche sur le Web. Seuls les résultats textuels sont renvoyés.
imageSearch
object (ImageSearch)
Facultatif. Active la recherche d'images. Les octets d'image sont renvoyés.
| Représentation JSON |
|---|
{ "webSearch": { object ( |
WebSearch
Ce type ne comporte aucun champ.
Recherche sur le Web standard pour l'ancrage et les configurations associées.
ImageSearch
Ce type ne comporte aucun champ.
Recherche d'images pour l'ancrage et les configurations associées.
ComputerUse
Type d'outil "Utilisation de l'ordinateur".
environment
enum (Environment)
Obligatoire. Environnement en cours d'utilisation.
excludedPredefinedFunctions[]
string
Facultatif. Par défaut, les fonctions prédéfinies sont incluses dans l'appel de modèle final. Certains d'entre eux peuvent être explicitement exclus de l'inclusion automatique. Cela peut servir à deux choses : 1. Utiliser un espace d'action plus restreint / différent. 2. Amélioration des définitions / instructions des fonctions prédéfinies.
enablePromptInjectionDetection
boolean
Facultatif. Indique si la vérification de la détection d'injection de prompt doit être activée pour les requêtes d'utilisation de l'ordinateur.
disabledSafetyPolicies[]
enum (SafetyPolicy)
Facultatif. Désactivation des règles de sécurité pour l'utilisation de l'ordinateur.
| Représentation JSON |
|---|
{ "environment": enum ( |
Environnement
Représente l'environnement utilisé, par exemple un navigateur Web.
| Enums | |
|---|---|
ENVIRONMENT_UNSPECIFIED |
La valeur par défaut est "browser". |
ENVIRONMENT_BROWSER |
Fonctionne dans un navigateur Web. |
ENVIRONMENT_MOBILE |
Fonctionne dans un environnement mobile. |
ENVIRONMENT_DESKTOP |
Fonctionne dans un environnement de bureau. |
SafetyPolicy
Règles de sécurité prédéfinies pour l'utilisation de l'ordinateur.
| Enums | |
|---|---|
SAFETY_POLICY_UNSPECIFIED |
Règle de sécurité non spécifiée. |
FINANCIAL_TRANSACTIONS |
Règles de sécurité pour les transactions financières. |
SENSITIVE_DATA_MODIFICATION |
Règle de sécurité pour la modification des données sensibles. |
COMMUNICATION_TOOL |
Règles de sécurité pour les outils de communication (par exemple, Gmail, Chat, Meet). |
ACCOUNT_CREATION |
Règles de sécurité pour la création de comptes. |
DATA_MODIFICATION |
Règles de sécurité pour la modification des données. |
USER_CONSENT_MANAGEMENT |
Règles de sécurité pour la gestion du consentement utilisateur. |
LEGAL_TERMS_AND_AGREEMENTS |
Règles de sécurité pour les conditions d'utilisation et les contrats légaux. |
UrlContext
Ce type ne comporte aucun champ.
Outil permettant de récupérer le contexte d'une URL.
FileSearch
L'outil FileSearch qui récupère les connaissances des corpus de récupération sémantique. Les fichiers sont importés dans les corpus de récupération sémantique à l'aide de l'API ImportFile.
fileSearchStoreNames[]
string
Obligatoire. Noms des fileSearchStores à partir desquels récupérer les données. Exemple : fileSearchStores/my-file-search-store-123
metadataFilter
string
Facultatif. Filtre de métadonnées à appliquer aux documents et aux fragments de récupération sémantique.
topK
integer
Facultatif. Nombre de fragments de récupération sémantique à récupérer.
| Représentation JSON |
|---|
{ "fileSearchStoreNames": [ string ], "metadataFilter": string, "topK": integer } |
McpServer
Un MCPServer est un serveur qui peut être appelé par le modèle pour effectuer des actions. Il s'agit d'un serveur qui implémente le protocole MCP.
name
string
Nom du MCPServer.
transport
Union type
streamableHttpTransport
object (StreamableHttpTransport)
Un transport capable de diffuser des requêtes et des réponses HTTP.
| Représentation JSON |
|---|
{
"name": string,
// transport
"streamableHttpTransport": {
object ( |
StreamableHttpTransport
Un transport capable de diffuser des requêtes et des réponses HTTP.
url
string
URL complète du point de terminaison MCPServer. Exemple : "https://api.example.com/mcp"
headers
map (key: string, value: string)
Facultatif : champs pour les en-têtes d'authentification, les délais avant expiration, etc., si nécessaire.
Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
timeout
string (Duration format)
Délai avant expiration HTTP pour les opérations standards.
Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
sseReadTimeout
string (Duration format)
Délai avant expiration pour les opérations de lecture SSE.
Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
terminateOnClose
boolean
Indique si la session client doit être fermée lorsque le transport est fermé.
| Représentation JSON |
|---|
{ "url": string, "headers": { string: string, ... }, "timeout": string, "sseReadTimeout": string, "terminateOnClose": boolean } |
GoogleMaps
L'outil GoogleMaps, qui fournit un contexte géospatial pour la requête de l'utilisateur.
enableWidget
boolean
Facultatif. Indique si un jeton de contexte de widget doit être renvoyé dans les GroundingMetadata de la réponse. Les développeurs peuvent utiliser le jeton de contexte du widget pour afficher un widget Google Maps avec un contexte géospatial lié aux lieux auxquels le modèle fait référence dans la réponse.
| Représentation JSON |
|---|
{ "enableWidget": boolean } |
Ressource REST : auth_tokens
- Ressource : AuthToken
- BidiGenerateContentSetup
- GenerationConfig
- Modalité
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
- ResponseFormatConfig
- TextResponseFormat
- MimeType
- AudioResponseFormat
- MimeType
- Livraison
- ImageResponseFormat
- MimeType
- Livraison
- AspectRatio
- ImageSize
- TranslationConfig
- AudioTranscriptionConfig
- LanguageAuto
- LanguageHints
- Mode
- RealtimeInputConfig
- AutomaticActivityDetection
- StartSensitivity
- EndSensitivity
- ActivityHandling
- TurnCoverage
- SessionResumptionConfig
- ContextWindowCompressionConfig
- SlidingWindow
- HistoryConfig
- Méthodes
Ressource : AuthToken
Requête de création d'un jeton d'authentification éphémère.
name
string
Uniquement en sortie. Identifiant. Le jeton lui-même.
expireTime
string (Timestamp format)
Facultatif. Uniquement en entrée. Immuable. Heure facultative après laquelle, lors de l'utilisation du jeton obtenu, les messages des sessions BidiGenerateContent seront rejetés. (Gemini peut fermer la session de manière préventive après ce délai.)
Si ce champ n'est pas défini, la valeur par défaut est de 30 minutes dans le futur. Si elle est définie, cette valeur doit être inférieure à 20 heures dans le futur.
Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
newSessionExpireTime
string (Timestamp format)
Facultatif. Uniquement en entrée. Immuable. Heure après laquelle les nouvelles sessions de l'API Live utilisant le jeton résultant de cette requête seront refusées.
Si ce champ n'est pas défini, la valeur par défaut est de 60 secondes dans le futur. Si elle est définie, cette valeur doit être inférieure à 20 heures dans le futur.
Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
fieldMask
string (FieldMask format)
Facultatif. Uniquement en entrée. Immuable. Si fieldMask est vide et que bidiGenerateContentSetup n'est pas présent, le message BidiGenerateContentSetup effectif est extrait de la connexion à l'API Live.
Si fieldMask est vide et que bidiGenerateContentSetup est présent, le message BidiGenerateContentSetup effectif est entièrement extrait de bidiGenerateContentSetup dans cette requête. Le message de configuration de la connexion à l'API Live est ignoré.
Si fieldMask n'est pas vide, les champs correspondants de bidiGenerateContentSetup écraseront les champs du message de configuration dans la connexion à l'API Live.
Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".
config
Union type
bidiGenerateContentSetup
object (BidiGenerateContentSetup)
Facultatif. Uniquement en entrée. Immuable. Configuration spécifique à BidiGenerateContent.
uses
integer
Facultatif. Uniquement en entrée. Immuable. Nombre de fois où le jeton peut être utilisé. Si cette valeur est égale à zéro, aucune limite n'est appliquée. La reprise d'une session de l'API Live n'est pas comptabilisée comme une utilisation. Si aucune valeur n'est spécifiée, la valeur par défaut est 1.
| Représentation JSON |
|---|
{
"name": string,
"expireTime": string,
"newSessionExpireTime": string,
"fieldMask": string,
// config
"bidiGenerateContentSetup": {
object ( |
BidiGenerateContentSetup
Message à envoyer uniquement dans le premier BidiGenerateContentClientMessage. Contient la configuration qui s'appliquera pendant la durée du RPC de streaming.
Les clients doivent attendre un message BidiGenerateContentSetupComplete avant d'envoyer d'autres messages.
model
string
Obligatoire. Nom de ressource du modèle. Il sert d'ID pour le modèle à utiliser.
Format : models/{model}
generationConfig
object (GenerationConfig)
Facultatif. Configuration de la génération.
Les champs suivants ne sont pas acceptés :
responseLogprobsresponseMimeTypelogprobsresponseSchemaresponseJsonSchemastop_sequenceskipResponseCacherouting_configaudio_timestamp
systemInstruction
object (Content)
Facultatif. Instructions système fournies par l'utilisateur pour le modèle.
Remarque : Seul du texte doit être utilisé dans les parties, et le contenu de chaque partie figurera dans un paragraphe distinct.
tools[]
object (Tool)
Facultatif. Liste de Tools que le modèle peut utiliser pour générer la réponse suivante.
Tool est une portion de code qui permet au système d'interagir avec des systèmes externes pour effectuer une action ou un ensemble d'actions en dehors du champ d'application et des connaissances du modèle.
realtimeInputConfig
object (RealtimeInputConfig)
Facultatif. Configure la gestion de l'entrée en temps réel.
sessionResumption
object (SessionResumptionConfig)
Facultatif. Configure le mécanisme de reprise de session.
Si cet élément est inclus, le serveur envoie des messages SessionResumptionUpdate.
contextWindowCompression
object (ContextWindowCompressionConfig)
Facultatif. Configure un mécanisme de compression de la fenêtre de contexte.
Si cet élément est inclus, le serveur réduit automatiquement la taille du contexte lorsqu'il dépasse la longueur configurée.
inputAudioTranscription
object (AudioTranscriptionConfig)
Facultatif. Si elle est définie, elle active la transcription de la saisie vocale. La transcription correspond à la langue audio d'entrée, si elle est configurée.
outputAudioTranscription
object (AudioTranscriptionConfig)
Facultatif. Si cette option est définie, elle active la transcription de la sortie audio du modèle. La transcription correspond au code de langue spécifié pour le contenu audio de sortie, s'il est configuré.
historyConfig
object (HistoryConfig)
Facultatif. Configure l'échange de l'historique entre le client et le serveur.
labels
map (key: string, value: string)
Facultatif. Étiquettes avec des métadonnées définies par l'utilisateur pour la requête.
Facultatif. Les étiquettes doivent respecter les exigences standards des étiquettes Cloud unifiées : les clés d'étiquette doivent commencer par une lettre. - Les clés et les valeurs d'étiquette ne peuvent pas dépasser 63 caractères (points de code Unicode) et ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. - Les caractères internationaux sont acceptés.
Utilisation : identifiants de sécurité des agrégateurs : utilisez la clé safety_identifier (par exemple, {"safety_identifier": "user_session_123"})
Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
| Représentation JSON |
|---|
{ "model": string, "generationConfig": { object ( |
GenerationConfig
Options de configuration pour la génération et les sorties du modèle. Tous les paramètres ne sont pas configurables pour chaque modèle.
stopSequences[]
string
Facultatif. Ensemble de séquences de caractères (jusqu'à cinq) qui arrêteront la génération de la sortie. Si ce paramètre est spécifié, l'API s'arrête à la première occurrence d'un stop_sequence. La séquence d'arrêt ne sera pas incluse dans la réponse.
responseMimeType
string
Facultatif. Type MIME du texte candidat généré. Types MIME compatibles : text/plain (par défaut) : sortie de texte. application/json : réponse JSON dans les candidats de réponse. text/x.enum : ENUM en tant que réponse de chaîne dans les candidats de réponse. Consultez la documentation pour obtenir la liste de tous les types MIME de texte compatibles.
responseSchema
(deprecated)
object (Schema)
Facultatif. Schéma de sortie du texte candidat généré. Les schémas doivent être un sous-ensemble du schéma OpenAPI et peuvent être des objets, des primitives ou des tableaux.
Si cette option est définie, un responseMimeType compatible doit également être défini. Types MIME compatibles : application/json : schéma de la réponse JSON. Pour en savoir plus, consultez le guide de génération de texte JSON.
Obsolète. Utilisez plutôt responseFormat.
_responseJsonSchema
(deprecated)
value (Value format)
Facultatif. Schéma de sortie de la réponse générée. Il s'agit d'une alternative à responseSchema qui accepte le schéma JSON.
Si ce champ est défini, responseSchema doit être omis, mais responseMimeType est obligatoire.
Bien que le schéma JSON complet puisse être envoyé, toutes les fonctionnalités ne sont pas prises en charge. Plus précisément, seules les propriétés suivantes sont acceptées :
$id$defs$ref$anchortypeformattitledescriptionenum(pour les chaînes et les nombres)itemsprefixItemsminItemsmaxItemsminimummaximumanyOfoneOf(interprété de la même manière queanyOf)propertiesadditionalPropertiesrequired
La propriété non standard propertyOrdering peut également être définie.
Les références cycliques sont déroulées dans une certaine mesure et, par conséquent, ne peuvent être utilisées que dans des propriétés non obligatoires. (Les propriétés pouvant être nulles ne suffisent pas.) Si $ref est défini sur un sous-schéma, aucune autre propriété ne peut être définie, à l'exception de celles commençant par $.
Obsolète. Utilisez responseFormat à la place.
responseJsonSchema
value (Value format)
Facultatif. Détail interne. Utilisez responseJsonSchema plutôt que ce champ.
responseModalities[]
enum (Modality)
Facultatif. Modalités demandées de la réponse. Représente l'ensemble des modalités que le modèle peut renvoyer et qui doivent être attendues dans la réponse. Cela correspond exactement aux modalités de la réponse.
Un modèle peut comporter plusieurs combinaisons de modalités compatibles. Si les modalités demandées ne correspondent à aucune des combinaisons acceptées, une erreur est renvoyée.
Une liste vide équivaut à ne demander que du texte.
candidateCount
integer
Facultatif. Nombre de réponses générées à renvoyer. Si cette option n'est pas définie, la valeur par défaut est 1. Veuillez noter que cela ne fonctionne pas pour les modèles de la génération précédente (famille Gemini 1.0).
maxOutputTokens
integer
Facultatif. Nombre maximal de jetons à inclure dans un candidat de réponse.
Remarque : La valeur par défaut varie selon le modèle. Consultez l'attribut Model.output_token_limit de Model renvoyé par la fonction getModel.
temperature
number
Facultatif. Contrôle le caractère aléatoire de la sortie.
Remarque : La valeur par défaut varie selon le modèle. Consultez l'attribut Model.temperature de Model renvoyé par la fonction getModel.
Les valeurs peuvent être comprises entre [0.0, 2.0].
Ce champ n'est plus accepté et est ignoré sans avertissement sur Gemini 3.6 Flash et les modèles plus récents.
topP
number
Facultatif. Probabilité cumulée maximale des jetons à prendre en compte lors de l'échantillonnage.
Le modèle utilise un échantillonnage combiné Top-K et Top-P (nucleus).
Les jetons sont triés en fonction des probabilités qui leur sont attribuées, de sorte que seuls les jetons les plus probables sont pris en compte. L'échantillonnage Top-K limite directement le nombre maximal de jetons à prendre en compte, tandis que l'échantillonnage du noyau limite le nombre de jetons en fonction de la probabilité cumulée.
Remarque : La valeur par défaut varie selon l'Model et est spécifiée par l'attribut Model.top_p renvoyé par la fonction getModel. Un attribut topK vide indique que le modèle n'applique pas l'échantillonnage top-k et n'autorise pas la définition de topK sur les requêtes.
Ce champ n'est plus accepté et est ignoré sans avertissement sur Gemini 3.6 Flash et les modèles plus récents.
topK
integer
Facultatif. Nombre maximal de jetons à prendre en compte lors de l'échantillonnage.
Les modèles Gemini utilisent l'échantillonnage Top-p (nucleus) ou une combinaison d'échantillonnage Top-k et nucleus. L'échantillonnage top-K prend en compte l'ensemble des topK jetons les plus probables. Les modèles exécutés avec l'échantillonnage de noyau n'autorisent pas le paramètre topK.
Remarque : La valeur par défaut varie selon l'Model et est spécifiée par l'attribut Model.top_p renvoyé par la fonction getModel. Un attribut topK vide indique que le modèle n'applique pas l'échantillonnage top-k et n'autorise pas la définition de topK sur les requêtes.
Ce champ n'est plus accepté et est ignoré sans avertissement sur Gemini 3.6 Flash et les modèles plus récents.
seed
integer
Facultatif. Graine utilisée pour le décodage. Si ce paramètre n'est pas défini, la requête utilise une graine générée de manière aléatoire.
presencePenalty
number
Facultatif. Pénalité de présence appliquée aux logprobs du jeton suivant si le jeton a déjà été vu dans la réponse.
Cette pénalité est binaire (activée/désactivée) et ne dépend pas du nombre de fois où le jeton est utilisé (après la première fois). Utilisez frequencyPenalty pour une pénalité qui augmente à chaque utilisation.
Une pénalité positive décourage l'utilisation de jetons déjà utilisés dans la réponse, ce qui augmente le vocabulaire.
Une pénalité négative encourage l'utilisation de jetons qui ont déjà été utilisés dans la réponse, ce qui réduit le vocabulaire.
frequencyPenalty
number
Facultatif. Pénalité de fréquence appliquée aux logprobs du jeton suivant, multipliée par le nombre de fois où chaque jeton a été vu dans la réponse jusqu'à présent.
Une pénalité positive décourage l'utilisation de jetons déjà utilisés, proportionnellement au nombre de fois où le jeton a été utilisé : plus un jeton est utilisé, plus il est difficile pour le modèle de l'utiliser à nouveau, ce qui augmente le vocabulaire des réponses.
Attention : Une pénalité négative encouragera le modèle à réutiliser les jetons proportionnellement au nombre de fois où le jeton a été utilisé. Les petites valeurs négatives réduisent le vocabulaire d'une réponse. Des valeurs négatives plus élevées amèneront le modèle à répéter un jeton courant jusqu'à ce qu'il atteigne la limite maxOutputTokens.
responseLogprobs
boolean
Facultatif. Si la valeur est définie sur "true", exportez les résultats logprobs dans la réponse.
logprobs
integer
Facultatif. Valide uniquement si responseLogprobs=True. Définit le nombre de logprobs les plus élevés, y compris le candidat choisi, à renvoyer à chaque étape de décodage dans Candidate.logprobs_result. Le nombre doit être compris entre 0 et 20.
enableEnhancedCivicAnswers
boolean
Facultatif. Active les réponses civiques améliorées. Il est possible qu'elle ne soit pas disponible pour tous les modèles.
speechConfig
object (SpeechConfig)
Facultatif. Configuration de la génération de voix.
thinkingConfig
object (ThinkingConfig)
Facultatif. Configuration des fonctionnalités de réflexion. Une erreur est renvoyée si ce champ est défini pour des modèles qui ne sont pas compatibles avec le raisonnement.
imageConfig
object (ImageConfig)
Facultatif. Configuration pour la génération d'images. Une erreur sera renvoyée si ce champ est défini pour des modèles qui ne sont pas compatibles avec ces options de configuration.
mediaResolution
enum (MediaResolution)
Facultatif. Si elle est spécifiée, la résolution multimédia spécifiée sera utilisée.
enableAffectiveDialog
boolean
Facultatif. Si cette option est activée, le modèle détectera les émotions et adaptera ses réponses en conséquence.
responseFormat
object (ResponseFormatConfig)
Facultatif. Configuration du format de sortie de la réponse. Permet de spécifier la configuration de sortie par modalité (texte, audio, image) dans une structure plate.
translationConfig
object (TranslationConfig)
Facultatif. Configuration de la traduction.
audioTranscriptionConfig
object (AudioTranscriptionConfig)
Facultatif. Configuration de la transcription audio (reconnaissance vocale).
| Représentation JSON |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Modalité
Modalités de réponse acceptées.
| Enums | |
|---|---|
MODALITY_UNSPECIFIED |
Valeur par défaut. |
TEXT |
Indique que le modèle doit renvoyer du texte. |
IMAGE |
Indique que le modèle doit renvoyer des images. |
AUDIO |
Indique que le modèle doit renvoyer du contenu audio. |
SpeechConfig
Configuration pour la génération et la transcription de la parole.
voiceConfig
object (VoiceConfig)
Configuration en cas de sortie à voix unique.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig)
Facultatif. Configuration de la configuration multi-intervenant. Il s'exclut mutuellement avec le champ voiceConfig.
languageCode
string
Facultatif. Code de langue IETF BCP-47 que l'utilisateur a configuré pour l'application. Utilisé pour la reconnaissance et la synthèse vocales.
Les valeurs valides sont : 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 et th-TH.
| Représentation JSON |
|---|
{ "voiceConfig": { object ( |
VoiceConfig
Configuration de la voix à utiliser.
voice_config
Union type
prebuiltVoiceConfig
object (PrebuiltVoiceConfig)
Configuration de la voix prédéfinie à utiliser.
voice
string
Facultatif. Identifiant du locuteur pour la synthèse. Formats compatibles :
- Nom de l'intervenant pour les voix prédéfinies (par exemple,
OrusouKore). - ID de voix pour les voix stockées (par exemple,
voice_xxx). - Clé de réplication vocale (par exemple,
voicekey_xxx).
| Représentation JSON |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
Configuration de l'intervenant prédéfini à utiliser.
voiceName
string
Facultatif. Nom de la voix prédéfinie à utiliser.
| Représentation JSON |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
Configuration de la configuration multi-enceinte.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig)
Obligatoire. Toutes les voix d'intervenants activées.
| Représentation JSON |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
Configuration d'une seule enceinte dans une configuration multi-enceinte.
speaker
string
Obligatoire. Nom de l'enceinte à utiliser. Doit être identique à celui de la requête.
voiceConfig
object (VoiceConfig)
Obligatoire. Configuration de la voix à utiliser.
| Représentation JSON |
|---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Configuration des fonctionnalités de réflexion.
includeThoughts
boolean
Indique si les pensées doivent être incluses dans la réponse. Si la valeur est "true", les pensées ne sont renvoyées que lorsqu'elles sont disponibles.
thinkingBudget
integer
Nombre de jetons de raisonnement que le modèle doit générer.
thinkingLevel
enum (ThinkingLevel)
Facultatif. Contrôle la profondeur maximale du processus de raisonnement interne du modèle avant qu'il ne produise une réponse. La valeur par défaut dépend du modèle. Pour en savoir plus, consultez le guide sur les niveaux de réflexion. Recommandé pour les modèles Gemini 3 ou ultérieurs. L'utilisation avec des modèles antérieurs entraîne une erreur.
| Représentation JSON |
|---|
{
"includeThoughts": boolean,
"thinkingBudget": integer,
"thinkingLevel": enum ( |
ThinkingLevel
Permettre à l'utilisateur de spécifier le temps de réflexion à l'aide d'une énumération au lieu d'un budget entier.
| Enums | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
Valeur par défaut. |
MINIMAL |
Peu ou pas de réflexion. |
LOW |
Niveau de raisonnement faible. |
MEDIUM |
Niveau de raisonnement intermédiaire. |
HIGH |
Niveau de raisonnement élevé. |
ImageConfig
Configuration des fonctionnalités de génération d'images.
aspectRatio
string
Facultatif. Format de l'image à générer. Formats acceptés : 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 ou 21:9.
Si vous ne spécifiez pas de format, le modèle choisit un format par défaut en fonction des images de référence fournies.
imageSize
string
Facultatif. Spécifie la taille des images générées. Les valeurs acceptées sont 512, 1K, 2K et 4K. Si aucune valeur n'est spécifiée, le modèle utilise la valeur par défaut 1K.
| Représentation JSON |
|---|
{ "aspectRatio": string, "imageSize": string } |
MediaResolution
Résolution du contenu multimédia d'entrée.
| Enums | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
La résolution multimédia n'a pas été définie. |
MEDIA_RESOLUTION_LOW |
Résolution multimédia définie sur "Faible" (64 jetons). |
MEDIA_RESOLUTION_MEDIUM |
Résolution multimédia définie sur "Moyenne" (256 jetons). |
MEDIA_RESOLUTION_HIGH |
Résolution multimédia définie sur "Élevée" (recadrage zoomé avec 256 jetons). |
ResponseFormatConfig
Configuration du format de sortie de la réponse. Il s'agit d'un objet plat dans lequel chaque sous-champ facultatif configure une modalité de sortie spécifique.
text
object (TextResponseFormat)
Facultatif. Configuration du format de sortie du texte.
audio
object (AudioResponseFormat)
Facultatif. Configuration du format de sortie audio.
image
object (ImageResponseFormat)
Facultatif. Configuration du format de sortie de l'image.
| Représentation JSON |
|---|
{ "text": { object ( |
TextResponseFormat
Configuration du format de sortie du texte.
mimeType
enum (MimeType)
Facultatif. Type MIME de la sortie textuelle.
schema
value (Value format)
Facultatif. Schéma JSON auquel la sortie doit se conformer. Applicable uniquement lorsque mimeType est défini sur APPLICATION_JSON.
| Représentation JSON |
|---|
{
"mimeType": enum ( |
MimeType
Types MIME compatibles pour la sortie de texte.
| Enums | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
APPLICATION_JSON |
Format de sortie JSON. |
TEXT_PLAIN |
Format de sortie en texte brut. |
AudioResponseFormat
Configuration du format de sortie audio.
mimeType
enum (MimeType)
Facultatif. Type MIME de la sortie audio.
delivery
enum (Delivery)
Facultatif. Mode de diffusion de la sortie audio.
sampleRate
integer
Facultatif. Taux d'échantillonnage en Hz.
bitRate
integer
Facultatif. Débit binaire en bits par seconde (bit/s). S'applique uniquement aux formats compressés (MP3, Opus).
MimeType
Types MIME compatibles pour la sortie audio.
| Enums | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
AUDIO_MP3 |
Format audio MP3. |
AUDIO_OGG_OPUS |
Format audio OGG Opus. |
AUDIO_L16 |
Format audio PCM brut (L16). |
AUDIO_WAV |
Format audio WAV. |
AUDIO_ALAW |
Format audio A-law. |
AUDIO_MULAW |
Format audio mu-law. |
Livraison
Mode de diffusion pour la sortie audio.
| Enums | |
|---|---|
DELIVERY_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
INLINE |
Les données audio sont renvoyées de manière intégrée dans la réponse. |
URI |
Les données audio sont renvoyées sous forme d'URI. |
ImageResponseFormat
Configuration du format de sortie de l'image.
mimeType
enum (MimeType)
Facultatif. Type MIME de l'image de sortie.
delivery
enum (Delivery)
Facultatif. Mode de diffusion de l'image de sortie.
aspectRatio
enum (AspectRatio)
Facultatif. Format de l'image de sortie.
imageSize
enum (ImageSize)
Facultatif. Taille de l'image de sortie.
| Représentation JSON |
|---|
{ "mimeType": enum ( |
MimeType
Types MIME compatibles pour la sortie d'image.
| Enums | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
IMAGE_JPEG |
Format d'image JPEG. |
Livraison
Mode de diffusion pour la sortie d'image.
| Enums | |
|---|---|
DELIVERY_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
INLINE |
Les données d'image sont renvoyées de manière intégrée dans la réponse. |
URI |
Les données d'image sont renvoyées sous forme d'URI. |
AspectRatio
Formats acceptés pour la sortie d'image.
| Enums | |
|---|---|
ASPECT_RATIO_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
ASPECT_RATIO_ONE_BY_ONE |
Format 1:1. |
ASPECT_RATIO_TWO_BY_THREE |
Format 2:3. |
ASPECT_RATIO_THREE_BY_TWO |
Format 3:2. |
ASPECT_RATIO_THREE_BY_FOUR |
Format 3:4. |
ASPECT_RATIO_FOUR_BY_THREE |
Format 4:3. |
ASPECT_RATIO_FOUR_BY_FIVE |
Format 4:5. |
ASPECT_RATIO_FIVE_BY_FOUR |
Format 5:4. |
ASPECT_RATIO_NINE_BY_SIXTEEN |
Format 9:16 |
ASPECT_RATIO_SIXTEEN_BY_NINE |
Format 16:9. |
ASPECT_RATIO_TWENTY_ONE_BY_NINE |
Format 21:9. |
ASPECT_RATIO_ONE_BY_EIGHT |
Format 1:8. |
ASPECT_RATIO_EIGHT_BY_ONE |
Format 8:1. |
ASPECT_RATIO_ONE_BY_FOUR |
Format 1:4. |
ASPECT_RATIO_FOUR_BY_ONE |
Format 4:1. |
ImageSize
Tailles d'image acceptées pour la sortie d'image.
| Enums | |
|---|---|
IMAGE_SIZE_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
IMAGE_SIZE_FIVE_TWELVE |
Taille de l'image : 512 px. |
IMAGE_SIZE_ONE_K |
Taille d'image 1K. |
IMAGE_SIZE_TWO_K |
Taille d'image 2K. |
IMAGE_SIZE_FOUR_K |
Taille d'image 4K. |
TranslationConfig
Configuration des fonctionnalités de traduction.
targetLanguageCode
string
Obligatoire. Langue cible de la traduction. Les valeurs acceptées sont les codes de langue BCP-47 (par exemple, "en", "es", "fr").
echoTargetLanguage
boolean
Facultatif. Si la valeur est "true", le modèle génère de l'audio lorsque la langue cible est parlée. En gros, il répète l'entrée. Si la valeur est "false", nous ne produirons pas d'audio pour la langue cible.
| Représentation JSON |
|---|
{ "targetLanguageCode": string, "echoTargetLanguage": boolean } |
AudioTranscriptionConfig
Configuration de la transcription audio.
languageCodes[]
string
Facultatif. Codes de langue BCP-47 fournissant des indications sur les langues présentes dans l'audio. Si ce champ est omis ou vide, la détection automatique de la langue est utilisée par défaut.
adaptationPhrases[]
(deprecated)
string
Facultatif. Liste d'expressions utilisées pour l'adaptation vocale, qui oriente le modèle ASR pour améliorer la reconnaissance de ces termes spécifiques.
customVocabulary[]
string
Facultatif. Liste d'expressions de vocabulaire personnalisé pour orienter le modèle de reconnaissance vocale vers la reconnaissance de termes spécifiques (noms de produits, noms propres, jargon).
wordTimestamp
boolean
Facultatif. Configure la génération de codes temporels au niveau du mot.
diarization
boolean
Facultatif. Configure l'identification des locuteurs.
mode
enum (Mode)
Facultatif. Configure le mode de transcription. Valeurs autorisées : VERBATIM, SMART. Si aucune valeur n'est spécifiée, la valeur par défaut est la transcription VERBATIM. En mode SMART, le modèle supprime les disfluences (mots de remplissage, répétitions et faux départs), effectue un léger nettoyage grammatical, applique une mise en forme automatique (paragraphes, puces, listes numérotées) et apporte des modifications mineures (autocorrections intégrées). Les codes temporels et la segmentation ne sont pas compatibles avec le mode SMART.
language_config
Union type
language_codes de premier niveau. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :languageAuto
(deprecated)
object (LanguageAuto)
Facultatif. Le modèle détectera automatiquement la langue.
languageHints
(deprecated)
object (LanguageHints)
Facultatif. Spécifie une ou plusieurs langues dans l'audio.
| Représentation JSON |
|---|
{ "languageCodes": [ string ], "adaptationPhrases": [ string ], "customVocabulary": [ string ], "wordTimestamp": boolean, "diarization": boolean, "mode": enum ( |
LanguageAuto
Ce type ne comporte aucun champ.
Indique que la langue de l'audio doit être détectée automatiquement.
LanguageHints
Fournit des indications au modèle sur les langues possibles présentes dans l'audio.
languageCodes[]
(deprecated)
string
Obligatoire. Codes de langue BCP-47.
| Représentation JSON |
|---|
{ "languageCodes": [ string ] } |
Mode
Mode Transcription
| Enums | |
|---|---|
MODE_UNSPECIFIED |
Mode de transcription non spécifié. |
VERBATIM |
Mode de transcription verbatim. |
SMART |
Mode de transcription intelligent. |
RealtimeInputConfig
Configure le comportement d'entrée en temps réel dans BidiGenerateContent.
automaticActivityDetection
object (AutomaticActivityDetection)
Facultatif. Si cet élément n'est pas défini, la détection automatique de l'activité est activée par défaut. Si elle est désactivée, le client doit envoyer des signaux d'activité.
activityHandling
enum (ActivityHandling)
Facultatif. Définit l'effet de l'activité.
turnCoverage
enum (TurnCoverage)
Facultatif. Définit l'entrée incluse dans le tour de l'utilisateur.
interimTranscriptTimestampEnabled
boolean
Facultatif. Configure les codes temporels des transcriptions intermédiaires.
| Représentation JSON |
|---|
{ "automaticActivityDetection": { object ( |
AutomaticActivityDetection
Configure la détection automatique de l'activité.
disabled
boolean
Facultatif. Si cet élément est activé (valeur par défaut), les entrées vocales et textuelles détectées sont considérées comme une activité. S'il est désactivé, le client doit envoyer des signaux d'activité.
startOfSpeechSensitivity
enum (StartSensitivity)
Facultatif. Détermine la probabilité de détection de la parole.
prefixPaddingMs
integer
Facultatif. Durée requise de la parole détectée avant validation du début de la parole. Plus cette valeur est faible, plus la détection du début de la parole est sensible, ce qui permet de détecter des paroles plus courtes. Toutefois, cela augmente également la probabilité de faux positifs.
endOfSpeechSensitivity
enum (EndSensitivity)
Facultatif. Détermine la probabilité que la parole détectée soit terminée.
silenceDurationMs
integer
Facultatif. Durée requise de sons autres que la parole (par exemple, un silence) détectés avant validation de la fin de la parole. Plus cette valeur est élevée, plus les intervalles de parole peuvent être longs sans interrompre l'activité de l'utilisateur. Toutefois, cela augmente la latence du modèle.
| Représentation JSON |
|---|
{ "disabled": boolean, "startOfSpeechSensitivity": enum ( |
StartSensitivity
Détermine comment le début de la parole est détecté.
| Enums | |
|---|---|
START_SENSITIVITY_UNSPECIFIED |
La valeur par défaut est START_SENSITIVITY_HIGH. |
START_SENSITIVITY_HIGH |
La détection automatique détectera plus souvent le début de la parole. |
START_SENSITIVITY_LOW |
La détection automatique détectera moins souvent le début de la parole. |
EndSensitivity
Détermine la façon dont la fin de la parole est détectée.
| Enums | |
|---|---|
END_SENSITIVITY_UNSPECIFIED |
La valeur par défaut est END_SENSITIVITY_HIGH. |
END_SENSITIVITY_HIGH |
La détection automatique met fin plus souvent à la parole. |
END_SENSITIVITY_LOW |
La détection automatique met fin moins souvent à la parole. |
ActivityHandling
Les différentes façons de gérer l'activité de l'utilisateur.
| Énumérations | |
|---|---|
ACTIVITY_HANDLING_UNSPECIFIED |
Si aucune valeur n'est spécifiée, le comportement par défaut est START_OF_ACTIVITY_INTERRUPTS. |
START_OF_ACTIVITY_INTERRUPTS |
Si la valeur est "true", le démarrage de l'activité interrompt la réponse du modèle (également appelé "barge-in"). La réponse actuelle du modèle est suspendue au moment de l'interruption. Il s'agit du comportement par défaut. |
NO_INTERRUPTION |
La réponse du modèle n'est pas interrompue. |
TurnCoverage
Options concernant les entrées à inclure dans le tour de l'utilisateur.
| Enums | |
|---|---|
TURN_COVERAGE_UNSPECIFIED |
Si aucune valeur n'est spécifiée, un comportement par défaut est sélectionné en fonction du modèle. Par exemple, pour Gemini 2.5, la valeur par défaut est TURN_INCLUDES_ONLY_ACTIVITY, tandis que pour Gemini 3.1 et les versions ultérieures, elle est de TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO. |
TURN_INCLUDES_ONLY_ACTIVITY |
Inclut l'activité depuis le dernier tour, à l'exclusion de l'inactivité (par exemple, un silence sur le flux audio). |
TURN_INCLUDES_ALL_INPUT |
Inclut toutes les entrées en temps réel depuis le dernier tour, y compris l'inactivité (par exemple, un silence sur le flux audio). |
TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO |
Inclut l'activité audio et toutes les vidéos depuis le dernier tour. Avec la détection automatique de l'activité, l'activité audio correspond à la parole et exclut le silence. |
SessionResumptionConfig
Configuration de la reprise de session.
Ce message est inclus dans la configuration de la session en tant que BidiGenerateContentSetup.session_resumption. Si cette option est configurée, le serveur envoie des messages SessionResumptionUpdate.
handle
string
Handle d'une session précédente. S'il n'est pas présent, une session est créée.
Les identifiants de session proviennent des valeurs SessionResumptionUpdate.token des connexions précédentes.
| Représentation JSON |
|---|
{ "handle": string } |
ContextWindowCompressionConfig
Active la compression de la fenêtre de contexte, un mécanisme permettant de gérer la fenêtre de contexte du modèle afin qu'elle ne dépasse pas une longueur donnée.
compression_mechanism
Union type
slidingWindow
object (SlidingWindow)
Un mécanisme de fenêtre glissante
triggerTokens
string (int64 format)
Nombre de jetons (avant d'exécuter un tour) requis pour déclencher une compression de la fenêtre de contexte.
Cela peut être utilisé pour trouver un équilibre entre qualité et latence, car des fenêtres de contexte plus courtes peuvent entraîner des réponses plus rapides du modèle. Toutefois, toute opération de compression entraîne une augmentation temporaire de la latence. Elle ne doit donc pas être déclenchée fréquemment.
Si ce paramètre n'est pas défini, la valeur par défaut est de 80% de la limite de la fenêtre de contexte du modèle. Il reste donc 20% pour la requête utilisateur/réponse du modèle suivante.
| Représentation JSON |
|---|
{
// compression_mechanism
"slidingWindow": {
object ( |
SlidingWindow
La méthode SlidingWindow supprime le contenu au début de la fenêtre de contexte. Le contexte obtenu commencera toujours au début d'un tour de rôle USER. Les instructions système et les éventuels BidiGenerateContentSetup.prefix_turns resteront toujours au début du résultat.
targetTokens
string (int64 format)
Nombre cible de jetons à conserver. La valeur par défaut est triggerTokens/2.
La suppression de parties de la fenêtre de contexte entraîne une augmentation temporaire de la latence. Cette valeur doit donc être calibrée pour éviter les opérations de compression fréquentes.
| Représentation JSON |
|---|
{ "targetTokens": string } |
HistoryConfig
Configuration de l'historique.
Ce message est inclus dans la configuration de la session en tant que BidiGenerateContentSetup.history_config. Configure l'échange de messages d'historique.
initialHistoryInClientContent
boolean
Facultatif. Si la valeur est "true", après l'envoi de setupComplete, le serveur attend et traite d'abord les messages clientContent jusqu'à ce que turnComplete soit true. Cet historique initial ne déclenchera pas d'appel de modèle et peut se terminer par le rôle MODEL. Une fois que turnComplete est true, le client peut démarrer la conversation en temps réel via realtimeInput.
| Représentation JSON |
|---|
{ "initialHistoryInClientContent": boolean } |
Méthode : auth_tokens.create
Crée un jeton qui peut être utilisé pour limiter le comportement d'une session BidiGenerateContent.
Point de terminaison
posthttps: / /generativelanguage.googleapis.com /v1beta /auth_tokens
Corps de la requête
Le corps de la requête contient une instance de AuthToken.
expireTime
string (Timestamp format)
Facultatif. Uniquement en entrée. Immuable. Heure facultative après laquelle, lors de l'utilisation du jeton obtenu, les messages des sessions BidiGenerateContent seront rejetés. (Gemini peut fermer la session de manière préventive après ce délai.)
Si ce champ n'est pas défini, la valeur par défaut est de 30 minutes dans le futur. Si elle est définie, cette valeur doit être inférieure à 20 heures dans le futur.
Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
newSessionExpireTime
string (Timestamp format)
Facultatif. Uniquement en entrée. Immuable. Heure après laquelle les nouvelles sessions de l'API Live utilisant le jeton résultant de cette requête seront refusées.
Si ce champ n'est pas défini, la valeur par défaut est de 60 secondes dans le futur. Si elle est définie, cette valeur doit être inférieure à 20 heures dans le futur.
Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
fieldMask
string (FieldMask format)
Facultatif. Uniquement en entrée. Immuable. Si fieldMask est vide et que bidiGenerateContentSetup n'est pas présent, le message BidiGenerateContentSetup effectif est extrait de la connexion à l'API Live.
Si fieldMask est vide et que bidiGenerateContentSetup est présent, le message BidiGenerateContentSetup effectif est entièrement extrait de bidiGenerateContentSetup dans cette requête. Le message de configuration de la connexion à l'API Live est ignoré.
Si fieldMask n'est pas vide, les champs correspondants de bidiGenerateContentSetup écraseront les champs du message de configuration dans la connexion à l'API Live.
Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".
config
Union type
bidiGenerateContentSetup
object (BidiGenerateContentSetup)
Facultatif. Uniquement en entrée. Immuable. Configuration spécifique à BidiGenerateContent.
uses
integer
Facultatif. Uniquement en entrée. Immuable. Nombre de fois où le jeton peut être utilisé. Si cette valeur est égale à zéro, aucune limite n'est appliquée. La reprise d'une session de l'API Live n'est pas comptabilisée comme une utilisation. Si aucune valeur n'est spécifiée, la valeur par défaut est 1.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une nouvelle instance de AuthToken.