REST Resource: projects.locations.collections

Recurso: Collection

Mensagem que descreve o objeto Collection

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  }
}
Campos
name

string

Identificador. Nome do recurso.
displayName

string

Opcional. Nome de exibição da coleção especificado pelo usuário
description

string

Opcional. Descrição da coleção especificada pelo usuário
createTime

string (Timestamp format)

Apenas saída. [Apenas saída] Cria um carimbo de data/hora.

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. [Apenas saída] Atualiza um carimbo de data/hora.

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

map (key: string, value: string)

Opcional. Rótulos como pares de chave-valor.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
schema
(deprecated)

object (Struct format)

Opcional. Descontinuado: esquema JSON para dados. Use dataSchema.
vectorSchema

map (key: string, value: object (VectorField))

Opcional. Esquema para campos de vetor. Somente os campos de vetor nesse esquema poderão ser pesquisados. Os nomes de campo só podem conter caracteres alfanuméricos, sublinhados e hifens.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
dataSchema

object (Struct format)

Opcional. Esquema JSON para dados. Os nomes de campo só podem conter caracteres alfanuméricos, sublinhados e hifens.

VectorField

Mensagem que descreve um campo de vetor.

Representação JSON 
{

  // Union field vector_type_config can be only one of the following:
  "denseVector": {
    object (DenseVectorField)
  },
  "sparseVector": {
    object (SparseVectorField)
  }
  // End of list of possible types for union field vector_type_config.
}
Campos
Campo de união vector_type_config. Configuração do tipo de vetor. vector_type_config pode ser apenas de um dos tipos a seguir:
denseVector

object (DenseVectorField)

Campo de vetor denso.
sparseVector

object (SparseVectorField)

Campo de vetor esparso.

DenseVectorField

Mensagem que descreve um campo de vetor denso.

Representação JSON 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
Campos
dimensions

integer

Dimensionalidade do campo vetorial.
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

Opcional. Configuração para gerar embeddings para o campo de vetor. Se não for especificado, o campo de incorporação precisará ser preenchido no DataObject.

VertexEmbeddingConfig

Mensagem que descreve a configuração para gerar embeddings para um campo de vetor usando a API Embeddings da Vertex AI.

Representação JSON 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
Campos
modelId

string

Obrigatório. Obrigatório: ID do modelo de embedding a ser usado. Consulte https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models para conferir a lista de modelos compatíveis.
textTemplate

string

Obrigatório. Obrigatório: modelo de texto para a entrada do modelo. O modelo precisa conter uma ou mais referências a campos no DataObject, por exemplo: "Título do filme: {title} ---- Sinopse: {plot}".
taskType

enum (EmbeddingTaskType)

Obrigatório. Obrigatório: tipo de tarefa para os embeddings.

EmbeddingTaskType

Representa a tarefa para que os embeddings serão usados.

Tipos enumerados
EMBEDDING_TASK_TYPE_UNSPECIFIED Tipo de tarefa não especificado.
RETRIEVAL_QUERY Especifica que o texto é uma consulta em uma configuração de pesquisa/recuperação.
RETRIEVAL_DOCUMENT Especifica que o texto é um documento do corpus pesquisado.
SEMANTIC_SIMILARITY Especifica que o texto fornecido será usado para STS.
CLASSIFICATION Especifica que o texto fornecido será classificado.
CLUSTERING Especifica que os embeddings serão usados para clustering.
QUESTION_ANSWERING Especifica que os embeddings serão usados para responder a perguntas.
FACT_VERIFICATION Especifica que os embeddings serão usados para verificação de fatos.
CODE_RETRIEVAL_QUERY Especifica que os embeddings serão usados para recuperação de código.

SparseVectorField

Esse tipo não tem campos.

Mensagem que descreve um campo de vetor esparso.

Métodos

create

 Cria uma nova coleção em determinado projeto e local.

delete

 Exclui uma única coleção.

exportDataObjects

 Inicia uma operação de longa duração para exportar DataObjects de uma coleção.

get

 Recebe detalhes de uma única coleção.

importDataObjects

 Inicia uma operação de longa duração para importar DataObjects para uma coleção.

list

 Lista as coleções em determinado projeto e local.

patch

 Atualiza os parâmetros de uma única coleção.