PaLM (decommissioned)

Méthode : models.generateText

Génère une réponse du modèle à partir d'un message d'entrée.

Point de terminaison

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

Paramètres de chemin d'accès

model string

Obligatoire. Nom de l'élément Model ou TunedModel à utiliser pour générer l'achèvement. Exemples : models/text-bison-001 tunedModels/sentence-translator-u3b7m Il prend la forme models/{model}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Champs
prompt object (TextPrompt)

Obligatoire. Texte d'entrée en mode libre donné au modèle en tant que requête.

À partir d'une requête, le modèle génère une réponse TextCompletion qu'il prédit comme étant la fin du texte saisi.

safetySettings[] object (SafetySetting)

Facultatif. Liste d'instances SafetySetting uniques permettant de bloquer le contenu à risque.

qui sera appliqué sur les GenerateTextRequest.prompt et GenerateTextResponse.candidates. Il ne doit pas y avoir plus d'un paramètre par type de SafetyCategory. L'API bloquera toutes les invites 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 les paramètres de sécurité. Si aucun SafetySetting n'est fourni pour 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éjudices HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL, HARM_CATEGORY_DANGEROUS sont acceptées dans les services textuels.

stopSequences[] string

Ensemble de séquences de caractères (jusqu'à cinq) qui arrêtent la génération de sortie. Si elle est spécifiée, l'API s'arrête à la première apparition d'une séquence d'arrêt. La séquence d'arrêt ne sera pas incluse dans la réponse.

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 l'Model renvoyé par la fonction getModel.

Les valeurs peuvent être comprises entre [0,0 et 1,0] inclus. Une valeur proche de 1,0 produira des réponses plus variées et créatives, tandis qu'une valeur plus proche de 0,0 donnera généralement des réponses plus simples du modèle.

candidateCount integer

Facultatif. Nombre de réponses générées à renvoyer.

Cette valeur doit être comprise entre [1 et 8] inclus. Si cette règle n'est pas configurée, la valeur par défaut est 1.

maxOutputTokens integer

Facultatif. Nombre maximal de jetons à inclure dans une candidate.

Si cette valeur n'est pas définie, la valeur par défaut est outputTokenLimit spécifiée dans la spécification Model.

topP number

Facultatif. Probabilité cumulée maximale des jetons à prendre en compte lors de l'échantillonnage.

Le modèle combine l'échantillonnage top-k et l'échantillonnage du noyau.

Les jetons sont triés en fonction des probabilités qui leur sont attribuées, de sorte que seuls les jetons les plus probables soient 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 le modèle. Reportez-vous à l'attribut Model.top_p de Model qui a renvoyé la fonction getModel.

topK integer

Facultatif. Nombre maximal de jetons à prendre en compte lors de l'échantillonnage.

Le modèle combine l'échantillonnage top-k et l'échantillonnage du noyau.

L'échantillonnage top-k tient compte de l'ensemble de jetons les plus probables (topK). La valeur par défaut est 40.

Remarque: La valeur par défaut varie selon le modèle. Reportez-vous à l'attribut Model.top_k de Model qui a renvoyé la fonction getModel.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de GenerateTextResponse.

Méthode: Models.countTextTokens

Exécute le tokenizer d'un modèle sur un texte et renvoie le nombre de jetons.

Point de terminaison

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

Paramètres de chemin d'accès

model string

Obligatoire. Nom de ressource du modèle. Il s'agit d'un identifiant que le modèle doit utiliser.

Ce nom doit correspondre à un nom de modèle renvoyé par la méthode models.list.

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 :

Champs
prompt object (TextPrompt)

Obligatoire. Texte d'entrée en mode libre donné au modèle en tant que requête.

Corps de la réponse

Réponse de models.countTextTokens.

Elle renvoie le tokenCount du modèle pour le prompt.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
tokenCount integer

Nombre de jetons dans lesquels le model tokenise le prompt.

Toujours non négatif.

Représentation JSON 
{
  "tokenCount": integer
}

Méthode : models.generateMessage

Génère une réponse du modèle en fonction d'une MessagePrompt d'entrée.

Point de terminaison

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

Paramètres de chemin d'accès

model string

Obligatoire. Nom du modèle à utiliser.

Format : name=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 :

Champs
prompt object (MessagePrompt)

Obligatoire. Entrée textuelle structurée fournie au modèle en tant que requête.

À partir d'une requête, le modèle renvoie ce qu'il prédit pour le prochain message de la discussion.

temperature number

Facultatif. Contrôle le caractère aléatoire de la sortie.

Les valeurs peuvent être supérieures ou égales à [0.0,1.0] inclus. Une valeur plus proche de 1.0 produira des réponses plus variées, tandis qu'une valeur plus proche de 0.0 produira généralement des réponses moins surprenantes de la part du modèle.

candidateCount integer

Facultatif. Nombre de messages de réponse générés à renvoyer.

Cette valeur doit être comprise entre [1, 8] inclus. Si cette valeur n'est pas définie, la valeur par défaut est 1.

topP number

Facultatif. Probabilité cumulée maximale des jetons à prendre en compte lors de l'échantillonnage.

Le modèle utilise un échantillonnage de top-k et de noyau.

L'échantillonnage du noyau prend en compte le plus petit ensemble de jetons dont la somme des probabilités est d'au moins topP.

topK integer

Facultatif. Nombre maximal de jetons à prendre en compte lors de l'échantillonnage.

Le modèle combine l'échantillonnage top-k et l'échantillonnage du noyau.

L'échantillonnage top-k tient compte de l'ensemble de jetons les plus probables (topK).

Corps de la réponse

Réponse du modèle.

Cela inclut les messages des candidats et l'historique des conversations sous forme de messages classés chronologiquement.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
candidates[] object (Message)

Messages de réponse candidats du modèle.

messages[] object (Message)

Historique de la conversation utilisé par le modèle.

filters[] object (ContentFilter)

Ensemble de métadonnées de filtrage de contenu pour la requête et le texte de la réponse.

Cela permet d'indiquer le ou les SafetyCategory qui ont bloqué un candidat pour cette réponse, le HarmProbability le plus bas ayant déclenché un blocage et le paramètre HarmThreshold pour cette catégorie.

Représentation JSON 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}

