Vertex AI sta diventando parte di Gemini Enterprise Agent Platform. Per informazioni aggiornate, consulta la documentazione di Agent Platform.

API RAG Engine

Il motore RAG di Vertex AI è un componente della piattaforma Vertex AI, che facilita la Retrieval-Augmented Generation (RAG). RAG Engine consente ai modelli linguistici di grandi dimensioni (LLM) di accedere e incorporare dati da fonti di conoscenza esterne, come documenti e database. Utilizzando la RAG, gli LLM possono generare risposte più accurate e informative.

Elenco dei parametri

Questa sezione elenca:

Parametri	Esempi
Consulta Parametri di gestione del corpus.	Vedi Esempi di gestione del corpus.
Vedi Parametri di gestione dei file.	Vedi Esempi di gestione dei file.
Consulta Parametri di recupero e previsione.	Vedi Esempio di query di recupero.
Vedi Parametri di gestione dei progetti.	Consulta Esempi di gestione dei progetti.

Parametri di gestione del corpus

Per informazioni su un corpus RAG, vedi Gestione dei corpus.

Crea un corpus RAG

Questa tabella elenca i parametri utilizzati per creare un corpus RAG.

Body Request

Parametri
`corpus_type_config`	(Facoltativo) Immutabile. `RagCorpus.CorpusTypeConfig` La configurazione per specificare il tipo di corpus.
`display_name`	Obbligatorio: `string` Il nome visualizzato del corpus RAG.
`description`	Facoltativo: `string` La descrizione del corpus RAG.
`encryption_spec`	(Facoltativo) Immutabile: `string` Il nome della chiave CMEK viene utilizzato per criptare i dati at-rest correlati al corpus RAG. Il nome della chiave è applicabile solo all'opzione `RagManaged` per il database vettoriale. Una volta creato il corpus, questo campo può essere impostato e non può essere aggiornato o eliminato. Formato: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key_name}`
`vector_db_config`	(Facoltativo) Immutabile: `RagVectorDbConfig` La configurazione per i database vettoriali.
`vertex_ai_search_config.serving_config`	Facoltativo: `string` La configurazione di Vertex AI Search. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` o `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`

`CorpusTypeConfig`

Parametri

Parametri
`document_corpus`	`oneof` `RagCorpus.CorpusTypeConfig.DocumentCorpus` Il valore predefinito di `corpus_type_config`, che rappresenta un corpus RAG convenzionale basato su documenti.
`memory_corpus`	`oneof` `RagCorpus.CorpusTypeConfig.MemoryCorpus` Se imposti questo tipo, il corpus RAG è un `MemoryCorpus` che può essere utilizzato con l'API Gemini Live come archivio di memoria. Per ulteriori informazioni, consulta Utilizzare Vertex AI RAG Engine come datastore di memoria.
`memory_corpus.llm_parser`	`oneof` `RagFileParsingConfig.LlmParser` Il parser LLM utilizzato per analizzare e archiviare i contesti delle sessioni dall'API Gemini Live. Puoi creare ricordi per l'indicizzazione.

document_corpus

oneof RagCorpus.CorpusTypeConfig.DocumentCorpus

Il valore predefinito di corpus_type_config, che rappresenta un corpus RAG convenzionale basato su documenti.

memory_corpus

oneof RagCorpus.CorpusTypeConfig.MemoryCorpus

Se imposti questo tipo, il corpus RAG è un MemoryCorpus che può essere utilizzato con l'API Gemini Live come archivio di memoria.

Per ulteriori informazioni, consulta Utilizzare Vertex AI RAG Engine come datastore di memoria.

memory_corpus.llm_parser

oneof RagFileParsingConfig.LlmParser

Il parser LLM utilizzato per analizzare e archiviare i contesti delle sessioni dall'API Gemini Live. Puoi creare ricordi per l'indicizzazione.

`RagVectorDbConfig`

Parametri
`rag_managed_db`	`oneof` `vector_db`: `RagVectorDbConfig.RagManagedDb` Se non viene specificato alcun database vettoriale, `rag_managed_db` è il database vettoriale predefinito.
`rag_managed_db.knn`	`oneof` `retrieval_strategy`: `KNN` Valore predefinito. Trova i vicini più vicini esatti confrontando tutti i punti dati nel tuo corpus RAG. Se non specifichi una strategia durante la creazione del corpus RAG, viene utilizzata la strategia di recupero KNN predefinita.
`rag_managed_db.ann`	`oneof` `retrieval_strategy`: `ANN` `tree_depth` Determina il numero di livelli nell'albero. Se hai `O(10K)` file RAG nel corpus RAG, imposta questo valore su 2. Se sono necessari più livelli, imposta questo valore su 3. Se il numero di livelli non è specificato, Vertex AI RAG Engine assegna un valore predefinito di 2 a questo parametro. `leaf_count` Determina il numero di nodi foglia nella struttura basata su albero. Il valore consigliato è `10 * sqrt(num of RAG files in your RAG corpus)`. Se non specificato, Vertex AI RAG Engine assegna un valore predefinito di 500 a questo parametro. `rebuild_ann_index` Vertex AI RAG Engine ricompila l'indice ANN. Imposta `true` nella richiesta API `ImportRagFiles`. Prima di eseguire query sul corpus RAG, è necessario ricompilare l'indice ANN una volta. È supportata una sola ricompilazione simultanea dell'indice su un progetto in ogni località.
`weaviate`	`oneof` `vector_db`: `RagVectorDbConfig.Weaviate` Specifica l'istanza Weaviate.
`weaviate.http_endpoint`	`string` L'endpoint HTTP dell'istanza Weaviate. Questo valore non può essere modificato dopo l'impostazione. Puoi lasciarlo vuoto nella chiamata API `CreateRagCorpus` e impostarlo con un valore non vuoto in una chiamata API `UpdateRagCorpus` successiva.
`weaviate.collection_name`	`string` La raccolta Weaviate a cui è mappato il corpus RAG. Questo valore non può essere modificato dopo l'impostazione. Puoi lasciarlo vuoto nella chiamata API `CreateRagCorpus` e impostarlo con un valore non vuoto in una chiamata API `UpdateRagCorpus` successiva.
`pinecone`	`oneof` `vector_db`: `RagVectorDbConfig.Pinecone` Specifica l'istanza Pinecone.
`pinecone.index_name`	`string` Questo è il nome utilizzato per creare l'indice Pinecone utilizzato con il corpus RAG. Questo valore non può essere modificato dopo l'impostazione. Puoi lasciarlo vuoto nella chiamata API `CreateRagCorpus` e impostarlo con un valore non vuoto in una chiamata API `UpdateRagCorpus` successiva.
`vertex_feature_store`	`oneof` `vector_db`: `RagVectorDbConfig.VertexFeatureStore` Specifica l'istanza di Vertex AI Feature Store.
`vertex_feature_store.feature_view_resource_name`	`string` Il Vertex AI Feature Store `FeatureView` a cui è mappato il corpus RAG. Formato: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` Questo valore non può essere modificato dopo l'impostazione. Puoi lasciarlo vuoto nella chiamata API `CreateRagCorpus` e impostarlo con un valore non vuoto in una chiamata API `UpdateRagCorpus` successiva.
`vertex_vector_search`	`oneof` `vector_db`: `RagVectorDbConfig.VertexVectorSearch` Specifica l'istanza di Vertex Vector Search.
`vertex_vector_search.index`	`string` Questo è il nome della risorsa dell'indice della Ricerca vettoriale utilizzato con il corpus RAG. Formato: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` Questo valore non può essere modificato dopo l'impostazione. Puoi lasciarlo vuoto nella chiamata API `CreateRagCorpus` e impostarlo con un valore non vuoto in una chiamata API `UpdateRagCorpus` successiva.
`vertex_vector_search.index_endpoint`	`string` Nome della risorsa dell'endpoint dell'indice della Ricerca vettoriale utilizzato con il corpus RAG. Formato: `projects/{project}/locations/{location}/indexes/{index}` Questo valore non può essere modificato dopo l'impostazione. Puoi lasciarlo vuoto nella chiamata API `CreateRagCorpus` e impostarlo con un valore non vuoto in una chiamata API `UpdateRagCorpus` successiva.
`api_auth.api_key_config.api_key_secret_version`	`string` Il nome completo della risorsa del secret archiviato in Secret Manager, che contiene la chiave API Weaviate o Pinecone a seconda del database vettoriale scelto. Formato: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}` Puoi lasciarlo vuoto nella chiamata API `CreateRagCorpus` e impostarlo con un valore non vuoto in una chiamata API `UpdateRagCorpus` successiva.
`rag_embedding_model_config.vertex_prediction_endpoint.endpoint`	(Facoltativo) Immutabile: `string` Il modello di embedding da utilizzare per il corpus RAG. Questo valore non può essere modificato dopo l'impostazione. Se lo lasci vuoto, utilizziamo text-embedding-005 come modello di incorporamento.

Aggiorna un corpus RAG

Questa tabella elenca i parametri utilizzati per aggiornare un corpus RAG.

Body Request

Parametri
`display_name`	Facoltativo: `string` Il nome visualizzato del corpus RAG.
`description`	Facoltativo: `string` La descrizione del corpus RAG.
`rag_vector_db.weaviate.http_endpoint`	`string` L'endpoint HTTP dell'istanza Weaviate. Se il tuo `RagCorpus` è stato creato con una configurazione `Weaviate` e questo campo non è mai stato impostato prima, puoi aggiornare l'endpoint HTTP dell'istanza Weaviate.
`rag_vector_db.weaviate.collection_name`	`string` La raccolta Weaviate a cui è mappato il corpus RAG. Se il tuo `RagCorpus` è stato creato con una configurazione `Weaviate` e questo campo non è mai stato impostato prima, puoi aggiornare il nome della raccolta dell'istanza Weaviate.
`rag_vector_db.pinecone.index_name`	`string` Questo è il nome utilizzato per creare l'indice Pinecone utilizzato con il corpus RAG. Se il tuo `RagCorpus` è stato creato con una configurazione `Pinecone` e questo campo non è mai stato impostato prima, puoi aggiornare il nome dell'indice dell'istanza Pinecone.
`rag_vector_db.vertex_feature_store.feature_view_resource_name`	`string` Il Vertex AI Feature Store `FeatureView` a cui è mappato il corpus RAG. Formato: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` Se il tuo `RagCorpus` è stato creato con una configurazione `Vertex AI Feature Store` e questo campo non è mai stato impostato prima, puoi aggiornarlo.
`rag_vector_db.vertex_vector_search.index`	`string` Questo è il nome della risorsa dell'indice della Ricerca vettoriale utilizzato con il corpus RAG. Formato: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` Se il tuo `RagCorpus` è stato creato con una configurazione `Vector Search` e questo campo non è mai stato impostato prima, puoi aggiornarlo.
`rag_vector_db.vertex_vector_search.index_endpoint`	`string` Nome della risorsa dell'endpoint dell'indice della Ricerca vettoriale utilizzato con il corpus RAG. Formato: `projects/{project}/locations/{location}/indexes/{index}` Se il tuo `RagCorpus` è stato creato con una configurazione `Vector Search` e questo campo non è mai stato impostato prima, puoi aggiornarlo.
`rag_vector_db.api_auth.api_key_config.api_key_secret_version`	`string` Il nome completo della risorsa del secret archiviato in Secret Manager, che contiene la chiave API Weaviate o Pinecone, dipende dal database vettoriale scelto. Formato: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}`

Elenca i corpora RAG

Questa tabella elenca i parametri utilizzati per elencare i corpus RAG.

Parametri

Parametri
`page_size`	Facoltativo: `int` Le dimensioni standard della pagina dell'elenco.
`page_token`	Facoltativo: `string` Il token della pagina dell'elenco standard. In genere ottenuto da `[ListRagCorporaResponse.next_page_token][]` della precedente chiamata `[VertexRagDataService.ListRagCorpora][]`.

page_size

Facoltativo: int

Le dimensioni standard della pagina dell'elenco.

page_token

Facoltativo: string

Il token della pagina dell'elenco standard. In genere ottenuto da [ListRagCorporaResponse.next_page_token][] della precedente chiamata [VertexRagDataService.ListRagCorpora][].

Ottenere un corpus RAG

Questa tabella elenca i parametri utilizzati per ottenere un corpus RAG.

Parametri

Parametri
`name`	`string` Il nome della risorsa `RagCorpus`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`

