REST Resource: projects.locations.collections

Recurso: Collection

Mensaje que describe el objeto Collection

Representación JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  },
  "encryptionSpec": {
    object (EncryptionSpec)
  }
}
Campos
name

string

Identificador. Nombre del recurso
displayName

string

Es opcional. Nombre visible de la colección especificado por el usuario
description

string

Es opcional. Descripción de la colección especificada por el usuario
createTime

string (Timestamp format)

Solo salida. [Solo salida] Marca de tiempo de creación

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. [Solo salida] Marca de tiempo de actualización

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Es opcional. Etiquetas como pares clave-valor.

Un objeto que contiene una lista de "key": value pares. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
vectorSchema

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

Es opcional. Esquema para campos de vectores. Solo se podrán buscar los campos de vectores en este esquema. Los nombres de los campos solo deben contener caracteres alfanuméricos, guiones bajos y guiones.

Un objeto que contiene una lista de "key": value pares. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
dataSchema

object (Struct format)

Es opcional. Esquema JSON para datos. Los nombres de los campos solo deben contener caracteres alfanuméricos, guiones bajos y guiones. El esquema debe cumplir con el borrador 7 del esquema JSON.
encryptionSpec

object (EncryptionSpec)

Es opcional. Inmutable. Especifica la especificación de la clave de encriptación administrada por el cliente para una colección. Si se configura, esta colección y todos sus subrecursos estarán protegidos por esta clave.

VectorField

Mensaje que describe un campo de vector.

Representación 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ón vector_type_config. Configuración del tipo de vector. vector_type_config puede ser solo uno de los siguientes:
denseVector

object (DenseVectorField)

Campo de vector denso.
sparseVector

object (SparseVectorField)

Campo de vector disperso.

DenseVectorField

Mensaje que describe un campo de vector denso.

Representación JSON 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
Campos
dimensions

integer

Dimensionalidad del campo de vector.
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

Es opcional. Configuración para generar incorporaciones para el campo de vector. Si no se especifica, el campo de incorporación debe propagarse en el DataObject.

VertexEmbeddingConfig

Mensaje que describe la configuración para generar incorporaciones para un campo de vector con la API de embeddings de Vertex AI.

Representación JSON 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
Campos
modelId

string

Obligatorio. Obligatorio: Es el ID del modelo de incorporación que se usará. Consulta https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models para obtener la lista de modelos compatibles.
textTemplate

string

Obligatorio. Obligatorio: Es la plantilla de texto para la entrada del modelo. La plantilla debe contener una o más referencias a los campos del DataObject, por ejemplo: "Título de la película: {title} ---- Trama de la película: {plot}".
taskType

enum (EmbeddingTaskType)

Obligatorio. Obligatorio: Es el tipo de tarea para las incorporaciones.

EmbeddingTaskType

Representa la tarea para la que se usarán las incorporaciones.

Enums
EMBEDDING_TASK_TYPE_UNSPECIFIED Tipo de tarea no especificado.
RETRIEVAL_QUERY Especifica que el texto dado es una consulta en un parámetro de configuración de búsqueda/recuperación.
RETRIEVAL_DOCUMENT Especifica que el texto dado es un documento del corpus que se está buscando.
SEMANTIC_SIMILARITY Especifica que el texto dado se usará para STS.
CLASSIFICATION Especifica que se clasificará el texto dado.
CLUSTERING Especifica que las incorporaciones se usarán para el agrupamiento en clústeres.
QUESTION_ANSWERING Especifica que los embeddings se usarán para la búsqueda de respuestas.
FACT_VERIFICATION Especifica que las incorporaciones se usarán para la verificación de datos.
CODE_RETRIEVAL_QUERY Especifica que las incorporaciones se usarán para la recuperación de código.

SparseVectorField

Este tipo no tiene campos.

Mensaje que describe un campo de vector disperso.

EncryptionSpec

Representa una especificación de clave de encriptación administrada por el cliente que se puede aplicar a una colección de Vector Search.

Representación JSON 
{
  "cryptoKeyName": string
}
Campos
cryptoKeyName

string

Obligatorio. Nombre del recurso de la clave de Cloud KMS que se usa para proteger el recurso.

La clave de Cloud KMS debe estar en la misma región que el recurso. Debe tener el formato projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Métodos

create

 Crea una nueva colección en un proyecto y una ubicación determinados.

delete

 Borra una sola colección.

exportDataObjects

 Inicia una operación de larga duración para exportar DataObjects desde una colección.

get

 Obtiene detalles de una sola colección.

importDataObjects

 Inicia una operación de larga duración para importar DataObjects a una colección.

list

 Enumera las colecciones en un proyecto y una ubicación determinados.

patch

 Actualiza los parámetros de una sola colección.