Méthode : models.countMessageTokens

Exécute la fonction de tokenisation d'un modèle sur une chaîne et renvoie le nombre de jetons.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> publier https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countMessageTokens

Paramètres de chemin d'accès

model string

Obligatoire. Nom de ressource du modèle. Il s'agit d'un identifiant que le modèle doit utiliser.

Ce nom doit correspondre à un nom de modèle renvoyé par la méthode models.list.

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 :

Champs
prompt object (MessagePrompt)

Obligatoire. Invite, dont le nombre de jetons doit être renvoyé.

Corps de la réponse

Réponse de models.countMessageTokens.

Elle renvoie l'tokenCount du modèle pour prompt.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
tokenCount integer

Nombre de jetons dans lesquels le model tokenise le prompt.

Toujours non négatif.

Représentation JSON 
{
  "tokenCount": integer
}

Méthode : models.embedText

Génère un entraînement à partir du modèle à partir d'un message d'entrée.

Point de terminaison

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

Paramètres de chemin d'accès

model string

Obligatoire. Nom du modèle à utiliser au format model=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 :

Champs
text string

Facultatif. Texte d'entrée au format libre que le modèle transformera en représentation vectorielle continue.

Corps de la réponse

Réponse à une requête EmbedTextRequest.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
embedding object (Embedding)

Uniquement en sortie. La représentation vectorielle continue générée à partir du texte d'entrée.

Représentation JSON 
{
  "embedding": {
    object (Embedding)
  }
}

Méthode : models.batchEmbedText