name

string

Il nome della risorsa RagCorpus. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}

Elimina un corpus RAG

Questa tabella elenca i parametri utilizzati per eliminare un corpus RAG.

Parametri

Parametri
`name`	`string` Il nome della risorsa `RagCorpus`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`

name

string

Il nome della risorsa RagCorpus. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}

Creare schemi di metadati in batch

Questa tabella elenca i parametri utilizzati per creare in batch schemi di metadati per un corpus RAG.

Body Request

Parametri

Parametri
`requests`	Obbligatorio: elenco di `CreateRagDataSchemaRequest` I messaggi di richiesta per `CreateRagDataSchema`.

requests

Obbligatorio: elenco di CreateRagDataSchemaRequest

I messaggi di richiesta per CreateRagDataSchema.

`CreateRagDataSchemaRequest`

Parametri

Parametri
`rag_data_schema`	Obbligatorio: `RagDataSchema` Lo schema dei metadati da creare.

rag_data_schema

Obbligatorio: RagDataSchema

Lo schema dei metadati da creare.

`RagDataSchema`

Parametri

Parametri
`key`	Obbligatorio: `string` La chiave dello schema dei metadati.
`schema_details`	`RagMetadataSchemaDetails` I dettagli dello schema dei metadati.

key

Obbligatorio: string

La chiave dello schema dei metadati.

schema_details

RagMetadataSchemaDetails

I dettagli dello schema dei metadati.

`RagMetadataSchemaDetails`

Parametri

Parametri
`type`	`DataType` Il tipo di dati dello schema dei metadati. Opzioni: `INTEGER`, `FLOAT`, `STRING`, `DATETIME`, `BOOLEAN`, `LIST`.

type

DataType

Il tipo di dati dello schema dei metadati. Opzioni: INTEGER, FLOAT, STRING, DATETIME, BOOLEAN, LIST.

Elenca schemi di metadati

Questa tabella elenca i parametri utilizzati per elencare gli schemi dei metadati.

Parametri Descrizione

Parametri	Descrizione
`parent`	Obbligatorio: `string` Il nome della risorsa di `RagCorpus`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`

parent

Obbligatorio: string

Il nome della risorsa di RagCorpus. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}

Elimina schemi di metadati in batch

Questa tabella elenca i parametri utilizzati per eliminare in batch gli schemi di metadati.

Parametri

Parametri
`names`	Obbligatorio: elenco di `string` I nomi delle risorse `RagDataSchema` da eliminare. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}/ragDataSchemas/{rag_data_schema_id}`

names

Obbligatorio: elenco di string

I nomi delle risorse RagDataSchema da eliminare. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}/ragDataSchemas/{rag_data_schema_id}

Parametri di gestione dei file

Per informazioni su un file RAG e sui relativi metadati, consulta Gestione dei file.

Caricare un file RAG

Questa tabella elenca i parametri utilizzati per caricare un file RAG.

Body Request

Parametri

Parametri
`parent`	`string` Il nome della risorsa `RagCorpus`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`
`rag_file`	Obbligatorio: `RagFile` Il file da caricare.
`upload_rag_file_config`	Obbligatorio: `UploadRagFileConfig` La configurazione di `RagFile` da caricare in `RagCorpus`.

parent

string

Il nome della risorsa RagCorpus. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}

rag_file

Obbligatorio: RagFile

Il file da caricare.

upload_rag_file_config

Obbligatorio: UploadRagFileConfig

La configurazione di RagFile da caricare in RagCorpus.

RagFile Descrizione

`RagFile`	Descrizione
`display_name`	Obbligatorio: `string` Il nome visualizzato del file RAG.
`description`	Facoltativo: `string` La descrizione del file RAG.

display_name

Obbligatorio: string

Il nome visualizzato del file RAG.

description

Facoltativo: string

La descrizione del file RAG.

UploadRagFileConfig Descrizione

`UploadRagFileConfig`	Descrizione
`rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_size`	`int32` Numero di token di ogni blocco.
`rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_overlap`	`int32` La sovrapposizione tra i chunk.

rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_size

int32

Numero di token di ogni blocco.

rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_overlap

int32

La sovrapposizione tra i chunk.

Importare file RAG

Questa tabella elenca i parametri utilizzati per importare un file RAG.

