- Recurso: CachedContent
- Conteúdo
- Parte
- Blob
- FunctionCall
- FunctionResponse
- FileData
- Ferramenta
- FunctionDeclaration
- Esquema
- Tipo
- ToolConfig
- FunctionCallingConfig
- Mode
- UsageMetadata
- Métodos
Recurso: CachedContent
Conteúdo que foi pré-processado e pode ser usado em solicitações posteriores ao GenerativeService.
O conteúdo armazenado em cache só pode ser usado com o modelo para o qual foi criado.
Representação JSON |
---|
{ "contents": [ { object ( |
Campos | |
---|---|
contents[] |
Opcional. Apenas entrada. Imutável. O conteúdo a ser armazenado em cache. |
tools[] |
Opcional. Apenas entrada. Imutável. Uma lista de |
createTime |
Apenas saída. Hora de criação da entrada do cache. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
updateTime |
Apenas saída. Quando a entrada do cache foi atualizada pela última vez no horário UTC. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
usageMetadata |
Apenas saída. Metadados sobre o uso do conteúdo armazenado em cache. |
Campo de união expiration . Especifica quando este recurso vai expirar. expiration só pode ser de um dos seguintes tipos: |
|
expireTime |
Carimbo de data/hora em UTC de quando o recurso será considerado expirado. Isso é sempre fornecido na saída, independente do que tiver sido enviado na entrada. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
ttl |
Apenas entrada. Novo TTL para este recurso, somente entrada. Duração em segundos com até nove dígitos fracionários, terminando em " |
name |
Opcional. Identificador. O nome do recurso que se refere ao conteúdo armazenado em cache. Formato: |
displayName |
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 |
Obrigatório. Imutável. O nome do |
systemInstruction |
Opcional. Apenas entrada. Imutável. O desenvolvedor definiu as instruções do sistema. No momento, somente texto. |
toolConfig |
Opcional. Apenas entrada. Imutável. Configuração da ferramenta. Essa configuração é compartilhada para todas as ferramentas. |
Conteúdo
O tipo de dados estruturado base que contém o conteúdo de várias partes de uma mensagem.
Uma Content
inclui um campo role
que designa o produtor da Content
e um campo parts
que contém dados de várias partes com o conteúdo da troca de mensagens.
Representação JSON |
---|
{
"parts": [
{
object ( |
Campos | |
---|---|
parts[] |
|
role |
Opcional. O produtor do conteúdo. Precisa ser "user" ou "model". Útil para definir para conversas de várias interações. Caso contrário, pode ser deixado em branco ou sem definição. |
Parte
Um tipo de dados contendo mídia que faz parte de uma mensagem Content
de várias partes.
Um Part
consiste em dados que têm um tipo de dados associado. Uma Part
só pode conter um dos tipos aceitos no Part.data
.
Um Part
precisa ter um tipo MIME IANA fixo que identifica o tipo e o subtipo da mídia se o campo inlineData
estiver preenchido com bytes brutos.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
text |
Texto inline. |
inlineData |
Bytes de mídia inline. |
functionCall |
Uma previsão |
functionResponse |
O resultado de uma |
fileData |
Dados baseados em URI. |
Blob
Bytes de mídia bruta.
O texto não deve ser enviado como bytes brutos. Use o campo "texto".
Representação JSON |
---|
{ "mimeType": string, "data": string } |
Campos | |
---|---|
mimeType |
O tipo MIME padrão da IANA dos dados de origem. Exemplos: - image/png - image/jpeg Se um tipo MIME incompatível for fornecido, será retornado um erro. Para uma lista completa dos tipos compatíveis, consulte Formatos de arquivo compatíveis. |
data |
Bytes brutos para formatos de mídia. Uma string codificada em base64. |
FunctionCall
Uma previsão FunctionCall
retornada do modelo que contém uma string representando FunctionDeclaration.name
com os argumentos e os valores deles.
Representação JSON |
---|
{ "name": string, "args": { object } } |
Campos | |
---|---|
name |
Obrigatório. O nome da função a ser chamada. Precisa ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com comprimento máximo de 63. |
args |
Opcional. Os parâmetros e valores da função no formato de objeto JSON. |
FunctionResponse
O resultado de uma FunctionCall
que contém uma string representando o FunctionDeclaration.name
e um objeto JSON estruturado contendo qualquer saída da função é usada como contexto para o modelo. Ela vai conter o resultado de uma FunctionCall
feita com base na previsão do modelo.
Representação JSON |
---|
{ "name": string, "response": { object } } |
Campos | |
---|---|
name |
Obrigatório. O nome da função a ser chamada. Precisa ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com comprimento máximo de 63. |
response |
Obrigatório. A resposta da função no formato de objeto JSON. |
FileData
Dados baseados em URI.
Representação JSON |
---|
{ "mimeType": string, "fileUri": string } |
Campos | |
---|---|
mimeType |
Opcional. O tipo MIME padrão da IANA dos dados de origem. |
fileUri |
Obrigatório. URI. |
Ferramenta
Detalhes da ferramenta que o modelo pode usar para gerar uma resposta.
Um Tool
é um trecho de código que permite ao sistema interagir com sistemas externos para realizar uma ação, ou conjunto de ações, fora do conhecimento e do escopo do modelo.
Representação JSON |
---|
{
"functionDeclarations": [
{
object ( |
Campos | |
---|---|
functionDeclarations[] |
Opcional. Uma lista de O modelo ou sistema não executa a função. Em vez disso, a função definida pode ser retornada como uma [FunctionCall][content.part.function_call] com argumentos para execução no lado do cliente. O modelo pode decidir chamar um subconjunto dessas funções preenchendo [FunctionCall][content.part.function_call] na resposta. A próxima rodada da conversa pode conter uma [FunctionResponse][content.part.function_response] com o contexto de geração da "função" [content.role] para a próxima rodada do modelo. |
FunctionDeclaration
Representação estruturada de uma declaração de função, conforme definido pela especificação OpenAPI 3.03 (em inglês). Essa declaração inclui o nome e os parâmetros da função. Essa FunctionDeclaration é uma representação de um bloco de código que pode ser usado como um Tool
pelo modelo e executado pelo cliente.
Representação JSON |
---|
{
"name": string,
"description": string,
"parameters": {
object ( |
Campos | |
---|---|
name |
Obrigatório. O nome da função. Precisa ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com comprimento máximo de 63. |
description |
Obrigatório. Uma breve descrição da função. |
parameters |
Opcional. Descreve os parâmetros para esta função. Reflete a chave da string do objeto de parâmetro da OpenAPI 3.03: o nome do parâmetro. Os nomes dos parâmetros diferenciam maiúsculas de minúsculas. Valor do esquema: o esquema que define o tipo usado para o parâmetro. |
Esquema
O objeto Schema
permite a definição de tipos de dados de entrada e saída. Esses tipos podem ser objetos, mas também primitivos e matrizes. Representa um subconjunto selecionado de um objeto de esquema da OpenAPI 3.0.
Representação JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Obrigatório. Tipo de dados. |
format |
Opcional. O formato dos dados. Isso é usado apenas para tipos de dados primitivos. Formatos suportados: para NUMBER, tipo: float, double para tipo INTEGER: int32, int64 |
description |
Opcional. Uma breve descrição do parâmetro. Ela pode conter exemplos de uso. A descrição do parâmetro pode ser formatada como Markdown. |
nullable |
Opcional. Indica se o valor pode ser nulo. |
enum[] |
Opcional. Possíveis valores do elemento de Type.STRING com formato de enumeração. Por exemplo, podemos definir uma direção de tipo enumerado como : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} |
properties |
Opcional. Propriedades de Type.OBJECT. Um objeto com uma lista de pares |
required[] |
Opcional. Propriedades obrigatórias de Type.OBJECT. |
items |
Opcional. Esquema dos elementos de Type.ARRAY. |
Tipo
Tipo contém a lista de tipos de dados OpenAPI, conforme definido por https://spec.openapis.org/oas/v3.0.3#data-types
Tipos enumerados | |
---|---|
TYPE_UNSPECIFIED |
Não especificado, não deve ser usado. |
STRING |
Tipo de string. |
NUMBER |
Tipo de número. |
INTEGER |
Tipo de número inteiro. |
BOOLEAN |
Tipo booleano. |
ARRAY |
Tipo de matriz. |
OBJECT |
Tipo de objeto. |
ToolConfig
A configuração da ferramenta que contém parâmetros para especificar o uso de Tool
na solicitação.
Representação JSON |
---|
{
"functionCallingConfig": {
object ( |
Campos | |
---|---|
functionCallingConfig |
Opcional. Config. da chamada de função. |
FunctionCallingConfig
Configuração para especificar o comportamento de chamada de função.
Representação JSON |
---|
{
"mode": enum ( |
Campos | |
---|---|
mode |
Opcional. Especifica o modo em que a chamada de função precisa ser executada. Se não for especificado, o valor padrão será definido como AUTOMÁTICO. |
allowedFunctionNames[] |
Opcional. Um conjunto de nomes de função que, quando fornecidos, limita as funções que o modelo vai chamar. Isso só deve ser definido quando o Modo for QUALQUER. Os nomes das funções precisam corresponder a [FunctionDeclaration.name]. Com o modo definido como QUALQUER, o modelo vai prever uma chamada de função do conjunto de nomes de função fornecidos. |
Modo
Define o comportamento de execução para a chamada de função ao definir 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: o modelo 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 definida, a chamada de função prevista será limitada a qualquer um dos "allowedFunctionNames". Caso contrário, a chamada da 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 de quando nenhuma declaração de função é transmitida. |
UsageMetadata
Metadados sobre o uso do conteúdo armazenado em cache.
Representação JSON |
---|
{ "totalTokenCount": integer } |
Campos | |
---|---|
totalTokenCount |
Número total de tokens consumidos pelo conteúdo em cache. |
Métodos |
|
---|---|
|
Cria o recurso CachedContent. |
|
Exclui o recurso CachedContent. |
|
Lê o recurso CachedContent. |
|
Lista CachedContents. |
|
Atualiza o recurso CachedContent (apenas a expiração é atualizável). |