Génère plusieurs représentations vectorielles continues à partir du texte d'entrée du modèle dans un appel synchrone.

Point de terminaison

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

Paramètres de chemin d'accès

model string

Obligatoire. Nom de l'Model à utiliser pour générer l'encapsulation. Exemples: modèles/embedding-gecko-001. 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 :

Champs
texts[] string

Facultatif. Textes d'entrée de forme libre que le modèle transformera en représentation vectorielle continue. La limite actuelle est de 100 textes, au-delà duquel une erreur est générée.

requests[] object (EmbedTextRequest)

Facultatif. Requêtes d'intégration pour le lot. Vous ne pouvez définir qu'un seul élément texts ou requests.

Corps de la réponse

Réponse à une requête EmbedTextRequest.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
embeddings[] object (Embedding)

Uniquement en sortie. Les représentations vectorielles continues générées à partir du texte d'entrée.

Représentation JSON 
{
  "embeddings": [
    {
      object (Embedding)
    }
  ]
}

EmbedTextRequest

Requête d'obtention d'une représentation vectorielle continue de texte à partir du modèle.

Champs
model string

Obligatoire. Nom du modèle à utiliser au format model=models/{model}.

text string

Facultatif. Texte d'entrée au format libre que le modèle transformera en représentation vectorielle continue.

Représentation JSON 
{
  "model": string,
  "text": string
}

Méthode: tuneModels.generateText

Génère une réponse du modèle à partir d'un message d'entrée.

Point de terminaison

post https://generativelanguage.googleapis.com/v1beta/{model=tunedModels/*}:generateText

Paramètres de chemin d'accès

model string

Obligatoire. Nom de l'élément Model ou TunedModel à utiliser pour générer l'achèvement. Exemples: modèles/text-bison-001 hitsModels/sentence-translator-u3b7m. Il se présente sous la forme tunedModels/{tunedmodel}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Champs
prompt object (TextPrompt)

Obligatoire. Texte d'entrée en mode libre donné au modèle en tant que requête.

À partir d'une requête, le modèle génère une réponse TextCompletion qu'il prédit comme étant la fin du texte saisi.

safetySettings[] object (SafetySetting)

Facultatif. Liste d'instances SafetySetting uniques permettant de bloquer le contenu à risque.

qui sera appliqué sur les GenerateTextRequest.prompt et GenerateTextResponse.candidates. Il ne doit pas y avoir plus d'un paramètre par type de SafetyCategory. L'API bloquera toutes les invites 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 les paramètres de sécurité. Si aucun SafetySetting n'est fourni pour 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éjudices HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL, HARM_CATEGORY_DANGEROUS sont acceptées dans les services textuels.

stopSequences[] string