Parametri
`parent`	Obbligatorio: `string` Il nome della risorsa `RagCorpus`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`
`gcs_source`	`oneof` `import_source`: `GcsSource` Percorso di Cloud Storage. Supporta l'importazione di singoli file e di intere directory Cloud Storage.
`gcs_source.uris`	`list` di `string` L'URI Cloud Storage che contiene il file di caricamento.
`google_drive_source`	`oneof` `import_source`: `GoogleDriveSource` Posizione di Google Drive. Supporta l'importazione di singoli file e cartelle di Google Drive.
`slack_source`	`oneof` `import_source`: `SlackSource` Il canale Slack in cui viene caricato il file.
`jira_source`	`oneof` `import_source`: `JiraSource` La query Jira in cui viene caricato il file.
`share_point_sources`	`oneof` `import_source`: `SharePointSources` Le origini SharePoint in cui viene caricato il file.
`rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_size`	`int32` Numero di token di ogni blocco.
`rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_overlap`	`int32` La sovrapposizione tra i chunk.
`rag_file_parsing_config`	Facoltativo: `RagFileParsingConfig` Specifica la configurazione dell'analisi per `RagFiles`. Se questo campo non è impostato, RAG utilizza il parser predefinito.
`max_embedding_requests_per_min`	Facoltativo: `int32` Il numero massimo di query al minuto che questo job può eseguire sul modello di embedding specificato nel corpus. Questo valore è specifico per questo job e non viene condiviso con altri job di importazione. Consulta la pagina Quote del progetto per impostare un valore appropriato. Se non specificato, viene utilizzato un valore predefinito di 1000 QPM.

GoogleDriveSource

`GoogleDriveSource`
`resource_ids.resource_id`	Obbligatorio: `string` L'ID della risorsa Google Drive.
`resource_ids.resource_type`	Obbligatorio: `string` Il tipo di risorsa Google Drive.

resource_ids.resource_id

Obbligatorio: string

L'ID della risorsa Google Drive.

resource_ids.resource_type

Obbligatorio: string

Il tipo di risorsa Google Drive.

`SlackSource`
`channels.channels`	Ripetuto: `SlackSource.SlackChannels.SlackChannel` Informazioni sul canale Slack, inclusi ID e intervallo di tempo da importare.
`channels.channels.channel_id`	Obbligatorio: `string` L'ID canale Slack.
`channels.channels.start_time`	Facoltativo: `google.protobuf.Timestamp` Il timestamp iniziale per i messaggi da importare.
`channels.channels.end_time`	Facoltativo: `google.protobuf.Timestamp` Il timestamp finale per l'importazione dei messaggi.
`channels.api_key_config.api_key_secret_version`	Obbligatorio: `string` Il nome risorsa completo del secret archiviato in Secret Manager, che contiene un token di accesso al canale Slack che ha accesso agli ID canale Slack. Vedi: https://api.slack.com/tutorials/tracks/getting-a-token. Formato: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}`

`JiraSource`
`jira_queries.projects`	Ripetuto: `string` Un elenco di progetti Jira da importare nella loro interezza.
`jira_queries.custom_queries`	Ripetuto: `string` Un elenco di query Jira personalizzate da importare. Per informazioni su JQL (Jira Query Language), consulta Assistenza Jira
`jira_queries.email`	Obbligatorio: `string` L'indirizzo email Jira.
`jira_queries.server_uri`	Obbligatorio: `string` L'URI del server Jira.
`jira_queries.api_key_config.api_key_secret_version`	Obbligatorio: `string` Il nome risorsa completo del secret archiviato in Secret Manager, che contiene la chiave API Jira con accesso agli ID dei canali Slack. Vedi: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/ Formato: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}`

`SharePointSources`
`share_point_sources.sharepoint_folder_path`	`oneof` in `folder_source`: `string` Il percorso della cartella di SharePoint da cui scaricare i file.
`share_point_sources.sharepoint_folder_id`	`oneof` in `folder_source`: `string` L'ID della cartella di SharePoint da cui scaricare.
`share_point_sources.drive_name`	`oneof` in `drive_source`: `string` Il nome dell'unità da cui scaricare.
`share_point_sources.drive_id`	`oneof` in `drive_source`: `string` L'ID dell'unità da cui scaricare.
`share_point_sources.client_id`	`string` L'ID applicazione per l'app registrata nel portale Microsoft Azure. L'applicazione deve essere configurata anche con le autorizzazioni MS Graph "Files.ReadAll", "Sites.ReadAll" e BrowserSiteLists.Read.All.
`share_point_sources.client_secret.api_key_secret_version`	Obbligatorio: `string` Il nome completo della risorsa del secret archiviato in Secret Manager, che contiene il secret dell'applicazione per l'app registrata in Azure. Formato: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}`
`share_point_sources.tenant_id`	`string` Identificatore univoco dell'istanza di Azure Active Directory.
`share_point_sources.sharepoint_site_name`	`string` Il nome del sito SharePoint da cui scaricare. Può trattarsi del nome del sito o dell'ID del sito.

`RagFileParsingConfig`
`layout_parser`	`oneof` `parser`: `RagFileParsingConfig.LayoutParser` Il parser del layout da utilizzare per `RagFile`.
`layout_parser.processor_name`	`string` Il nome completo della risorsa di un processore o di una versione del processore di Document AI. Formato: `projects/{project_id}/locations/{location}/processors/{processor_id}` `projects/{project_id}/locations/{location}/processors/{processor_id}/processorVersions/{processor_version_id}`
`layout_parser.max_parsing_requests_per_min`	`string` Il numero massimo di richieste che il job può effettuare al processore Document AI al minuto. Consulta la pagina https://cloud.google.com/document-ai/quotas e la pagina Quote per il tuo progetto per impostare un valore appropriato. Se non specificato, viene utilizzato un valore predefinito di 120 QPM.
`llm_parser`	`oneof` `parser`: `RagFileParsingConfig.LlmParser` Il parser LLM da utilizzare per `RagFile`.
`llm_parser.model_name`	`string` Il nome della risorsa di un modello LLM. Formato: `{publisher}/models/{model}`
`llm_parser.max_parsing_requests_per_min`	`string` Il numero massimo di richieste che il job può effettuare al modello LLM al minuto. Per impostare un valore appropriato per il tuo progetto, consulta la sezione relativa alle quote del modello e la pagina Quote per il tuo progetto per impostare un valore appropriato. Se non specificato, viene utilizzato un valore predefinito di 5000 QPM.

Recuperare un file RAG

Questa tabella elenca i parametri utilizzati per ottenere un file RAG.

Parametri

Parametri
`name`	`string` Il nome della risorsa `RagFile`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_file_id}`

name

string

Il nome della risorsa RagFile. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_file_id}

Eliminare un file RAG

Questa tabella elenca i parametri utilizzati per eliminare un file RAG.

Parametri

Parametri
`name`	`string` Il nome della risorsa `RagFile`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_file_id}`

name

string

Il nome della risorsa RagFile. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_file_id}

Creazione batch di metadati

Questa tabella elenca i parametri utilizzati per creare in batch i metadati per un file RAG.

Body Request

Parametri

Parametri
`requests`	Obbligatorio: elenco di `CreateRagMetadataRequest` I messaggi di richiesta per `CreateRagMetadata`.

requests

Obbligatorio: elenco di CreateRagMetadataRequest

I messaggi di richiesta per CreateRagMetadata.

`CreateRagMetadataRequest`

Parametri

Parametri
`rag_metadata`	Obbligatorio: `RagMetadata` I metadati da creare.
`rag_metadata_id`	Facoltativo: `string` L'ID da utilizzare per i metadati, che diventerà il componente finale del nome della risorsa dei metadati.

rag_metadata

Obbligatorio: RagMetadata

I metadati da creare.

rag_metadata_id

Facoltativo: string

L'ID da utilizzare per i metadati, che diventerà il componente finale del nome della risorsa dei metadati.

`RagMetadata`

Parametri

Parametri
`user_specified_metadata`	`UserSpecifiedMetadata` I metadati forniti dagli utenti.

user_specified_metadata

UserSpecifiedMetadata

I metadati forniti dagli utenti.

`UserSpecifiedMetadata`

Parametri

Parametri
`key`	Obbligatorio: `string` La chiave dei metadati. La chiave deve corrispondere a una chiave definita in un `RagDataSchema`.
`value`	`MetadataValue` Il valore dei metadati.

key

