REST Resource: projects.locations.collections

Ressource : Collection

Message décrivant l'objet Collection

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  }
}
Champs
name

string

Identifiant, nom de la ressource
displayName

string

Facultatif. Nom à afficher de la collection spécifié par l'utilisateur
description

string

Facultatif. Description de la collection spécifiée par l'utilisateur
createTime

string (Timestamp format)

Uniquement en sortie. [Sortie uniquement] Code temporel de création

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. [Sortie uniquement] Code temporel de mise à jour

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "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)

Facultatif. Étiquettes sous forme de paires clé/valeur.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
schema
(deprecated)

object (Struct format)

Facultatif. Obsolète : schéma JSON pour les données. Veuillez utiliser dataSchema à la place.
vectorSchema

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

Facultatif. Schéma pour les champs vectoriels. Seuls les champs vectoriels de ce schéma pourront faire l'objet d'une recherche. Les noms de champs ne doivent contenir que des caractères alphanumériques, des traits de soulignement et des traits d'union.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
dataSchema

object (Struct format)

Facultatif. Schéma JSON pour les données. Les noms de champs ne doivent contenir que des caractères alphanumériques, des traits de soulignement et des traits d'union.

VectorField

Message décrivant un champ vectoriel.

Représentation 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.
}
Champs
Champ d'union vector_type_config. Configuration du type de vecteur. vector_type_config ne peut être qu'un des éléments suivants :
denseVector

object (DenseVectorField)

Champ de vecteur dense.
sparseVector

object (SparseVectorField)

Champ de vecteur creux.

DenseVectorField

Message décrivant un champ vectoriel dense.

Représentation JSON 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
Champs
dimensions

integer

Dimensionalité du champ vectoriel.
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

Facultatif. Configuration pour générer des embeddings pour le champ vectoriel. Si ce champ n'est pas spécifié, le champ d'intégration doit être renseigné dans DataObject.

VertexEmbeddingConfig

Message décrivant la configuration pour générer des embeddings pour un champ vectoriel à l'aide de l'API Vertex AI Embeddings.

Représentation JSON 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
Champs
modelId

string

Obligatoire. Obligatoire : ID du modèle d'embedding à utiliser. Pour obtenir la liste des modèles compatibles, consultez https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models.
textTemplate

string

Obligatoire. Obligatoire : modèle de texte pour l'entrée du modèle. Le modèle doit contenir une ou plusieurs références à des champs dans DataObject, par exemple : "Titre du film : {title} ---- Synopsis : {plot}".
taskType

enum (EmbeddingTaskType)

Obligatoire. Obligatoire : type de tâche pour les embeddings.

EmbeddingTaskType

Représente la tâche pour laquelle les embeddings seront utilisés.

Enums
EMBEDDING_TASK_TYPE_UNSPECIFIED Type de tâche non spécifié.
RETRIEVAL_QUERY Spécifie que le texte donné est une requête dans un contexte de recherche/récupération.
RETRIEVAL_DOCUMENT Spécifie que le texte donné est un document du corpus dans lequel la recherche est effectuée.
SEMANTIC_SIMILARITY Indique que le texte donné sera utilisé pour la STS.
CLASSIFICATION Spécifie que le texte donné sera classifié.
CLUSTERING Spécifie que les embeddings seront utilisées pour le clustering.
QUESTION_ANSWERING Spécifie que les embeddings seront utilisés pour répondre aux questions.
FACT_VERIFICATION Spécifie que les embeddings seront utilisés pour la vérification des faits.
CODE_RETRIEVAL_QUERY Spécifie que les embeddings seront utilisés pour la récupération de code.

SparseVectorField

Ce type ne comporte aucun champ.

Message décrivant un champ de vecteur creux.

Méthodes

create

 Crée une collection dans un projet et un emplacement donnés.

delete

 Supprime une seule collection.

exportDataObjects

 Lance une opération de longue durée pour exporter des DataObjects à partir d'une collection.

get

 Récupère les détails d'une seule collection.

importDataObjects

 Lance une opération de longue durée pour importer des DataObjects dans une collection.

list

 Liste les collections d'un projet et d'un emplacement donnés.

patch

 Met à jour les paramètres d'une seule collection.