Corpora

Método: corpora.create

Cria um Corpus vazio.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/corpora

Corpo da solicitação

O corpo da solicitação contém uma instância de Corpus.

Campos
name string

Imutável. Identificador. O nome do recurso Corpus. O ID (nome sem o prefixo "corpora/") pode conter até 40 caracteres alfanuméricos minúsculos ou traços (-). Ele não pode começar nem terminar com um traço. Se o nome estiver vazio na criação, um nome exclusivo será derivado de displayName junto com um sufixo aleatório de 12 caracteres. Exemplo: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcional. O nome de exibição legível para o Corpus. O nome de exibição não pode ter mais de 512 caracteres, incluindo espaços. Exemplo: "Documentos no Semantic Retriever"

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de Corpus.

Método: corpora.query

Realiza uma pesquisa semântica em um Corpus.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Parâmetros de caminho

name string

Obrigatório. O nome do Corpus a ser consultado. Exemplo: corpora/my-corpus-123. Ele assume a forma corpora/{corpora}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
query string

Obrigatório. String de consulta para realizar a pesquisa semântica.

metadataFilters[] object (MetadataFilter)

Opcional. Filtre metadados de Chunk e Document. Cada objeto MetadataFilter precisa corresponder a uma chave exclusiva. Vários objetos MetadataFilter são unidos por "AND"s lógicos.

Exemplo de consulta no nível do documento: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

Lista de objetos MetadataFilter: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Exemplo de consulta no nível do bloco para um intervalo numérico de valores: (ano > 2015 AND ano <= 2020)

Lista de objetos MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Observação: os "AND" para a mesma chave só são aceitos para valores numéricos. Os valores de string só aceitam "OR"s para a mesma chave.

resultsCount integer

Opcional. O número máximo de Chunks a serem retornados. O serviço pode retornar menos Chunks.

Se não for especificado, no máximo 10 Chunks serão retornados. O número máximo de resultados especificado é 100.

Corpo da resposta

Resposta de corpora.query contendo uma lista de partes relevantes.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
relevantChunks[] object (RelevantChunk)

Os trechos relevantes.

Representação JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Método: corpora.list

Lista todos os Corpora pertencentes ao usuário.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/corpora

Parâmetros de consulta

pageSize integer

Opcional. O número máximo de Corpora a serem retornados (por página). O serviço pode retornar menos Corpora.

Se não for especificado, no máximo 10 Corpora serão retornados. O limite máximo é de 20 Corpora por página.

pageToken string

Opcional. Um token de página recebido de uma chamada corpora.list anterior.

Forneça o nextPageToken retornado na resposta como um argumento para a próxima solicitação e recupere a página seguinte.

Ao paginar, todos os outros parâmetros fornecidos para corpora.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 de corpora.list contendo uma lista paginada de Corpora. Os resultados são classificados por corpus.create_time crescente.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
corpora[] object (Corpus)

Os corpora retornados.

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á mais páginas.

Representação JSON 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Método: corpora.get

Recebe informações sobre um Corpus específico.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parâmetros de caminho

name string

Obrigatório. O nome do Corpus. Exemplo: corpora/my-corpus-123. Ele assume a forma corpora/{corpora}.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Corpus.

Método: corpora.patch

Atualiza um Corpus.

Endpoint

patch https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Parâmetros de caminho

corpus.name string

Imutável. Identificador. O nome do recurso Corpus. O ID (nome sem o prefixo "corpora/") pode conter até 40 caracteres alfanuméricos minúsculos ou traços (-). Ele não pode começar nem terminar com um traço. Se o nome estiver vazio na criação, um nome exclusivo será derivado de displayName junto com um sufixo aleatório de 12 caracteres. Exemplo: corpora/my-awesome-corpora-123a456b789c. Ele assume a forma corpora/{corpora}.

Parâmetros de consulta

updateMask string (FieldMask format)

Obrigatório. Lista de campos a serem atualizados. No momento, isso só permite atualizar displayName.

É 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 Corpus.

Campos
displayName string

Opcional. O nome de exibição legível para o Corpus. O nome de exibição não pode ter mais de 512 caracteres, incluindo espaços. Exemplo: "Documentos no Semantic Retriever"

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Corpus.

Método: corpora.delete

Exclui um Corpus.

Endpoint

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parâmetros de caminho

name string

Obrigatório. O nome do recurso do Corpus. Exemplo: corpora/my-corpus-123. Ele assume a forma corpora/{corpora}.

Parâmetros de consulta

force boolean

Opcional. Se definido como verdadeiro, todos os Documents e objetos relacionados a esse Corpus também serão excluídos.

Se for "false" (padrão), um erro FAILED_PRECONDITION será retornado se Corpus contiver algum Document.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se não houver nenhum problema, o corpo da resposta será um objeto JSON vazio.

Recurso REST: corpora.permissions

Recurso: permissão

O recurso de permissão concede ao usuário, grupo ou ao resto do mundo acesso ao recurso da API PaLM (por exemplo, um modelo ajustado, um corpus).