Obbligatorio: string

La chiave dei metadati. La chiave deve corrispondere a una chiave definita in un RagDataSchema.

value

MetadataValue

Il valore dei metadati.

`MetadataValue`

Parametri
`int_value`	`oneof value`: `int64`
`float_value`	`oneof value`: `float`
`str_value`	`oneof value`: `string`
`datetime_value`	`oneof value`: `string`
`bool_value`	`oneof value`: `boolean`
`list_value`	`oneof value`: `MetadataList`

Metadati elenco

Questa tabella elenca i parametri utilizzati per elencare i metadati di un file RAG.

Parametri

Parametri
`parent`	Obbligatorio: `string` Il nome della risorsa di `RagFile`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}/ragFiles/{rag_file_id}`

parent

Obbligatorio: string

Il nome della risorsa di RagFile. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}/ragFiles/{rag_file_id}

Aggiorna metadati

Questa tabella elenca i parametri utilizzati per aggiornare i metadati.

Parametri

Parametri
`rag_metadata`	Obbligatorio: `RagMetadata` Il `RagMetadata` che sostituisce la risorsa sul server.

rag_metadata

Obbligatorio: RagMetadata

Il RagMetadata che sostituisce la risorsa sul server.

Eliminare i metadati in batch

Questa tabella elenca i parametri utilizzati per eliminare in batch i metadati.

Parametri

Parametri
`names`	Obbligatorio: elenco di `string` I nomi delle risorse `RagMetadata` da eliminare. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}/ragFiles/{rag_file_id}/ragMetadata/{rag_metadata_id}`

names

Obbligatorio: elenco di string

I nomi delle risorse RagMetadata da eliminare. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}/ragFiles/{rag_file_id}/ragMetadata/{rag_metadata_id}

Parametri di recupero e previsione

Questa sezione elenca i parametri di recupero e previsione.

Parametri di recupero

Questa tabella elenca i parametri per l'API retrieveContexts.

Parametri

Parametri
`parent`	Obbligatorio: `string` Il nome della risorsa della località da cui eseguire il recupero. Gli utenti devono disporre dell'autorizzazione per effettuare una chiamata nel progetto. Formato: `projects/{project}/locations/{location}`
`vertex_rag_store`	`VertexRagStore` L'origine dati per Vertex RagStore.
`query`	Obbligatorio: `RagQuery` Singola query di recupero RAG.

parent

Obbligatorio: string

Il nome della risorsa della località da cui eseguire il recupero.
Gli utenti devono disporre dell'autorizzazione per effettuare una chiamata nel progetto.

Formato: projects/{project}/locations/{location}

vertex_rag_store

VertexRagStore

L'origine dati per Vertex RagStore.

query

Obbligatorio: RagQuery

Singola query di recupero RAG.

`VertexRagStore`

VertexRagStore