Ensemble de séquences de caractères (jusqu'à cinq) qui arrêtent la génération de sortie. Si elle est spécifiée, l'API s'arrête à la première apparition d'une séquence d'arrêt. La séquence d'arrêt ne sera pas incluse dans la réponse.

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 l'Model renvoyé par la fonction getModel.

Les valeurs peuvent être comprises entre [0,0 et 1,0] inclus. Une valeur proche de 1,0 produira des réponses plus variées et créatives, tandis qu'une valeur plus proche de 0,0 donnera généralement des réponses plus simples du modèle.

candidateCount integer

Facultatif. Nombre de réponses générées à renvoyer.

Cette valeur doit être comprise entre [1 et 8] inclus. Si cette règle n'est pas configurée, la valeur par défaut est 1.

maxOutputTokens integer

Facultatif. Nombre maximal de jetons à inclure dans une candidate.

Si cette valeur n'est pas définie, la valeur par défaut est outputTokenLimit spécifiée dans la spécification Model.

topP number

Facultatif. Probabilité cumulée maximale des jetons à prendre en compte lors de l'échantillonnage.

Le modèle combine l'échantillonnage top-k et l'échantillonnage du noyau.

Les jetons sont triés en fonction des probabilités qui leur sont attribuées, de sorte que seuls les jetons les plus probables soient 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 le modèle. Reportez-vous à l'attribut Model.top_p de Model qui a renvoyé la fonction getModel.

topK integer

Facultatif. Nombre maximal de jetons à prendre en compte lors de l'échantillonnage.

Le modèle combine l'échantillonnage top-k et l'échantillonnage du noyau.

L'échantillonnage top-k tient compte de l'ensemble de jetons les plus probables (topK). La valeur par défaut est 40.

Remarque: La valeur par défaut varie selon le modèle. Reportez-vous à l'attribut Model.top_k de Model qui a renvoyé la fonction getModel.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de GenerateTextResponse.

ContentFilter

Métadonnées de filtrage du contenu associées au traitement d'une seule requête.

ContentFilter contient un motif et une chaîne d'accompagnement facultative. Le motif peut ne pas être spécifié.

Champs
reason enum (BlockedReason)

Raison pour laquelle le contenu a été bloqué lors du traitement de la requête.

message string

Chaîne décrivant plus en détail le comportement de filtrage.

Représentation JSON 
{
  "reason": enum (BlockedReason),
  "message": string
}

BlockedReason

Liste des raisons pour lesquelles un contenu peut avoir été bloqué.

Enums
BLOCKED_REASON_UNSPECIFIED Aucun motif de blocage n'a été spécifié.
SAFETY Le contenu a été bloqué par les paramètres de sécurité.
OTHER Le contenu a été bloqué, mais la raison n'est pas catégorisée.

Embedding

Liste de nombres à virgule flottante représentant l'encapsulation.

Champs
value[] number

Les valeurs d'embedding.

Représentation JSON 
{
  "value": [
    number
  ]
}

Message

Unité de base du texte structuré.

Un Message inclut un author et le content de Message.

author permet de taguer les messages lorsqu'ils sont transmis au modèle sous forme de texte.

Champs
author string

Facultatif. Auteur de ce message.

Il sert de clé pour taguer le contenu de ce message lorsqu'il est fourni au modèle sous forme de texte.

L'auteur peut être n'importe quelle chaîne alphanumérique.

content string

Obligatoire. Contenu textuel de l'Message structuré.

citationMetadata object (CitationMetadata)

Uniquement en sortie. Informations sur la citation du content généré par le modèle dans Message.

Si ce Message a été généré en tant que sortie du modèle, ce champ peut être renseigné avec des informations d'attribution pour tout texte inclus dans content. Ce champ n'est utilisé que pour la sortie.

Représentation JSON 
{
  "author": string,
  "content": string,
  "citationMetadata": {
    object (CitationMetadata)
  }
}

MessagePrompt

Tout le texte d'entrée structuré transmis au modèle en tant que requête.

Un MessagePrompt contient un ensemble structuré de champs qui fournissent le contexte de la conversation, des exemples de paires de messages d'entrée utilisateur/de sortie du modèle qui préparent le modèle à répondre de différentes manières, ainsi que l'historique de la conversation ou la liste des messages représentant les tours de parole alternés entre l'utilisateur et le modèle.

Champs
context string

Facultatif. Texte à fournir en premier au modèle pour baser la réponse.

Si ce champ n'est pas vide, l'élément context sera d'abord attribué au modèle avant examples et messages. Lorsque vous utilisez un context, veillez à l'envoyer à chaque requête afin d'assurer la continuité.

Ce champ peut servir de description de la requête que vous adressez au modèle afin de fournir du contexte et d'orienter les réponses. Exemples : "Traduis la phrase de l'anglais vers le français". ou "S'il s'agit d'une déclaration, classifie le sentiment comme étant heureux, triste ou neutre".

Tout élément inclus dans ce champ prévaut sur l'historique des messages si la taille totale de l'entrée dépasse la inputTokenLimit du modèle et que la requête d'entrée est tronquée.

examples[] object (Example)

Facultatif. Exemples de ce que le modèle doit générer.

Cela inclut à la fois l'entrée utilisateur et la réponse que le modèle doit émuler.

Ces examples sont traités de la même manière que les messages de conversation, sauf qu'ils prévalent sur l'historique dans messages : si la taille totale de l'entrée dépasse la inputTokenLimit du modèle, l'entrée est tronquée. Les éléments seront supprimés de messages avant examples.

messages[] object (Message)

Obligatoire. Instantané de l'historique des conversations récentes, trié par ordre chronologique.

Alterne entre deux auteurs.

Si la taille totale de l'entrée dépasse la inputTokenLimit du modèle, l'entrée sera tronquée : les éléments les plus anciens seront supprimés de messages.

Représentation JSON 
{
  "context": string,
  "examples": [
    {
      object (Example)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ]
}

Exemple

Exemple d'entrée/sortie utilisé pour instruire le modèle.

Il montre comment le modèle doit répondre ou mettre en forme sa réponse.

Champs
input object (Message)

Obligatoire. Exemple de Message d'entrée provenant de l'utilisateur.

output object (Message)

Obligatoire. Exemple de sortie du modèle en fonction de l'entrée.

Représentation JSON 
{
  "input": {
    object (Message)
  },
  "output": {
    object (Message)
  }
}

GenerateTextResponse

Réponse du modèle, y compris les terminaisons candidates.

Champs
candidates[] object (TextCompletion)

Réponses candidates du modèle.

filters[] object (ContentFilter)

Ensemble de métadonnées de filtrage du contenu pour le texte de l'invite et de la réponse.

Cela permet d'indiquer le ou les SafetyCategory qui ont bloqué un candidat pour cette réponse, le HarmProbability le plus bas ayant déclenché un blocage et le paramètre HarmThreshold pour cette catégorie. Cela indique la plus petite modification de SafetySettings qui serait nécessaire pour débloquer au moins une réponse.

Le blocage est configuré par le SafetySettings de la requête (ou le SafetySettings par défaut de l'API).

safetyFeedback[] object (SafetyFeedback)

Renvoie tous les commentaires de sécurité liés au filtrage du contenu.

Représentation JSON 
{
  "candidates": [
    {
      object (TextCompletion)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ],
  "safetyFeedback": [
    {
      object (SafetyFeedback)
    }
  ]
}

TextCompletion

Texte de sortie renvoyé par un modèle.

Champs
output string

Uniquement en sortie. Texte généré renvoyé par le modèle.

safetyRatings[] object (SafetyRating)

Évaluations de la sécurité d'une réponse.

Il y a au maximum une note par catégorie.

citationMetadata object (CitationMetadata)

Uniquement en sortie. Informations sur la citation du output généré par le modèle dans TextCompletion.

Ce champ peut être renseigné avec des informations d'attribution pour tout texte inclus dans le output.

Représentation JSON 
{
  "output": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  }
}

SafetyFeedback

Commentaires de sécurité pour l'intégralité d'une requête.

Ce champ est renseigné si le contenu de l'entrée et/ou de la réponse est bloqué en raison des paramètres de sécurité. Il est possible que SafetyFeedback n'existe pas pour chaque catégorie de danger. Chaque SafetyFeedback renvoie les paramètres de sécurité utilisés par la requête, ainsi que la probabilité de danger la plus faible qui doit être autorisée pour renvoyer un résultat.

Champs
rating object (SafetyRating)

Classification de sécurité évaluée à partir du contenu.

setting object (SafetySetting)

Paramètres de sécurité appliqués à la requête.

Représentation JSON 
{
  "rating": {
    object (SafetyRating)
  },
  "setting": {
    object (SafetySetting)
  }
}

TextPrompt

Texte fourni au modèle sous forme de requête.

Le modèle va utiliser cette requête de texte pour générer une saisie semi-automatique de texte.

Champs
text string

Obligatoire. Texte de la requête.

Représentation JSON 
{
  "text": string
}