REST Resource: projects.locations.collections

Risorsa: raccolta

Messaggio che descrive l'oggetto Collection

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  }
}
Campi
name

string

Identifier. name of resource
displayName

string

Facoltativo. Nome visualizzato della raccolta specificato dall'utente
description

string

Facoltativo. Descrizione della raccolta specificata dall'utente
createTime

string (Timestamp format)

Solo output. [Solo output] Timestamp creazione

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. [Solo output] Timestamp aggiornamento

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "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)

Facoltativo. Etichette come coppie chiave-valore.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
schema
(deprecated)

object (Struct format)

Facoltativo. Ritirato: schema JSON per i dati. Utilizza invece dataSchema.
vectorSchema

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

Facoltativo. Schema per i campi vettoriali. Solo i campi vettoriali in questo schema saranno ricercabili. I nomi dei campi devono contenere solo caratteri alfanumerici, trattini bassi e trattini.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
dataSchema

object (Struct format)

Facoltativo. Schema JSON per i dati. I nomi dei campi devono contenere solo caratteri alfanumerici, trattini bassi e trattini.

VectorField

Messaggio che descrive un campo vettoriale.

Rappresentazione 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.
}
Campi
Campo unione vector_type_config. Configurazione del tipo di vettore. vector_type_config può essere solo uno dei seguenti tipi:
denseVector

object (DenseVectorField)

Campo vettoriale denso.
sparseVector

object (SparseVectorField)

Campo vettoriale sparso.

DenseVectorField

Messaggio che descrive un campo vettoriale denso.

Rappresentazione JSON 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
Campi
dimensions

integer

Dimensionalità del campo vettoriale.
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

Facoltativo. Configurazione per la generazione di embedding per il campo vettoriale. Se non specificato, il campo di incorporamento deve essere compilato in DataObject.

VertexEmbeddingConfig

Messaggio che descrive la configurazione per la generazione di embedding per un campo vettoriale utilizzando l'API Vertex AI Embeddings.

Rappresentazione JSON 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
Campi
modelId

string

Obbligatorio. Obbligatorio: ID del modello di embedding da utilizzare. Per l'elenco dei modelli supportati, visita la pagina https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models.
textTemplate

string

Obbligatorio. (Obbligatorio) Modello di testo per l'input del modello. Il modello deve contenere uno o più riferimenti ai campi in DataObject, ad esempio: "Titolo del film: {title} ---- Trama del film: {plot}".
taskType

enum (EmbeddingTaskType)

Obbligatorio. Obbligatorio: tipo di attività per gli incorporamenti.

EmbeddingTaskType

Rappresenta l'attività per cui verranno utilizzati gli incorporamenti.

Enum
EMBEDDING_TASK_TYPE_UNSPECIFIED Tipo di attività non specificato.
RETRIEVAL_QUERY Specifica che il testo indicato è una query in un'impostazione di ricerca/recupero.
RETRIEVAL_DOCUMENT Specifica che il testo indicato è un documento del corpus in cui viene eseguita la ricerca.
SEMANTIC_SIMILARITY Specifica che il testo indicato verrà utilizzato per STS.
CLASSIFICATION Specifica che il testo indicato verrà classificato.
CLUSTERING Specifica che gli embedding verranno utilizzati per il clustering.
QUESTION_ANSWERING Specifica che gli incorporamenti verranno utilizzati per rispondere alle domande.
FACT_VERIFICATION Specifica che gli incorporamenti verranno utilizzati per la verifica dei fatti.
CODE_RETRIEVAL_QUERY Specifica che gli incorporamenti verranno utilizzati per il recupero del codice.

SparseVectorField

Questo tipo non contiene campi.

Messaggio che descrive un campo del vettore sparso.

Metodi

create

 Crea una nuova risorsa Collection in un progetto e una località specifici.

delete

 Elimina una singola raccolta.

exportDataObjects

 Avvia un'operazione di lunga durata per esportare DataObject da una raccolta.

get

 Recupera i dettagli di una singola raccolta.

importDataObjects

 Avvia un'operazione a lunga esecuzione per importare DataObject in una raccolta.

list

 Elenca le risorse Collection in un progetto e una località specifici.

patch

 Aggiorna i parametri di una singola raccolta.