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 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
- Champs d'application des autorisations
- Exemple de requête
Génère une réponse du modèle à partir d'une entrée GenerateContentRequest
. Pour obtenir des informations détaillées sur l'utilisation, consultez le guide de génération de texte. Les capacités d'entrée diffèrent selon les modèles, y compris les modèles ajustés. Pour en savoir plus, consultez le guide du modèle et le guide du 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 Model
peut utiliser pour générer la réponse suivante.
Un Tool
est un morceau 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
acceptés 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. Pour obtenir un exemple d'utilisation, consultez le guide sur l'appel de fonction.
safetySettings[]
object (SafetySetting
)
Facultatif. Liste d'instances SafetySetting
uniques permettant de bloquer le contenu non sécurisé.
Cette règle sera appliquée sur GenerateContentRequest.contents
et GenerateContentResponse.candidates
. Il ne doit pas y avoir plus d'un paramètre pour chaque type SafetyCategory
. L'API bloquera tout contenu et toute réponse 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 associé à un SafetyCategory
donné dans la liste, l'API utilise 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 et HARM_CATEGORY_CIVIC_INTEGRITY sont acceptées. Pour en savoir plus sur les paramètres de sécurité disponibles, consultez le guide. Consultez également les Consignes de sécurité pour découvrir comment intégrer des considérations de sécurité dans vos applications d'IA.
systemInstruction
object (Content
)
Facultatif. Le développeur a défini des instructions système. Texte uniquement pour le moment.
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 diffuser la prédiction. Format : cachedContents/{cachedContent}
Exemple de requête
Texte
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
Image
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
Audio
Python
Node.js
Go
Coquille Rose
Vidéo
Python
Node.js
Go
Coquille Rose
Python
Go
Coquille Rose
Chat
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
Cache
Python
Node.js
Go
Modèle réglé
Python
Mode JSON
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
Exécution du code
Python
Go
Kotlin
Java
Appel de fonction
Python
Go
Node.js
Coquille Rose
Kotlin
Swift
Dart
Java
Configuration de la génération
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
Paramètres de sécurité
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
Instruction système
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
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
- Champs d'application des autorisations
- Exemple de requête
Génère une réponse en flux du modèle à partir 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 Model
peut utiliser pour générer la réponse suivante.
Un Tool
est un morceau 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
acceptés 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. Pour obtenir un exemple d'utilisation, consultez le guide sur l'appel de fonction.
safetySettings[]
object (SafetySetting
)
Facultatif. Liste d'instances SafetySetting
uniques permettant de bloquer le contenu non sécurisé.
Cette règle sera appliquée sur GenerateContentRequest.contents
et GenerateContentResponse.candidates
. Il ne doit pas y avoir plus d'un paramètre pour chaque type SafetyCategory
. L'API bloquera tout contenu et toute réponse 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 associé à un SafetyCategory
donné dans la liste, l'API utilise 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 et HARM_CATEGORY_CIVIC_INTEGRITY sont acceptées. Pour en savoir plus sur les paramètres de sécurité disponibles, consultez le guide. Consultez également les Consignes de sécurité pour découvrir comment intégrer des considérations de sécurité dans vos applications d'IA.
systemInstruction
object (Content
)
Facultatif. Le développeur a défini des instructions système. Texte uniquement pour le moment.
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 diffuser la prédiction. Format : cachedContents/{cachedContent}
Exemple de requête
Texte
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
Image
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
Audio
Python
Go
Coquille Rose
Vidéo
Python
Node.js
Go
Coquille Rose
Python
Go
Coquille Rose
Chat
Python
Node.js
Go
Coquille Rose
Kotlin
Swift
Dart
Java
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 acceptant plusieurs réponses candidates.
Les classifications de sécurité et le filtrage du contenu sont indiqués à la fois pour l'invite dans GenerateContentResponse.prompt_feedback
et pour chaque candidat dans finishReason
et dans safetyRatings
. L'API : - renvoie tous les candidats demandés ou aucun d'eux ; - ne renvoie aucun candidat uniquement si la requête est incorrecte (vérifiez promptFeedback
) ; - signale les 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 pour les 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
Sortie uniquement. responseId permet d'identifier chaque réponse.
Représentation JSON |
---|
{ "candidates": [ { object ( |
PromptFeedback
Ensemble des métadonnées de commentaires que l'invite a spécifiées dans GenerateContentRequest.content
.
blockReason
enum (BlockReason
)
Facultatif. Si cette valeur est définie, cela signifie que la requête a été bloquée et qu'aucun candidat n'a été renvoyé. Reformulez la requête.
safetyRatings[]
object (SafetyRating
)
Évaluations de la sécurité de la requête. Il ne peut y avoir qu'une seule note par catégorie.
Représentation JSON |
---|
{ "blockReason": enum ( |
BlockReason
Indique 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 la catégorie de sécurité qui 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 de contenus dangereux pour la génération d'images. |
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'il 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 tous les candidats de réponse générés.
toolUsePromptTokenCount
integer
Uniquement en sortie. Nombre de jetons présents dans la ou les invites 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 (candidats de requête + 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 demande d'utilisation d'outils.
Représentation JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
Candidat
- Représentation JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- GroundingSupport
- Segment
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- Candidat
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
Réponse candidate générée par le 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 évaluations de sécurité d'une réponse candidate.
Il ne peut y avoir 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 sur la 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 sur l'attribution des sources ayant 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 les plus fréquents
urlContextMetadata
object (UrlContextMetadata
)
Uniquement en sortie. Métadonnées associées à l'outil de récupération du contexte d'URL.
index
integer
Uniquement en sortie. Index du candidat dans la liste des candidats de la réponse.
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é pour utilisation d'une langue non acceptée. |
OTHER |
Raison inconnue. |
BLOCKLIST |
La génération de jetons a été arrêtée, car le contenu contient 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 est susceptible de contenir des informations permettant d'identifier personnellement l'utilisateur (SPII). |
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é interrompue, car les images générées contiennent des cas de non-respect des consignes de sécurité. |
UNEXPECTED_TOOL_CALL |
Le modèle a généré un appel d'outil, mais aucun outil n'était activé dans la requête. |
GroundingAttribution
Attribution pour une source ayant contribué à une réponse.
sourceId
object (AttributionSourceId
)
Uniquement en sortie. Identifiant de la source contribuant à cette attribution.
content
object (Content
)
Contenu source d'ancrage qui constitue cette attribution.
Représentation JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
Identifiant de la source contribuant à cette attribution.
source
Union type
source
ne peut être qu'un des éléments suivants :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 les 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 du 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 d'appui récupérées à partir de la source d'ancrage spécifiée.
groundingSupports[]
object (GroundingSupport
)
Liste des supports d'ancrage.
webSearchQueries[]
string
Requêtes de recherche sur le Web pour la recherche sur le Web de suivi.
searchEntryPoint
object (SearchEntryPoint
)
Facultatif. Résultat de recherche Google pour les recherches sur le Web de suivi.
retrievalMetadata
object (RetrievalMetadata
)
Métadonnées liées à la récupération dans le flux d'ancrage.
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
Bloc d'ancrage.
chunk_type
Union type
chunk_type
ne peut être qu'un des éléments suivants :web
object (Web
)
Bloc d'ancrage provenant du Web.
Représentation JSON |
---|
{
// chunk_type
"web": {
object ( |
Web
Extrait du Web.
uri
string
Référence URI du bloc.
title
string
Titre du fragment.
Représentation JSON |
---|
{ "uri": string, "title": string } |
GroundingSupport
Support d'ancrage.
groundingChunkIndices[]
integer
Liste d'index (dans "grounding_chunk") 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.
confidenceScores[]
number
Score de confiance des références d'assistance. Les valeurs vont de 0 à 1. 1 correspond au niveau de confiance le plus élevé. Cette liste doit avoir la même taille que groundingChunkIndices.
segment
object (Segment
)
Segment du contenu auquel appartient cette assistance.
Représentation JSON |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
Segment
Segment du contenu.
partIndex
integer
Uniquement en sortie. Index d'un objet Part dans son objet Content parent.
startIndex
integer
Uniquement en sortie. Index de début dans la partie donnée, mesuré en octets. Décalage par rapport au début de la partie (inclus), en commençant par zéro.
endIndex
integer
Uniquement en sortie. Index de fin de la partie donnée, mesuré en octets. Décalage par rapport au début de la partie, exclusif, en commençant par zéro.
text
string
Uniquement en sortie. 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 correspond à la probabilité la plus faible et 1 à la probabilité la plus élevée. 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 Logprobs
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.
Représentation JSON |
---|
{ "topCandidates": [ { object ( |
TopCandidates
Candidats avec les probabilités logarithmiques les plus élevées à chaque étape de décodage.
candidates[]
object (Candidate
)
Triées par probabilité logarithmique dans l'ordre décroissant.
Représentation JSON |
---|
{
"candidates": [
{
object ( |
Candidat
Candidat pour le jeton et le score logprobs.
token
string
Valeur de la chaîne du jeton du candidat.
tokenId
integer
Valeur de l'ID du jeton du candidat.
logProbability
number
Probabilité logarithmique du candidat.
Représentation JSON |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
Métadonnées associées à l'outil de récupération du contexte d'URL.
urlMetadata[]
object (UrlMetadata
)
Liste du contexte 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. |
CitationMetadata
Ensemble d'attributions de source pour un contenu.
citationSources[]
object (CitationSource
)
Citations des sources pour une réponse spécifique.
Représentation JSON |
---|
{
"citationSources": [
{
object ( |
CitationSource
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é (exclusif).
uri
string
Facultatif. URI attribué comme source pour une partie du texte.
license
string
Facultatif. Licence du projet GitHub attribué en tant que source pour le segment.
Les informations sur la licence sont obligatoires pour les citations de code.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- Représentation JSON
- Modalité
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- MediaResolution
Options de configuration pour la génération et les sorties du modèle. Tous les paramètres ne sont pas configurables pour tous les modèles.
stopSequences[]
string
Facultatif. Ensemble de séquences de caractères (jusqu'à cinq) qui arrêteront la génération de sortie. Si cette valeur est spécifiée, 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é. Les types MIME acceptés sont les suivants : 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
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 pour la réponse JSON. Pour en savoir plus, consultez le guide de génération de texte JSON.
responseJsonSchema
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 cette option est définie, 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
$anchor
type
format
title
description
enum
(pour les chaînes et les nombres)items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
oneOf
(interprété de la même manière queanyOf
)properties
additionalProperties
required
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 ne peuvent donc ê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 $
.
responseModalities[]
enum (Modality
)
Facultatif. Modalités de réponse demandées. Représente l'ensemble des modalités que le modèle peut renvoyer et qui doivent être attendues dans la réponse. Il s'agit d'une correspondance exacte avec les 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 à demander uniquement du texte.
candidateCount
integer
Facultatif. Nombre de réponses générées à renvoyer. Si cette valeur n'est pas définie, la valeur par défaut est 1. Veuillez noter que cela ne fonctionne pas pour les modèles de génération précédente (famille Gemini 1.0).
maxOutputTokens
integer
Facultatif. Nombre maximal de jetons à inclure dans une réponse candidate.
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 et 2,0.
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 Nucleus limite le nombre de jetons en fonction de la probabilité cumulée.
Remarque : La valeur par défaut varie selon 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 ne permet pas de définir topK
dans les requêtes.
topK
integer
Facultatif. Nombre maximal de jetons à prendre en compte lors de l'échantillonnage.
Les modèles Gemini utilisent l'échantillonnage Top-p (noyau) ou une combinaison d'échantillonnage Top-k et de noyau. L'échantillonnage top-k prend en compte l'ensemble des topK
jetons les plus probables. Les modèles exécutés avec l'échantillonnage du noyau ne permettent pas de définir topK.
Remarque : La valeur par défaut varie selon 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 ne permet pas de définir topK
dans les requêtes.
seed
integer
Facultatif. Graine utilisée dans le décodage. Si elle n'est pas définie, 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 dissuadera l'utilisation de jetons déjà utilisés dans la réponse, ce qui augmentera le vocabulaire.
Une pénalité négative encouragera l'utilisation de jetons déjà utilisés dans la réponse, ce qui réduira 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écouragera 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ù ils ont été utilisés. De petites valeurs négatives réduisent le vocabulaire d'une réponse. Des valeurs négatives plus importantes entraîneront la répétition d'un jeton commun par le modèle jusqu'à ce qu'il atteigne la limite maxOutputTokens
.
responseLogprobs
boolean
Facultatif. Si la valeur est "true", les résultats logprobs sont exportés dans la réponse.
logprobs
integer
Facultatif. Valide uniquement si responseLogprobs=True
. Cela définit le nombre de logprobs les plus élevés à renvoyer à chaque étape de décodage dans Candidate.logprobs_result
.
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 vocale.
thinkingConfig
object (ThinkingConfig
)
Facultatif. Configuration des fonctionnalités de réflexion. Une erreur sera renvoyée si ce champ est défini pour des modèles qui ne prennent pas en charge la réflexion.
mediaResolution
enum (MediaResolution
)
Facultatif. Si une résolution est spécifiée, elle sera utilisée.
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 de l'audio. |
SpeechConfig
Configuration de la génération vocale.
voiceConfig
object (VoiceConfig
)
Configuration en cas de sortie à une seule voix.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig
)
Facultatif. Configuration de la configuration multispeaker. Il s'exclut mutuellement avec le champ voiceConfig.
languageCode
string
Facultatif. Code de langue (au format BCP 47, par exemple "en-US") pour la synthèse vocale.
Les valeurs valides sont les suivantes : 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
voice_config
ne peut être qu'un des éléments suivants :prebuiltVoiceConfig
object (PrebuiltVoiceConfig
)
Configuration de la voix prédéfinie à utiliser.
Représentation JSON |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
Configuration à utiliser pour le haut-parleur prédéfini.
voiceName
string
Nom de la voix prédéfinie à utiliser.
Représentation JSON |
---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
Configuration de la configuration multispeaker.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig
)
Obligatoire. Toutes les voix d'enceinte activées.
Représentation JSON |
---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
Configuration d'une seule enceinte dans une configuration à plusieurs enceintes.
speaker
string
Obligatoire. Nom du locuteur à 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 s'il faut inclure les réflexions dans la réponse. Si la valeur est "true", les réflexions ne sont renvoyées que lorsqu'elles sont disponibles.
thinkingBudget
integer
Nombre de jetons de réflexion que le modèle doit générer.
Représentation JSON |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
MediaResolution
Résolution du contenu multimédia d'entrée.
Enums | |
---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
La résolution du contenu multimédia n'a pas été définie. |
MEDIA_RESOLUTION_LOW |
La résolution des contenus multimédias est définie sur "basse" (64 jetons). |
MEDIA_RESOLUTION_MEDIUM |
Résolution média définie sur moyenne (256 jetons). |
MEDIA_RESOLUTION_HIGH |
Résolution du contenu multimédia définie sur "Élevée" (recadrage zoomé avec 256 jetons). |
HarmCategory
Catégorie d'une note.
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 offensants ciblant l'identité et/ou les attributs protégés. |
HARM_CATEGORY_TOXICITY |
PaLM : contenu offensant, irrespectueux ou grossier. |
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. |
HARM_CATEGORY_SEXUAL |
PaLM : contient des références à des actes sexuels ou à d'autres contenus obscènes. |
HARM_CATEGORY_MEDICAL |
PaLM : promeut des conseils médicaux non vérifiés. |
HARM_CATEGORY_DANGEROUS |
PaLM : contenu dangereux qui promeut, facilite ou encourage des actes dangereux. |
HARM_CATEGORY_HARASSMENT |
Gemini : contenu relevant du harcèlement. |
HARM_CATEGORY_HATE_SPEECH |
Gemini : incitation à la haine et contenu 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 de nuire à l'intégrité civique. |
ModalityTokenCount
Représente les informations de comptage des 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é de la partie du contenu
Enums | |
---|---|
MODALITY_UNSPECIFIED |
Modalité non spécifiée. |
TEXT |
Texte brut. |
IMAGE |
Image. |
VIDEO |
Vidéo. |
AUDIO |
Audio. |
DOCUMENT |
Document, par exemple au format PDF. |
SafetyRating
Classification 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é en fonction de la sécurité dans plusieurs catégories de préjudices. La probabilité de la classification des préjudices est également indiquée.
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 non sécurisé. 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 présente une probabilité élevée d'être non sécurisé. |
SafetySetting
Paramètre de sécurité qui affecte le comportement de blocage de la sécurité.
Si vous transmettez un paramètre de sécurité pour une catégorie, la probabilité autorisée de blocage du contenu est modifiée.
category
enum (HarmCategory
)
Obligatoire. Catégorie de ce paramètre.
threshold
enum (HarmBlockThreshold
)
Obligatoire. Contrôle le seuil de probabilité à partir duquel les contenus nuisibles sont bloqués.
Représentation JSON |
---|
{ "category": enum ( |
HarmBlockThreshold
Bloquer les contenus dont la probabilité de préjudice est supérieure ou égale à un seuil spécifié.
Enums | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
Le seuil n'est pas spécifié. |
BLOCK_LOW_AND_ABOVE |
Les contenus présentant un risque NÉGLIGEABLE seront autorisés. |
BLOCK_MEDIUM_AND_ABOVE |
Les contenus présentant un risque NÉGLIGEABLE ou FAIBLE seront autorisés. |
BLOCK_ONLY_HIGH |
Les contenus classés comme NEGLIGEABLES, FAIBLES et MOYENS seront autorisés. |
BLOCK_NONE |
Tous les contenus seront autorisés. |
OFF |
Désactivez le filtre de sécurité. |