- Ressource: CachedContent
- Contenu
- Partie
- Blob
- FunctionCall
- FunctionResponse
- FileData
- Outil
- FunctionDeclaration
- Schéma
- Type
- ToolConfig
- FunctionCallingConfig
- Mode
- UsageMetadata
- Méthodes
Ressource: CachedContent
Contenu qui a été prétraité et qui peut être utilisé dans les requêtes ultérieures envoyées à GenerativeService.
Le contenu mis en cache ne peut être utilisé qu'avec le modèle pour lequel il a été créé.
Représentation JSON |
---|
{ "contents": [ { object ( |
Champs | |
---|---|
contents[] |
Facultatif. Uniquement en entrée. Immuable. Contenu à mettre en cache. |
tools[] |
Facultatif. Uniquement en entrée. Immuable. Liste de |
createTime |
Uniquement en sortie. Heure de création de l'entrée de cache. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
updateTime |
Uniquement en sortie. Date et heure de la dernière mise à jour de l'entrée de cache en temps UTC. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
usageMetadata |
Uniquement en sortie. Métadonnées sur l'utilisation du contenu mis en cache. |
Champ d'union expiration . Indique la date d'expiration de cette ressource. expiration ne peut être qu'un des éléments suivants : |
|
expireTime |
Code temporel en UTC du moment où cette ressource est considérée comme expirée. Cette valeur est toujours fournie en sortie, quelle que soit ce qui a été envoyé en entrée. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
ttl |
Uniquement en entrée. Nouvelle valeur TTL pour cette ressource, en entrée uniquement. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
name |
Facultatif. Identifiant. Nom de la ressource faisant référence au contenu mis en cache. Format : |
displayName |
Facultatif. Immuable. Nom à afficher explicite, généré par l'utilisateur, pour le contenu mis en cache 128 caractères Unicode maximum. |
model |
Obligatoire. Immuable. Nom du |
systemInstruction |
Facultatif. Uniquement en entrée. Immuable. Instruction concernant le système défini par le développeur. Texte uniquement pour le moment. |
toolConfig |
Facultatif. Uniquement en entrée. Immuable. Configuration de l'outil. Cette configuration est partagée pour tous les outils. |
Contenus
Type de données structurées de base contenant le contenu d'un message en plusieurs parties.
Un Content
inclut un champ role
désignant le producteur de l'Content
et un champ parts
contenant des données en plusieurs parties incluant le contenu du tour du message.
Représentation JSON |
---|
{
"parts": [
{
object ( |
Champs | |
---|---|
parts[] |
|
role |
Facultatif. Producteur du contenu. Doit être 'utilisateur' ou 'modèle'. Utile à configurer pour les conversations multitours. Sinon, peut être laissé vide ou non défini. |
Part
Type de données contenant du contenu multimédia faisant partie d'un message Content
en plusieurs parties.
Un Part
est constitué de données auxquelles un type de données est associé. Un élément 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 contenu multimédia si le champ inlineData
est rempli d'octets bruts.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
text |
Texte intégré. |
inlineData |
Octets multimédias intégrés. |
functionCall |
Une |
functionResponse |
Le résultat d'une |
fileData |
Données basées sur l'URI. |
Blob
Octets multimédias bruts.
Le texte ne doit pas être envoyé sous forme d'octets bruts. Utilisez le champ "text".
Représentation JSON |
---|
{ "mimeType": string, "data": string } |
Champs | |
---|---|
mimeType |
Type MIME standard de l'IANA des données sources. Exemples: - image/png - image/jpeg Si un type MIME non pris en charge est fourni, une erreur s'affiche. Pour obtenir la liste complète des types de fichiers compatibles, consultez Formats de fichiers acceptés. |
data |
Octets bruts pour les formats multimédias. Chaîne encodée en base64. |
FunctionCall
Une FunctionCall
prédite renvoyée par le modèle et qui contient une chaîne représentant FunctionDeclaration.name
avec les arguments et leurs valeurs.
Représentation JSON |
---|
{ "name": string, "args": { object } } |
Champs | |
---|---|
name |
Obligatoire. Nom de la fonction à appeler. Doit être de a à z, A à Z ou 0 à 9, ou contenir des traits de soulignement et des tirets, avec une longueur maximale de 63. |
args |
Facultatif. Paramètres et valeurs de la fonction au format d'objet JSON. |
FunctionResponse
Le résultat d'une FunctionCall
contenant une chaîne représentant l'FunctionDeclaration.name
et un objet JSON structuré contenant toute sortie de la fonction est utilisé comme contexte pour le modèle. Il doit contenir le résultat d'une FunctionCall
basée sur la prédiction du modèle.
Représentation JSON |
---|
{ "name": string, "response": { object } } |
Champs | |
---|---|
name |
Obligatoire. Nom de la fonction à appeler. Doit être de a à z, A à Z ou 0 à 9, ou contenir des traits de soulignement et des tirets, avec une longueur maximale de 63. |
response |
Obligatoire. Réponse de la fonction au format d'objet JSON. |
FileData
Données basées sur l'URI.
Représentation JSON |
---|
{ "mimeType": string, "fileUri": string } |
Champs | |
---|---|
mimeType |
Facultatif. Type MIME standard de l'IANA des données sources. |
fileUri |
Obligatoire. URI. |
Outil
Détails de l'outil que le modèle peut utiliser pour générer une réponse.
Un Tool
est un extrait de code qui permet au système d'interagir avec des systèmes externes pour effectuer une ou plusieurs actions, en dehors des connaissances et du champ d'application du modèle.
Représentation JSON |
---|
{
"functionDeclarations": [
{
object ( |
Champs | |
---|---|
functionDeclarations[] |
Facultatif. Liste des Le modèle ou le système n'exécute pas la fonction. À la place, la fonction définie peut être renvoyée sous la forme d'un [FunctionCall][content.part.function_call] avec des arguments côté client pour exécution. Le modèle peut décider d'appeler un sous-ensemble de ces fonctions en insérant [FunctionCall][content.part.function_call] dans la réponse. Le prochain tour de conversation peut contenir une [FunctionResponse][content.part.function_response] avec le contexte de génération de "fonction" [content.role] pour le prochain tour du modèle. |
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 comprend 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.
Représentation JSON |
---|
{
"name": string,
"description": string,
"parameters": {
object ( |
Champs | |
---|---|
name |
Obligatoire. Nom de la fonction. Doit être de a à z, A à Z ou 0 à 9, ou contenir des traits de soulignement et des tirets, avec une longueur maximale de 63. |
description |
Obligatoire. Brève description de la fonction. |
parameters |
Facultatif. Décrit les paramètres de cette fonction. Reflète la clé de la chaîne de l'objet du paramètre Open API 3.03: nom du paramètre. Les noms des paramètres sont sensibles à la casse. "Schema Value" : le schéma définissant le type utilisé pour le paramètre. |
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 sélectionné d'un objet de schéma OpenAPI 3.0.
Représentation JSON |
---|
{ "type": enum ( |
Champs | |
---|---|
type |
Obligatoire. Type de données |
format |
Facultatif. Format des données. Cette méthode n'est utilisée que pour les types de données primitifs. Formats compatibles: pour le type NUMBER: float, double pour le type INTEGER: int32, int64 |
description |
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 |
Facultatif. Indique si la valeur peut être nulle. |
enum[] |
Facultatif. Valeurs possibles de l'élément de Type.STRING au format enum. Par exemple, nous pouvons définir une direction d'énumération comme suit : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} |
properties |
Facultatif. Propriétés du type.OBJECT. Objet contenant une liste de paires |
required[] |
Facultatif. Propriétés obligatoires de Type.OBJECT. |
items |
Facultatif. Schéma des éléments de Type.ARRAY. |
Type
Le 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. |
ToolConfig
Configuration de l'outil contenant des paramètres permettant de spécifier l'utilisation de Tool
dans la requête.
Représentation JSON |
---|
{
"functionCallingConfig": {
object ( |
Champs | |
---|---|
functionCallingConfig |
Facultatif. Configuration de l'appel de fonction. |
FunctionCallingConfig
Configuration permettant de spécifier le comportement d'appel de fonction.
Représentation JSON |
---|
{
"mode": enum ( |
Champs | |
---|---|
mode |
Facultatif. Spécifie le mode d'exécution de l'appel de fonction. Si aucune valeur n'est spécifiée, la valeur par défaut sera définie sur AUTO. |
allowedFunctionNames[] |
Facultatif. Ensemble de noms de fonctions qui, lorsqu'ils sont fournis, limitent les fonctions que le modèle va appeler. Ce paramètre ne doit être défini que lorsque le mode est défini sur "TOUS". Les noms de fonctions doivent correspondre à [FunctionDeclaration.name]. Lorsque le mode est défini sur N'IMPORTE LAQUELLE, le modèle va prédire un appel de fonction à partir de l'ensemble des noms de fonction fournis. |
Mode
Définit le comportement d'exécution pour l'appel de fonction en définissant le mode d'exécution.
Enums | |
---|---|
MODE_UNSPECIFIED |
Mode d'appel de fonction non spécifié. Cette valeur ne doit pas être utilisée. |
AUTO |
Comportement par défaut du modèle : le modèle décide de prédire soit un appel de fonction, soit une réponse en langage naturel. |
ANY |
Le modèle est contraint de toujours prédire un appel de fonction uniquement. Si les paramètres "allowedFunctionNames" sont définis, l'appel de fonction prédit est limité à l'une des valeurs "allowedFunctionNames", sinon l'appel de la fonction prédit est l'une des "functionDeclarations" fournies. |
NONE |
Le modèle ne prédirea aucun appel de fonction. Le comportement du modèle est le même que lorsqu'il ne transmet aucune déclaration de fonction. |
UsageMetadata
Métadonnées sur l'utilisation du contenu mis en cache.
Représentation JSON |
---|
{ "totalTokenCount": integer } |
Champs | |
---|---|
totalTokenCount |
Nombre total de jetons utilisés par le contenu mis en cache. |
Méthodes |
|
---|---|
|
Crée une ressource CachedContent. |
|
Supprime la ressource CachedContent. |
|
Lit la ressource CachedContent. |
|
Répertorie les CachedContents. |
|
Met à jour la ressource CachedContent (seul le délai d'expiration peut être mis à jour). |