Um papel é um conjunto de operações permitidas que permite aos usuários realizar ações específicas nos recursos da API PaLM. Para disponibilizar as permissões a usuários, grupos ou contas de serviço, atribua papéis. Ao atribuir um papel, você concede as permissões que ele contém.

Há três papéis concêntricos. Cada papel é um superconjunto das operações permitidas do papel anterior:

  • o leitor pode usar o recurso (por exemplo, modelo ajustado, corpus) para inferência
  • o gravador tem as permissões do leitor e também pode editar e compartilhar
  • O proprietário tem permissões de gravador e também pode excluir.
Campos
name string

Apenas saída. Identificador. O nome da permissão. Um nome exclusivo será gerado na criação. Exemplos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Somente saída.

granteeType enum (GranteeType)

Opcional. Imutável. O tipo do beneficiário.

emailAddress string

Opcional. Imutável. O endereço de e-mail do usuário ou grupo a que esta permissão se refere. O campo não é definido quando o tipo de beneficiário da permissão é "EVERYONE".

role enum (Role)

Obrigatório. O papel concedido por essa permissão.

Representação JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Define os tipos de beneficiário dessa permissão.

Enums
GRANTEE_TYPE_UNSPECIFIED O valor padrão. Esse valor não é usado.
USER Representa um usuário. Quando definido, você precisa fornecer o emailAddress do usuário.
GROUP Representa um grupo. Quando definido, é necessário fornecer o emailAddress do grupo.
EVERYONE Representa o acesso a todos. Nenhuma informação extra é necessária.

Papel

Define o papel concedido por essa permissão.

Enums
ROLE_UNSPECIFIED O valor padrão. Esse valor não é usado.
OWNER O proprietário pode usar, atualizar, compartilhar e excluir o recurso.
WRITER O gravador pode usar, atualizar e compartilhar o recurso.
READER O leitor pode usar o recurso.

MetadataFilter

Filtro fornecido pelo usuário para limitar a recuperação com base em valores de metadados no nível Chunk ou Document. Exemplo (gênero = drama OU gênero = ação): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Campos
key string

Obrigatório. A chave dos metadados para filtrar.

conditions[] object (Condition)

Obrigatório. Os Conditions da chave especificada que vão acionar este filtro. Vários Conditions são unidos por ORs lógicos.

Representação JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Condição

Condição de filtro aplicável a uma única chave.

Campos
operation enum (Operator)

Obrigatório. Operador aplicado ao par de chave-valor especificado para acionar a condição.

value Union type
O tipo de valor precisa ser consistente com o tipo definido no campo para a chave correspondente. Se os tipos de valores não forem consistentes, o resultado será um conjunto vazio. Quando o CustomMetadata tem um tipo de valor StringList, a condição de filtragem precisa usar string_value com uma operação INCLUDES/EXCLUDES. Caso contrário, o resultado também será um conjunto vazio. value pode ser apenas um dos seguintes:
stringValue string

O valor da string para filtrar os metadados.

numericValue number

O valor numérico para filtrar os metadados.

Representação JSON 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Operador

Define os operadores válidos que podem ser aplicados a um par de chave-valor.

Enums
OPERATOR_UNSPECIFIED O valor padrão. Esse valor não é usado.
LESS Aceito por "numeric".
LESS_EQUAL Aceito por "numeric".
EQUAL Compatível com numérico e string.
GREATER_EQUAL Aceito por "numeric".
GREATER Aceito por "numeric".
NOT_EQUAL Compatível com numérico e string.
INCLUDES Aceito por string somente quando o tipo de valor CustomMetadata da chave especificada tem um stringListValue.
EXCLUDES Aceito por string somente quando o tipo de valor CustomMetadata da chave especificada tem um stringListValue.

RelevantChunk

As informações de um trecho relevante para uma consulta.

Campos
chunkRelevanceScore number

Chunk relevância para a consulta.

chunk object (Chunk)

Chunk associado à consulta.

document object (Document)

Document associado ao bloco.

Representação JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  },
  "document": {
    object (Document)
  }
}

Recurso REST: corpora

Recurso: Corpus

Um Corpus é uma coleção de Documents. Um projeto pode criar até cinco corpora.

Campos
name string

Imutável. Identificador. O nome do recurso Corpus. O ID (nome sem o prefixo "corpora/") pode conter até 40 caracteres alfanuméricos minúsculos ou traços (-). Ele não pode começar nem terminar com um traço. Se o nome estiver vazio na criação, um nome exclusivo será derivado de displayName junto com um sufixo aleatório de 12 caracteres. Exemplo: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcional. O nome de exibição legível para o Corpus. O nome de exibição não pode ter mais de 512 caracteres, incluindo espaços. Exemplo: "Documentos no Semantic Retriever"

createTime string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o Corpus foi criado.

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. O carimbo de data/hora da última atualização do Corpus.

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".

Representação JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}