`VertexRagStore`
`rag_resources`	elenco: `RagResource` La rappresentazione dell'origine RAG. Può essere utilizzato per specificare solo il corpus o `RagFile`. Supporta solo uno o più file di un corpus.
`rag_resources.rag_corpus`	Facoltativo: `string` Nome della risorsa `RagCorpora`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
`rag_resources.rag_file_ids`	elenco: `string` Un elenco di risorse `RagFile`. Formato: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`

rag_resources

elenco: RagResource

La rappresentazione dell'origine RAG. Può essere utilizzato per specificare solo il corpus o RagFile. Supporta solo uno o più file di un corpus.

rag_resources.rag_corpus

Facoltativo: string

Nome della risorsa RagCorpora.

Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

rag_resources.rag_file_ids

elenco: string

Un elenco di risorse RagFile.

Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}

`RagQuery`
`text`	`string` La query in formato di testo per ottenere i contesti pertinenti.
`rag_retrieval_config`	Facoltativo: `RagRetrievalConfig` La configurazione del recupero per la query.

RagQuery

text

string

La query in formato di testo per ottenere i contesti pertinenti.

rag_retrieval_config

Facoltativo: RagRetrievalConfig

La configurazione del recupero per la query.

`RagRetrievalConfig`
`top_k`	Facoltativo: `int32` Il numero di contesti da recuperare.
`hybrid_search.alpha`	Facoltativo: `float` Il valore alpha controlla la ponderazione tra i risultati della ricerca vettoriale densa e sparsa. L'intervallo è [0, 1], dove 0 indica solo la ricerca vettoriale sparsa e 1 indica solo la ricerca vettoriale densa. Il valore predefinito è 0,5, che bilancia in modo uniforme la ricerca vettoriale sparsa e densa. La ricerca ibrida è disponibile solo per Weaviate.
`filter.vector_distance_threshold`	`oneof vector_db_threshold`: `double` Restituisce solo i contesti con una distanza del vettore inferiore alla soglia.
`filter.metadata_filter`	Facoltativo: `string` Il filtro dei metadati da applicare durante il recupero, utilizzando Common Expression Language (CEL). Per ulteriori informazioni, vedi [Ricerca di metadati](/vertex-ai/generative-ai/docs/rag-engine/use-metadata-search). Esempio: `author == "Shakespeare" && page_number == 42`
`filter.vector_similarity_threshold`	`oneof vector_db_threshold`: `double` Restituisce solo i contesti con una somiglianza del vettore superiore alla soglia.
`ranking.rank_service.model_name`	Facoltativo: `string` Il nome del modello del servizio di classificazione. Esempio: `semantic-ranker-512@latest`
`ranking.llm_ranker.model_name`	Facoltativo: `string` Il nome del modello utilizzato per il ranking. Esempio: `gemini-2.5-flash`

Parametri di recupero asincrono

Questa tabella elenca i parametri per l'API asyncRetrieveContexts.

Parametri

Parametri
`parent`	Obbligatorio: `string` Il nome della risorsa della località da recuperare `RagContexts`. Gli utenti devono disporre dell'autorizzazione per effettuare una chiamata nel progetto. Formato: `projects/{project}/locations/{location}`
`query`	Obbligatorio: `RagQuery` Singola query di recupero RAG.
`tools`	(Facoltativo) Elenco di `Tool` Gli strumenti da utilizzare per il recupero. Gli strumenti supportati includono `retrieval`, che specifica `vertex_rag_store`.

parent

Obbligatorio: string

Il nome della risorsa della località da recuperare RagContexts.
Gli utenti devono disporre dell'autorizzazione per effettuare una chiamata nel progetto.

Formato: projects/{project}/locations/{location}

query

Obbligatorio: RagQuery

Singola query di recupero RAG.

tools

(Facoltativo) Elenco di Tool

Gli strumenti da utilizzare per il recupero. Gli strumenti supportati includono retrieval, che specifica vertex_rag_store.

Parametri dei contesti di domanda

Questa tabella elenca i parametri per l'API askContexts.

Parametri

Parametri
`parent`	Obbligatorio: `string` Il nome della risorsa della località da recuperare `RagContexts`. Gli utenti devono disporre dell'autorizzazione per effettuare una chiamata nel progetto. Formato: `projects/{project}/locations/{location}`
`query`	Obbligatorio: `RagQuery` Singola query di recupero RAG.
`tools`	(Facoltativo) Elenco di `Tool` Gli strumenti da utilizzare per il recupero. Gli strumenti supportati includono `retrieval`, che specifica `vertex_rag_store`.

parent

Obbligatorio: string

Il nome della risorsa della località da recuperare RagContexts.
Gli utenti devono disporre dell'autorizzazione per effettuare una chiamata nel progetto.

Formato: projects/{project}/locations/{location}

query

Obbligatorio: RagQuery

Singola query di recupero RAG.

tools

(Facoltativo) Elenco di Tool

Gli strumenti da utilizzare per il recupero. Gli strumenti supportati includono retrieval, che specifica vertex_rag_store.

Parametri di previsione

Questa tabella elenca i parametri di previsione.

GenerateContentRequest

`GenerateContentRequest`
`tools.retrieval.vertex_rag_store`	`VertexRagStore` Impostato per utilizzare un'origine dati basata sull'archivio RAG di Vertex AI.

tools.retrieval.vertex_rag_store

VertexRagStore

Impostato per utilizzare un'origine dati basata sull'archivio RAG di Vertex AI.

Per maggiori dettagli, consulta VertexRagStore.

Parametri di gestione dei progetti

Questa tabella elenca i parametri a livello di progetto.

`RagEngineConfig`

Parametri
`RagManagedDbConfig.serverless`	Imposta/cambia la modalità di deployment in Serverless, fornendo un database completamente gestito e altamente scalabile per supportare le risorse RAG Engine.
`RagManagedDbConfig.spanner`	Imposta/attiva la modalità di deployment su Spanner, supportata da un'istanza Spanner pronta per la produzione.
`RagManagedDbConfig.spanner.scaled`	Questo livello offre prestazioni su scala di produzione insieme alla funzionalità di scalabilità automatica in modalità Spanner.
`RagManagedDbConfig.spanner.basic`	Questo livello offre un livello di computing basso ed economico in modalità Spanner.
`RagManagedDbConfig.spanner.unprovisioned`	Questo livello elimina `RagManagedDb` e la relativa istanza Spanner.

Esempi di gestione del corpus

Questa sezione fornisce esempi di come utilizzare l'API per gestire il corpus RAG.

Crea un esempio di corpus RAG

Questo esempio di codice mostra come creare un corpus RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
CORPUS_DISPLAY_NAME: il nome visualizzato di RagCorpus.
CORPUS_DESCRIPTION: la descrizione di RagCorpus.

Metodo HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora

Corpo JSON della richiesta:

{
  "display_name" : "CORPUS_DISPLAY_NAME",
  "description": "CORPUS_DESCRIPTION",
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Nota: il seguente comando presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login oppure utilizzando Cloud Shell, che consente di accedere automaticamente all'interfaccia a riga di comando gcloud. Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora"

PowerShell

Nota: il comando seguente presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login. Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx).

L'esempio seguente mostra come creare un corpus RAG utilizzando l'API REST.

  PROJECT_ID: Your project ID.
  LOCATION: The region to process the request.
  CORPUS_DISPLAY_NAME: The display name of the <code>RagCorpus</code>.

    // CreateRagCorpus
    // Input: LOCATION, PROJECT_ID, CORPUS_DISPLAY_NAME
    // Output: CreateRagCorpusOperationMetadata
    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora \
    -d '{
          "display_name" : "CORPUS_DISPLAY_NAME"
      }'

Aggiorna un esempio di corpus RAG

Puoi aggiornare il corpus RAG con un nuovo nome visualizzato, una nuova descrizione e una nuova configurazione del database vettoriale. Tuttavia, non puoi modificare i seguenti parametri nel corpus RAG:

Il tipo di database vettoriale. Ad esempio, non puoi modificare il database vettoriale da Weaviate a Vertex AI Feature Store.
Se utilizzi l'opzione del database gestito, non puoi aggiornare la configurazione del database vettoriale.

Questi esempi mostrano come aggiornare un corpus RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
CORPUS_ID: l'ID corpus del tuo corpus RAG.
CORPUS_DISPLAY_NAME: il nome visualizzato di RagCorpus.
CORPUS_DESCRIPTION: la descrizione di RagCorpus.
INDEX_NAME: il nome della risorsa di Vector Search Index. Formato: projects/{project}/locations/{location}/indexes/{index}
INDEX_ENDPOINT_NAME: il nome della risorsa di Vector Search Index Endpoint. Formato: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Metodo HTTP e URL:

PATCH https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/CORPUS_ID

Corpo JSON della richiesta:

{
  "display_name" : "CORPUS_DISPLAY_NAME",
  "description": "CORPUS_DESCRIPTION",
  "rag_vector_db_config": {
     "vertex_vector_search": {
         "index": "INDEX_NAME",
         "index_endpoint": "INDEX_ENDPOINT_NAME",
     }
  }
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/CORPUS_ID"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/CORPUS_ID" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx).

Esempio di elenco di corpora RAG

Questo esempio di codice mostra come elencare tutti i corpus RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
PAGE_SIZE: la dimensione standard della pagina dell'elenco. Puoi modificare il numero di RagCorpora da restituire per pagina aggiornando il parametro page_size.
PAGE_TOKEN: il token della pagina dell'elenco standard. Ottenuto in genere utilizzando ListRagCorporaResponse.next_page_token della chiamata precedente VertexRagDataService.ListRagCorpora.

Metodo HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora?page_size=PAGE_SIZE&page_token=PAGE_TOKEN

Per inviare la richiesta, scegli una di queste opzioni:

curl

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora?page_size=PAGE_SIZE&page_token=PAGE_TOKEN"

PowerShell

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora?page_size=PAGE_SIZE&page_token=PAGE_TOKEN" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito ("2xx") e un elenco di RagCorpora nell'ambito del PROJECT_ID specificato.

Ottieni un esempio di corpus RAG

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.

Metodo HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID

Per inviare la richiesta, scegli una di queste opzioni:

curl

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID"

PowerShell

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID" | Select-Object -Expand Content

Una risposta positiva restituisce la risorsa RagCorpus.

I comandi get e list vengono utilizzati in un esempio per dimostrare come RagCorpus utilizza il campo rag_embedding_model_config in vector_db_config, che punta al modello di incorporamento che hai scelto.

  PROJECT_ID: Your project ID.
  LOCATION: The region to process the request.
  RAG_CORPUS_ID: The corpus ID of your RAG corpus.

// GetRagCorpus
// Input: LOCATION, PROJECT_ID, RAG_CORPUS_ID
// Output: RagCorpus
curl -X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID

// ListRagCorpora
curl -sS -X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/

Elimina un esempio di corpus RAG

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.

Metodo HTTP e URL:

DELETE https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID

Per inviare la richiesta, scegli una di queste opzioni:

curl

Esegui questo comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID"

PowerShell

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID" | Select-Object -Expand Content

Una risposta positiva restituisce DeleteOperationMetadata.

Esempio di creazione batch di schemi di metadati

Questo esempio di codice mostra come creare in batch schemi di metadati per un corpus RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
SCHEMA_KEY_1: La chiave del primo schema dei metadati.
SCHEMA_TYPE_1: Il tipo di dati per il primo schema dei metadati (ad es. INTEGER).
SCHEMA_KEY_2: La chiave per il secondo schema dei metadati.
SCHEMA_TYPE_2: Il tipo di dati per il secondo schema dei metadati (ad es. STRING).

Metodo HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas:batchCreate

Corpo JSON della richiesta:

{
  "requests": [
    {
      "rag_data_schema": {
        "key": "SCHEMA_KEY_1",
        "schema_details": {"type": "SCHEMA_TYPE_1"}
      }
    },
    {
      "rag_data_schema": {
        "key": "SCHEMA_KEY_2",
        "schema_details": {"type": "SCHEMA_TYPE_2"}
      }
    }
  ]
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas:batchCreate"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas:batchCreate" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx).

Esempio di elenco di schemi di metadati

Questo esempio di codice mostra come elencare gli schemi di metadati per un corpus RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.

Metodo HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas

Per inviare la richiesta, scegli una di queste opzioni:

curl

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas"

PowerShell

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas" | Select-Object -Expand Content

Una risposta positiva restituisce un elenco di risorse RagDataSchema.

Esempio di eliminazione batch degli schemi di metadati

Questo esempio di codice mostra come eliminare in batch gli schemi di metadati.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
SCHEMA_ID_1: l'ID del primo schema dei metadati da eliminare.
SCHEMA_ID_2: l'ID del secondo schema dei metadati da eliminare.

Metodo HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas:batchDelete

Corpo JSON della richiesta:

{
  "names": [
    "projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas/SCHEMA_ID_1",
    "projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas/SCHEMA_ID_2"
  ]
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas:batchDelete"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragDataSchemas:batchDelete" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx).

Esempi di gestione dei file

Questa sezione fornisce esempi di come utilizzare l'API per gestire i file RAG.

Carica un esempio di file RAG

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

  PROJECT_ID: Your project ID.
  LOCATION: The region to process the request.
  RAG_CORPUS_ID: The corpus ID of your RAG corpus.
  LOCAL_FILE_PATH: The local path to the file to be uploaded.
  DISPLAY_NAME: The display name of the RAG file.
  DESCRIPTION: The description of the RAG file.

Per inviare la richiesta, utilizza il comando seguente:

  curl -X POST \
    -H "X-Goog-Upload-Protocol: multipart" \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -F metadata="{'rag_file': {'display_name':' DISPLAY_NAME', 'description':'DESCRIPTION'}}" \
    -F file=@LOCAL_FILE_PATH \
    "https://LOCATION-aiplatform.googleapis.com/upload/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:upload"

Esempio di importazione di file RAG

File e cartelle possono essere importati da Drive o Cloud Storage.

response.skipped_rag_files_count indica il numero di file ignorati durante l'importazione. Un file viene ignorato quando si verificano le seguenti condizioni:

Il file è già stato importato.
Il file non è cambiato.
La configurazione del chunking per il file non è cambiata.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
GCS_URIS: un elenco di posizioni Cloud Storage. Esempio: gs://my-bucket1, gs://my-bucket2.
CHUNK_SIZE: (facoltativo) il numero di token che ogni blocco deve avere.
CHUNK_OVERLAP: (Facoltativo) Numero di token sovrapposti tra i chunk.

Metodo HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:import

Corpo JSON della richiesta:

{
  "import_rag_files_config": {
    "gcs_source": {
      "uris": "GCS_URIS"
    },
    "rag_file_chunking_config": {
      "chunk_size": CHUNK_SIZE,
      "chunk_overlap": CHUNK_OVERLAP
    }
  }
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:import"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:import" | Select-Object -Expand Content

Una risposta positiva restituisce la risorsa ImportRagFilesOperationMetadata.

Il seguente esempio mostra come importare un file da Cloud Storage. Utilizza il campo di controllo max_embedding_requests_per_min per limitare la velocità con cui RAG Engine chiama il modello di incorporamento durante la procedura di indicizzazione ImportRagFiles. Il campo ha un valore predefinito di 1000 chiamate al minuto.

  PROJECT_ID: Your project ID.
  LOCATION: The region to process the request.
  RAG_CORPUS_ID: The corpus ID of your RAG corpus.
  GCS_URIS: A list of Cloud Storage locations. Example: gs://my-bucket1.
  CHUNK_SIZE: Number of tokens each chunk should have.
  CHUNK_OVERLAP: Number of tokens overlap between chunks.
  EMBEDDING_MODEL_QPM_RATE: The QPM rate to limit RAGs access to your embedding model. Example: 1000.

// ImportRagFiles
// Import a single Cloud Storage file or all files in a Cloud Storage bucket.
// Input: LOCATION, PROJECT_ID, RAG_CORPUS_ID, GCS_URIS
// Output: ImportRagFilesOperationMetadataNumber
// Use ListRagFiles to find the server-generated rag_file_id.
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:import \
-d '{
  "import_rag_files_config": {
    "gcs_source": {
      "uris": "GCS_URIS"
    },
    "rag_file_chunking_config": {
      "chunk_size": CHUNK_SIZE,
      "chunk_overlap": CHUNK_OVERLAP
    },
    "max_embedding_requests_per_min": EMBEDDING_MODEL_QPM_RATE
  }
}'

// Poll the operation status.
// The response contains the number of files imported.
OPERATION_ID: The operation ID you get from the response of the previous command.
poll_op_wait OPERATION_ID

L'esempio riportato di seguito mostra come importare un file da Drive. Utilizza il campo di controllo max_embedding_requests_per_min per limitare la velocità con cui RAG Engine chiama il modello di incorporamento durante il processo di indicizzazione ImportRagFiles. Il campo ha un valore predefinito di 1000 chiamate al minuto.

  PROJECT_ID: Your project ID.
  LOCATION: The region to process the request.
  RAG_CORPUS_ID: The corpus ID of your RAG corpus.
  FOLDER_RESOURCE_ID: The resource ID of your Google Drive folder.
  CHUNK_SIZE: Number of tokens each chunk should have.
  CHUNK_OVERLAP: Number of tokens overlap between chunks.
  EMBEDDING_MODEL_QPM_RATE: The QPM rate to limit RAGs access to your embedding model. Example: 1000.

// ImportRagFiles
// Import all files in a Google Drive folder.
// Input: LOCATION, PROJECT_ID, RAG_CORPUS_ID, FOLDER_RESOURCE_ID
// Output: ImportRagFilesOperationMetadataNumber
// Use ListRagFiles to find the server-generated rag_file_id.
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:import \
-d '{
  "import_rag_files_config": {
    "google_drive_source": {
      "resource_ids": {
        "resource_id": "FOLDER_RESOURCE_ID",
        "resource_type": "RESOURCE_TYPE_FOLDER"
      }
    },
    "max_embedding_requests_per_min": EMBEDDING_MODEL_QPM_RATE
  }
}'

// Poll the operation status.
// The response contains the number of files imported.
OPERATION_ID: The operation ID you get from the response of the previous command.
poll_op_wait OPERATION_ID

Esempio di elenco di file RAG

Questo esempio di codice mostra come elencare i file RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
PAGE_SIZE: la dimensione standard della pagina dell'elenco. Puoi modificare il numero di RagFiles da restituire per pagina aggiornando il parametro page_size.
PAGE_TOKEN: il token della pagina dell'elenco standard. Ottenuto in genere utilizzando ListRagFilesResponse.next_page_token della chiamata precedente VertexRagDataService.ListRagFiles.

Metodo HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles?page_size=PAGE_SIZE&page_token=PAGE_TOKEN

Per inviare la richiesta, scegli una di queste opzioni:

curl

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles?page_size=PAGE_SIZE&page_token=PAGE_TOKEN"

PowerShell

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles?page_size=PAGE_SIZE&page_token=PAGE_TOKEN" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx) insieme a un elenco di RagFiles nel RAG_CORPUS_ID specificato.

Visualizzare un esempio di file RAG

Questo esempio di codice mostra come ottenere un file RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
RAG_FILE_ID: l'ID della risorsa RagFile.

Metodo HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID

Per inviare la richiesta, scegli una di queste opzioni:

curl

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID"

PowerShell

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID" | Select-Object -Expand Content

Una risposta positiva restituisce la risorsa RagFile.

Elimina un esempio di file RAG

Questo esempio di codice mostra come eliminare un file RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
RAG_FILE_ID: l'ID della risorsa RagFile. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file_id}.

Metodo HTTP e URL:

DELETE https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID

Per inviare la richiesta, scegli una di queste opzioni:

curl

Esegui questo comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID"

PowerShell

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID" | Select-Object -Expand Content

Una risposta positiva restituisce la risorsa DeleteOperationMetadata.

Esempio di creazione batch di metadati

Questo esempio di codice mostra come creare in batch i metadati per un file RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
RAG_FILE_ID: l'ID della risorsa RagFile.
METADATA_KEY_1: La chiave della prima voce dei metadati.
VALUE_TYPE_1: Il campo del tipo di valore per la prima voce dei metadati (ad es. int_value).
METADATA_VALUE_1: il valore della prima voce dei metadati.
METADATA_KEY_2: La chiave della seconda voce di metadati.
VALUE_TYPE_2: Il campo del tipo di valore per la seconda voce dei metadati (ad es. str_value).
METADATA_VALUE_2: il valore della seconda voce dei metadati.

Metodo HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata:batchCreate

Corpo JSON della richiesta:

{
  "requests": [
    {
      "rag_metadata": {
        "user_specified_metadata": {
          "key": "METADATA_KEY_1",
          "value": { "VALUE_TYPE_1": METADATA_VALUE_1 }
        }
      }
    },
    {
      "rag_metadata": {
        "user_specified_metadata": {
          "key": "METADATA_KEY_2",
          "value": { "VALUE_TYPE_2": "METADATA_VALUE_2" }
        }
      }
    }
  ]
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata:batchCreate"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata:batchCreate" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx).

Esempio di metadati dell'elenco

Questo esempio di codice mostra come elencare i metadati di un file RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
RAG_FILE_ID: l'ID della risorsa RagFile.

Metodo HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata

Per inviare la richiesta, scegli una di queste opzioni:

curl

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata"

PowerShell

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata" | Select-Object -Expand Content

Una risposta positiva restituisce un elenco di risorse RagMetadata.

Esempio di aggiornamento dei metadati

Questo esempio di codice mostra come aggiornare i metadati di un file RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
RAG_FILE_ID: l'ID della risorsa RagFile.
METADATA_ID: l'ID della voce di metadati da aggiornare.
METADATA_KEY: La chiave della voce di metadati.
VALUE_TYPE: il campo del tipo di valore (ad es. int_value).
METADATA_VALUE: il nuovo valore per la voce di metadati.

Metodo HTTP e URL:

PATCH https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata/METADATA_ID

Corpo JSON della richiesta:

{
  "user_specified_metadata": {
    "key": "METADATA_KEY",
    "value": { "VALUE_TYPE": METADATA_VALUE }
  }
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata/METADATA_ID"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata/METADATA_ID" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx).

Esempio di eliminazione batch dei metadati

Questo esempio di codice mostra come eliminare in batch le voci di metadati per un file RAG.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
RAG_CORPUS_ID: l'ID della risorsa RagCorpus.
RAG_FILE_ID: l'ID della risorsa RagFile.
METADATA_ID_1: l'ID della prima voce di metadati da eliminare.
METADATA_ID_2: l'ID della seconda voce di metadati da eliminare.

Metodo HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata:batchDelete

Corpo JSON della richiesta:

{
  "names": [
    "projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata/METADATA_ID_1",
    "projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata/METADATA_ID_2"
  ]
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata:batchDelete"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles/RAG_FILE_ID/ragMetadata:batchDelete" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx).

Esempio di query di recupero

Quando un utente pone una domanda o fornisce un prompt, il componente di recupero in RAG esegue una ricerca nella knowledge base per trovare informazioni pertinenti alla query.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

LOCATION: la regione in cui elaborare la richiesta.
PROJECT_ID: il tuo ID progetto
RAG_CORPUS_RESOURCE: il nome della risorsa RagCorpus. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.
TOP_K: il numero di contesti principali da recuperare.
VECTOR_DISTANCE_THRESHOLD: vengono restituiti solo i contesti con una distanza del vettore inferiore alla soglia.
METADATA_FILTER: (facoltativo) il filtro dei metadati da applicare durante il recupero.
TEXT: il testo della query per ottenere contesti pertinenti.

Metodo HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION:retrieveContexts

Corpo JSON della richiesta:

{
  "vertex_rag_store": {
    "rag_resources": [
      {
        "rag_corpus": "RAG_CORPUS_RESOURCE"
      }
    ]
  },
  "query": {
    "text": "TEXT",
    "rag_retrieval_config": {
      "top_k": TOP_K,
      "filter": {
        "vector_distance_threshold": VECTOR_DISTANCE_THRESHOLD,
        "metadata_filter": "METADATA_FILTER"
      }
    }
  }
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION:retrieveContexts"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION:retrieveContexts" | Select-Object -Expand Content

Dovresti ricevere un codice di stato riuscito (2xx) e un elenco di RagFiles correlati.

Esempio di generazione

L'LLM genera una risposta fondata utilizzando i contesti recuperati.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

PROJECT_ID: il tuo ID progetto
LOCATION: la regione in cui elaborare la richiesta.
MODEL_ID: modello LLM per la generazione di contenuti. Esempio: gemini-2.5-flash
GENERATION_METHOD: Metodo LLM per la generazione di contenuti. Opzioni: generateContent, streamGenerateContent
INPUT_PROMPT: il testo inviato al LLM per la generazione di contenuti. Prova a utilizzare un prompt pertinente ai file RAG caricati.
RAG_CORPUS_RESOURCE: il nome della risorsa RagCorpus. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.
TOP_K: (facoltativo) il numero di contesti principali da recuperare.
VECTOR_DISTANCE_THRESHOLD: (facoltativo) Vengono restituiti i contesti con una distanza del vettore inferiore alla soglia.
METADATA_FILTER: (facoltativo) il filtro dei metadati da applicare durante il recupero.

Metodo HTTP e URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/publishers/google/models/MODEL_ID:GENERATION_METHOD

Corpo JSON della richiesta:

{
  "contents": {
    "role": "user",
    "parts": {
      "text": "INPUT_PROMPT"
    }
  },
  "tools": {
    "retrieval": {
      "disable_attribution": false,
      "vertex_rag_store": {
        "rag_resources": [
          {
            "rag_corpus": "RAG_CORPUS_RESOURCE"
          }
        ],
        "rag_retrieval_config": {
          "top_k": TOP_K,
          "filter": {
            "vector_distance_threshold": VECTOR_DISTANCE_THRESHOLD,
            "metadata_filter": "METADATA_FILTER"
          }
        }
      }
    }
  }
}

Per inviare la richiesta, scegli una di queste opzioni:

curl

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/publishers/google/models/MODEL_ID:GENERATION_METHOD"

PowerShell

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/publishers/google/models/MODEL_ID:GENERATION_METHOD" | Select-Object -Expand Content

Una risposta positiva restituisce i contenuti generati con le citazioni.

Esempi di gestione dei progetti

La modalità di deployment e il livello sono un'impostazione a livello di progetto disponibile nella risorsa RagEngineConfig e influiscono sui corpus RAG che utilizzano RagManagedDb. Per ottenere la configurazione attuale, utilizza GetRagEngineConfig. Per aggiornare la configurazione, utilizza UpdateRagEngineConfig.

Per saperne di più sulla gestione della configurazione della modalità e del livello, consulta Modalità di deployment in RAG Engine.

Leggi il tuo attuale RagEngineConfig

I seguenti esempi di codice mostrano come leggere il tuo RagEngineConfig per vedere la modalità e il livello attualmente scelti:

Console

Nella console Google Cloud , vai alla pagina Motore RAG.
Vai a RAG Engine
Seleziona la regione in cui è in esecuzione RAG Engine. L'elenco dei corpora RAG è aggiornato.
Fai clic su Configura RAG Engine. Viene visualizzato il riquadro Configura RAG Engine. Puoi vedere il livello selezionato per il motore RAG.
Fai clic su Annulla.

REST

PROJECT_ID: Your project ID.
LOCATION: The region to process the request.

curl -X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragEngineConfig

Python

from vertexai.preview import rag
import vertexai

PROJECT_ID = YOUR_PROJECT_ID
LOCATION = YOUR_RAG_ENGINE_LOCATION

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location=LOCATION)

rag_engine_config = rag.rag_data.get_rag_engine_config(
    name=f"projects/{PROJECT_ID}/locations/{LOCATION}/ragEngineConfig"
)

print(rag_engine_config)

Passare alla modalità serverless

I seguenti esempi di codice mostrano come passare alla modalità serverless per RagEngineConfig:

Console

Nella console Google Cloud , vai alla pagina Motore RAG.
Vai a RAG Engine
Seleziona la regione in cui è in esecuzione Vertex AI RAG Engine.
Fai clic sul pulsante Passa a serverless. Questo pulsante potrebbe non essere visibile se è già attiva la modalità serverless. Puoi verificare la modalità attuale dall'etichetta della modalità nella sezione in alto a destra della pagina.

REST

PROJECT_ID: Your project ID.
LOCATION: The region to process the request.

curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragEngineConfig -d "{'ragManagedDbConfig': {'serverless': {}}}"

Python

from vertexai.preview import rag
import vertexai

PROJECT_ID = YOUR_PROJECT_ID
LOCATION = YOUR_RAG_ENGINE_LOCATION

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location=LOCATION)

rag_engine_config_name=f"projects/{PROJECT_ID}/locations/{LOCATION}/ragEngineConfig"

new_rag_engine_config = rag.RagEngineConfig(
    name=rag_engine_config_name,
    rag_managed_db_config=rag.RagManagedDbConfig(mode=rag.Serverless()),
)

updated_rag_engine_config = rag.rag_data.update_rag_engine_config(
    rag_engine_config=new_rag_engine_config
)

print(updated_rag_engine_config)

Passare alla modalità Spanner

I seguenti esempi di codice mostrano come passare dalla modalità RagEngineConfig alla modalità Spanner. Se in precedenza hai utilizzato la modalità Spanner e hai scelto un livello, non è più necessario specificarlo in modo esplicito durante il passaggio. In caso contrario, consulta gli esempi di codice riportati di seguito per scoprire come passare alla modalità Spanner fornendo un livello.

Console

Nella console Google Cloud , vai alla pagina Motore RAG.
Vai a RAG Engine
Seleziona la regione in cui è in esecuzione Vertex AI RAG Engine.
Fai clic sul pulsante Passa a Spanner. Questo pulsante potrebbe non essere visibile se sei già in modalità Spanner. Puoi verificare la modalità attuale dall'etichetta della modalità nella sezione in alto a destra della pagina.

REST

PROJECT_ID: Your project ID.
LOCATION: The region to process the request.

curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragEngineConfig -d "{'ragManagedDbConfig': {'spanner': {}}}"

Python

from vertexai.preview import rag
import vertexai

PROJECT_ID = YOUR_PROJECT_ID
LOCATION = YOUR_RAG_ENGINE_LOCATION

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location=LOCATION)

rag_engine_config_name=f"projects/{PROJECT_ID}/locations/{LOCATION}/ragEngineConfig"

new_rag_engine_config = rag.RagEngineConfig(
    name=rag_engine_config_name,
    rag_managed_db_config=rag.RagManagedDbConfig(mode=rag.Spanner()),
)

updated_rag_engine_config = rag.rag_data.update_rag_engine_config(
    rag_engine_config=new_rag_engine_config
)

print(updated_rag_engine_config)

Aggiorna il tuo `RagEngineConfig` al livello con scalabilità della modalità Spanner

I seguenti esempi di codice mostrano come impostare RagEngineConfig sulla modalità Spanner con il livello di scalabilità:

Console

Nella console Google Cloud , vai alla pagina Motore RAG.
Vai a RAG Engine
Seleziona la regione in cui è in esecuzione Vertex AI RAG Engine.
Fai clic sul pulsante Passa a Spanner se non sei già in modalità Spanner.
Fai clic su Configura RAG Engine. Viene visualizzato il riquadro Configura RAG Engine.
Seleziona il livello su cui vuoi eseguire RAG Engine.
Fai clic su Salva.

REST

PROJECT_ID: Your project ID.
LOCATION: The region to process the request.

curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragEngineConfig -d "{'ragManagedDbConfig': {'spanner': {'scaled': {}}}}"

Python

from vertexai.preview import rag
import vertexai

PROJECT_ID = YOUR_PROJECT_ID
LOCATION = YOUR_RAG_ENGINE_LOCATION

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location=LOCATION)

rag_engine_config_name=f"projects/{PROJECT_ID}/locations/{LOCATION}/ragEngineConfig"

new_rag_engine_config = rag.RagEngineConfig(
    name=rag_engine_config_name,
    rag_managed_db_config=rag.RagManagedDbConfig(mode=rag.Spanner(tier=rag.Scaled())),
)

updated_rag_engine_config = rag.rag_data.update_rag_engine_config(
    rag_engine_config=new_rag_engine_config
)

print(updated_rag_engine_config)

Aggiorna il tuo `RagEngineConfig` alla modalità Spanner con il livello Basic

I seguenti esempi di codice mostrano come impostare RagEngineConfig sulla modalità Spanner con il livello Basic:

Console

Nella console Google Cloud , vai alla pagina Motore RAG.
Vai a RAG Engine
Seleziona la regione in cui è in esecuzione Vertex AI RAG Engine.
Fai clic sul pulsante Passa a Spanner se non sei già in modalità Spanner.
Fai clic su Configura RAG Engine. Viene visualizzato il riquadro Configura RAG Engine.
Seleziona il livello su cui vuoi eseguire RAG Engine.
Fai clic su Salva.

REST

PROJECT_ID: Your project ID.
LOCATION: The region to process the request.

curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragEngineConfig -d "{'ragManagedDbConfig': {'spanner': {'basic': {}}}}"

Python

from vertexai.preview import rag
import vertexai

PROJECT_ID = YOUR_PROJECT_ID
LOCATION = YOUR_RAG_ENGINE_LOCATION

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location=LOCATION)

rag_engine_config_name=f"projects/{PROJECT_ID}/locations/{LOCATION}/ragEngineConfig"

new_rag_engine_config = rag.RagEngineConfig(
    name=rag_engine_config_name,
    rag_managed_db_config=rag.RagManagedDbConfig(mode=rag.Spanner(tier=rag.Basic())),
)

updated_rag_engine_config = rag.rag_data.update_rag_engine_config(
    rag_engine_config=new_rag_engine_config
)

print(updated_rag_engine_config)

Aggiornare il tuo `RagEngineConfig` al livello Unprovisioned

I seguenti esempi di codice mostrano come impostare RagEngineConfig sulla modalità Spanner con il livello Unprovisioned. Verranno eliminati definitivamente tutti i dati dalla modalità di deployment Spanner e verranno interrotte le spese di fatturazione derivanti.

Console

Nella console Google Cloud , vai alla pagina Motore RAG.
Vai a RAG Engine
Seleziona la regione in cui è in esecuzione Vertex AI RAG Engine.
Fai clic sul pulsante Passa a Spanner se non sei già in modalità Spanner.
Fai clic su Elimina RAG Engine. Viene visualizzata una finestra di dialogo di conferma.
Verifica di voler eliminare i dati in Vertex AI RAG Engine digitando delete, quindi fai clic su Conferma.
Fai clic su Salva.

REST

PROJECT_ID: Your project ID.
LOCATION: The region to process the request.

curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/ragEngineConfig -d "{'ragManagedDbConfig': {'spanner': {'unprovisioned': {}}}}"

Python

from vertexai.preview import rag
import vertexai

PROJECT_ID = YOUR_PROJECT_ID
LOCATION = YOUR_RAG_ENGINE_LOCATION

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location=LOCATION)

rag_engine_config_name=f"projects/{PROJECT_ID}/locations/{LOCATION}/ragEngineConfig"

new_rag_engine_config = rag.RagEngineConfig(
    name=rag_engine_config_name,
    rag_managed_db_config=rag.RagManagedDbConfig(mode=rag.Spanner(tier=rag.Unprovisioned())),
)

updated_rag_engine_config = rag.rag_data.update_rag_engine_config(
    rag_engine_config=new_rag_engine_config
)

print(updated_rag_engine_config)

Passaggi successivi

Per scoprire di più sui modelli di generazione supportati, consulta Modelli di AI generativa che supportano RAG.
Per scoprire di più sui modelli di embedding supportati, consulta Modelli di embedding.
Per scoprire di più sui modelli aperti, consulta Modelli aperti.
Per saperne di più su RAG Engine, consulta la panoramica di RAG Engine.

API RAG Engine Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Elenco dei parametri

Parametri di gestione del corpus

Crea un corpus RAG

Body Request

CorpusTypeConfig

RagVectorDbConfig

Aggiorna un corpus RAG

Body Request

Elenca i corpora RAG

Ottenere un corpus RAG

Elimina un corpus RAG

Creare schemi di metadati in batch

Body Request

CreateRagDataSchemaRequest

RagDataSchema

RagMetadataSchemaDetails

Elenca schemi di metadati

Elimina schemi di metadati in batch

Parametri di gestione dei file

Caricare un file RAG

Body Request

Importare file RAG

Recuperare un file RAG

Eliminare un file RAG

Creazione batch di metadati

Body Request

CreateRagMetadataRequest

RagMetadata

UserSpecifiedMetadata

MetadataValue

Metadati elenco

Aggiorna metadati

Eliminare i metadati in batch

Parametri di recupero e previsione

Parametri di recupero

VertexRagStore

Parametri di recupero asincrono

Parametri dei contesti di domanda

Parametri di previsione

Parametri di gestione dei progetti

RagEngineConfig

Esempi di gestione del corpus

Crea un esempio di corpus RAG

REST

curl

PowerShell

Aggiorna un esempio di corpus RAG

REST

curl

PowerShell

Esempio di elenco di corpora RAG

REST

curl

PowerShell

Ottieni un esempio di corpus RAG

REST

curl

PowerShell

Elimina un esempio di corpus RAG

REST

curl

PowerShell

Esempio di creazione batch di schemi di metadati

REST

curl

PowerShell

Esempio di elenco di schemi di metadati

REST

curl

PowerShell

Esempio di eliminazione batch degli schemi di metadati

REST

curl

PowerShell

Esempi di gestione dei file

Carica un esempio di file RAG

REST

Esempio di importazione di file RAG

REST

API RAG Engine

`CorpusTypeConfig`

`RagVectorDbConfig`

`CreateRagDataSchemaRequest`

`RagDataSchema`

`RagMetadataSchemaDetails`

`CreateRagMetadataRequest`

`RagMetadata`

`UserSpecifiedMetadata`

`MetadataValue`

`VertexRagStore`

`RagEngineConfig`

Aggiorna il tuo `RagEngineConfig` al livello con scalabilità della modalità Spanner

Aggiorna il tuo `RagEngineConfig` alla modalità Spanner con il livello Basic

Aggiornare il tuo `RagEngineConfig` al livello Unprovisioned