Com o armazenamento em cache de contexto, é possível salvar e reutilizar tokens de entrada pré-computados que você quer usar várias vezes, por exemplo, ao fazer perguntas diferentes sobre o mesmo arquivo de mídia. Isso pode gerar economia de custos e velocidade, dependendo do uso. Para uma introdução detalhada, consulte o guia Armazenamento em cache de contexto.
Método: cachedContents.create
Cria um recurso CachedContent.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Corpo da solicitação
O corpo da solicitação contém uma instância de CachedContent.
contents[]
object (Content)
Opcional. Somente entrada. Imutável. O conteúdo a ser armazenado em cache.
tools[]
object (Tool)
Opcional. Somente entrada. Imutável. Uma lista de Tools que o modelo pode usar para gerar a próxima resposta
expiration
Union type
expiration pode ser apenas de um dos tipos a seguir:expireTime
string (Timestamp format)
Carimbo de data/hora em UTC de quando o recurso será considerado expirado. Isso é sempre fornecido na saída, independente do que foi enviado na entrada.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Somente entrada. Nova TTL para este recurso, somente entrada.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
displayName
string
Opcional. Imutável. O nome de exibição significativo gerado pelo usuário do conteúdo armazenado em cache. Máximo de 128 caracteres Unicode.
model
string
Obrigatório. Imutável. O nome do Model a ser usado para conteúdo armazenado em cache. Formato: models/{model}
systemInstruction
object (Content)
Opcional. Somente entrada. Imutável. Instrução do sistema definida pelo desenvolvedor. No momento, somente texto.
toolConfig
object (ToolConfig)
Opcional. Somente entrada. Imutável. Configuração da ferramenta. Essa configuração é compartilhada com todas as ferramentas.
Exemplo de solicitação
Básico
Python
Node.js
Go
Shell
Nome do remetente
Python
Node.js
Go
No Chat
Python
Node.js
Go
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de CachedContent.
Método: cachedContents.list
Lista CachedContents.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Parâmetros de consulta
pageSize
integer
Opcional. O número máximo de conteúdos armazenados em cache a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, um número padrão (abaixo do máximo) de itens será retornado. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
pageToken
string
Opcional. Um token de página recebido de uma chamada cachedContents.list anterior. Forneça isso para recuperar a página subsequente.
Ao paginar, todos os outros parâmetros fornecidos para cachedContents.list precisam corresponder à chamada que forneceu o token da página.
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Resposta com a lista CachedContents.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
cachedContents[]
object (CachedContent)
Lista de conteúdo armazenado em cache.
nextPageToken
string
Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.
| Representação JSON |
|---|
{
"cachedContents": [
{
object ( |
Método: cachedContents.get
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Lê o recurso CachedContent.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Parâmetros de caminho
name
string
Obrigatório. O nome do recurso que se refere à entrada do cache de conteúdo. Formato: cachedContents/{id}. Ele tem o formato cachedContents/{cachedcontent}.
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Exemplo de solicitação
Python
Node.js
Go
Shell
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de CachedContent.
Método: cachedContents.patch
- Endpoint
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Atualiza o recurso CachedContent. Somente o vencimento pode ser atualizado.
Endpoint
patchhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*}
Parâmetros de caminho
cachedContent.name
string
Apenas saída. Identificador. O nome do recurso que se refere ao conteúdo armazenado em cache. Formato: cachedContents/{id}. Ele tem o formato cachedContents/{cachedcontent}.
Parâmetros de consulta
updateMask
string (FieldMask format)
Lista de campos a serem atualizados.
É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
Corpo da solicitação
O corpo da solicitação contém uma instância de CachedContent.
expiration
Union type
expiration pode ser apenas de um dos tipos a seguir:expireTime
string (Timestamp format)
Carimbo de data/hora em UTC de quando o recurso será considerado expirado. Isso é sempre fornecido na saída, independente do que foi enviado na entrada.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Somente entrada. Nova TTL para este recurso, somente entrada.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
Exemplo de solicitação
Python
Node.js
Go
Shell
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de CachedContent.
Método: cachedContents.delete
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Exclui o recurso CachedContent.
Endpoint
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Parâmetros de caminho
name
string
Obrigatório. O nome do recurso referente à entrada do cache de conteúdo. Formato: cachedContents/{id}. Ele tem o formato cachedContents/{cachedcontent}.
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Exemplo de solicitação
Python
Node.js
Go
Shell
Corpo da resposta
Se não houver nenhum problema, o corpo da resposta será um objeto JSON vazio.
Recurso REST: cachedContents
- Recurso: CachedContent
- ToolConfig
- FunctionCallingConfig
- Moda
- RetrievalConfig
- LatLng
- UsageMetadata
- Métodos
Recurso: CachedContent
Conteúdo que foi pré-processado e pode ser usado em solicitações subsequentes para GenerativeService.
O conteúdo armazenado em cache só pode ser usado com o modelo para o qual foi criado.
contents[]
object (Content)
Opcional. Somente entrada. Imutável. O conteúdo a ser armazenado em cache.
tools[]
object (Tool)
Opcional. Somente entrada. Imutável. Uma lista de Tools que o modelo pode usar para gerar a próxima resposta
createTime
string (Timestamp format)
Apenas saída. Hora de criação da entrada de cache.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime
string (Timestamp format)
Apenas saída. Quando a entrada de cache foi atualizada pela última vez em UTC.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
usageMetadata
object (UsageMetadata)
Apenas saída. Metadados sobre o uso do conteúdo armazenado em cache.
expiration
Union type
expiration pode ser apenas de um dos tipos a seguir:expireTime
string (Timestamp format)
Carimbo de data/hora em UTC de quando o recurso será considerado expirado. Isso é sempre fornecido na saída, independente do que foi enviado na entrada.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Somente entrada. Nova TTL para este recurso, somente entrada.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
name
string
Apenas saída. Identificador. O nome do recurso que se refere ao conteúdo armazenado em cache. Formato: cachedContents/{id}
displayName
string
Opcional. Imutável. O nome de exibição significativo gerado pelo usuário do conteúdo armazenado em cache. Máximo de 128 caracteres Unicode.
model
string
Obrigatório. Imutável. O nome do Model a ser usado para conteúdo armazenado em cache. Formato: models/{model}
systemInstruction
object (Content)
Opcional. Somente entrada. Imutável. Instrução do sistema definida pelo desenvolvedor. No momento, somente texto.
toolConfig
object (ToolConfig)
Opcional. Somente entrada. Imutável. Configuração da ferramenta. Essa configuração é compartilhada com todas as ferramentas.
| Representação JSON |
|---|
{ "contents": [ { object ( |
ToolConfig
A configuração da ferramenta que contém parâmetros para especificar o uso de Tool na solicitação.
functionCallingConfig
object (FunctionCallingConfig)
Opcional. Configuração de chamada de função.
retrievalConfig
object (RetrievalConfig)
Opcional. Configuração de recuperação.
includeServerSideToolInvocations
boolean
Opcional. Se for "true", a resposta da API vai incluir as chamadas e respostas de ferramentas do lado do servidor na mensagem Content. Isso permite que os clientes observem as interações de ferramentas do servidor.
| Representação JSON |
|---|
{ "functionCallingConfig": { object ( |
FunctionCallingConfig
Configuração para especificar o comportamento de chamada de função.
mode
enum (Mode)
Opcional. Especifica o modo em que a chamada de função deve ser executada. Se não for especificado, o valor padrão será AUTO.
allowedFunctionNames[]
string
Opcional. Um conjunto de nomes de funções que, quando fornecidos, limitam as funções que o modelo vai chamar.
Isso só deve ser definido quando o modo é "ANY" ou "VALIDATED". Os nomes das funções precisam corresponder a [FunctionDeclaration.name]. Quando definido, o modelo prevê uma chamada de função apenas com nomes de função permitidos.
| Representação JSON |
|---|
{
"mode": enum ( |
Modo
Define o comportamento de execução para chamadas de função definindo o modo de execução.
| Tipos enumerados | |
|---|---|
MODE_UNSPECIFIED |
Modo de chamada de função não especificado. Esse valor não deve ser usado. |
AUTO |
Comportamento padrão do modelo, em que ele decide prever uma chamada de função ou uma resposta de linguagem natural. |
ANY |
O modelo é restrito a sempre prever apenas uma chamada de função. Se "allowedFunctionNames" estiver definido, a chamada de função prevista será limitada a qualquer um dos "allowedFunctionNames". Caso contrário, a chamada de função prevista será qualquer uma das "functionDeclarations" fornecidas. |
NONE |
O modelo não vai prever nenhuma chamada de função. O comportamento do modelo é o mesmo que ocorre quando nenhuma declaração de função é transmitida. |
VALIDATED |
O modelo decide prever uma chamada de função ou uma resposta de linguagem natural, mas valida as chamadas de função com decodificação restrita. Se "allowedFunctionNames" estiver definido, a chamada de função prevista será limitada a qualquer um dos "allowedFunctionNames". Caso contrário, a chamada de função prevista será qualquer uma das "functionDeclarations" fornecidas. |
RetrievalConfig
Configuração de recuperação.
latLng
object (LatLng)
Opcional. A localização do usuário.
languageCode
string
Opcional. O código de idioma do usuário. Código do idioma do conteúdo. Use tags de idioma definidas pelo BCP47.
| Representação JSON |
|---|
{
"latLng": {
object ( |
LatLng
Um objeto que representa um par de latitude/longitude. Ele é expresso como um par de valores duplos para representar graus de latitude e longitude. A menos que especificado de outra forma, esse objeto precisa seguir o padrão WGS84. Os valores precisam estar dentro de intervalos normalizados.
latitude
number
A latitude em graus. Precisa estar no intervalo [-90,0, +90,0].
longitude
number
A longitude em graus. Precisa estar no intervalo [-180,0, +180,0].
| Representação JSON |
|---|
{ "latitude": number, "longitude": number } |
UsageMetadata
Metadados sobre o uso do conteúdo armazenado em cache.
totalTokenCount
integer
Número total de tokens consumidos pelo conteúdo armazenado em cache.
| Representação JSON |
|---|
{ "totalTokenCount": integer } |