Mulai 29 April 2025, model Gemini 1.5 Pro dan Gemini 1.5 Flash tidak tersedia di project yang belum pernah menggunakan model ini, termasuk project baru. Untuk mengetahui detailnya, lihat Versi dan siklus proses model.

Halaman ini diterjemahkan oleh Cloud Translation API.

RAG Engine API

Mesin RAG Vertex AI adalah komponen platform Vertex AI, yang memfasilitasi Retrieval-Augmented Generation (RAG). Mesin RAG memungkinkan Model Bahasa Besar (LLM) mengakses dan menggabungkan data dari sumber pengetahuan eksternal, seperti dokumen dan database. Dengan menggunakan RAG, LLM dapat menghasilkan respons LLM yang lebih akurat dan informatif.

Daftar parameter

Bagian ini mencantumkan hal berikut:

Parameter	Contoh
Lihat Parameter pengelolaan korpus.	Lihat Contoh pengelolaan korpus.
Lihat Parameter pengelolaan file.	Lihat Contoh pengelolaan file.
Lihat Parameter pengelolaan project.	Lihat Contoh pengelolaan project.

Parameter pengelolaan korpus

Untuk mengetahui informasi tentang korpus RAG, lihat Pengelolaan korpus.

Membuat korpus RAG

Tabel ini mencantumkan parameter yang digunakan untuk membuat korpus RAG.

Isi Permintaan

Parameter
`display_name`	Wajib: `string` Nama tampilan korpus RAG.
`description`	Opsional: `string` Deskripsi korpus RAG.
`encryption_spec`	Opsional: Tidak dapat diubah: `string` Nama kunci CMEK digunakan untuk mengenkripsi data saat tidak digunakan yang terkait dengan korpus RAG. Nama kunci hanya berlaku untuk opsi `RagManaged` untuk database vektor. Saat korpus dibuat, kolom ini dapat ditetapkan dan tidak dapat diperbarui atau dihapus. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key_name}`
`vector_db_config`	Opsional: Tidak dapat diubah: `vectorDbConfig` Konfigurasi untuk DB Vektor.
`vertex_ai_search_config.serving_config`	Opsional: `string` Konfigurasi untuk Vertex AI Search. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` atau `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`

`vectorDbConfig`

Parameter
`rag_managed_db`	`oneof` `vector_db`: `vectorDbConfig.RagManagedDb` Jika tidak ada database vektor yang ditentukan, `rag_managed_db` adalah database vektor default.
`pinecone`	`oneof` `vector_db`: `vectorDbConfig.Pinecone` Menentukan instance Pinecone Anda.
`pinecone.index_name`	`string` Ini adalah nama yang digunakan untuk membuat indeks Pinecone yang digunakan dengan korpus RAG. Nilai ini tidak dapat diubah setelah ditetapkan. Anda dapat membiarkannya kosong di panggilan API `CreateRagCorpus`, dan menyetelnya dengan nilai yang tidak kosong di panggilan API `UpdateRagCorpus` berikutnya.
`vertex_vector_search`	`oneof` `vector_db`: `vectorDbConfig.VertexVectorSearch` Menentukan instance Vertex Vector Search Anda.
`vertex_vector_search.index`	`string` Ini adalah nama resource indeks Vector Search yang digunakan dengan korpus RAG. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` Nilai ini tidak dapat diubah setelah ditetapkan. Anda dapat membiarkannya kosong di panggilan API `CreateRagCorpus`, dan menyetelnya dengan nilai yang tidak kosong di panggilan API `UpdateRagCorpus` berikutnya.
`vertex_vector_search.index_endpoint`	`string` Ini adalah nama resource endpoint indeks Vector Search yang digunakan dengan korpus RAG. Format: `projects/{project}/locations/{location}/indexes/{index}` Nilai ini tidak dapat diubah setelah ditetapkan. Anda dapat membiarkannya kosong di panggilan API `CreateRagCorpus`, dan menyetelnya dengan nilai yang tidak kosong di panggilan API `UpdateRagCorpus` berikutnya.
`api_auth.api_key_config.api_key_secret_version`	`string` Ini adalah nama resource lengkap secret yang disimpan di Secret Manager, yang berisi kunci API Pinecone Anda. Format: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}` Anda dapat membiarkannya kosong dalam panggilan API `CreateRagCorpus`, dan menyetelnya dengan nilai yang tidak kosong dalam panggilan API `UpdateRagCorpus` berikutnya.
`rag_embedding_model_config.vertex_prediction_endpoint.endpoint`	Opsional: Tidak dapat diubah: `string` Model embedding yang akan digunakan untuk korpus RAG. Nilai ini tidak dapat diubah setelah ditetapkan. Jika Anda membiarkannya kosong, kami akan menggunakan text-embedding-005 sebagai model embedding.

Memperbarui korpus RAG

Tabel ini mencantumkan parameter yang digunakan untuk memperbarui korpus RAG.

Isi Permintaan

Parameter
`display_name`	Opsional: `string` Nama tampilan korpus RAG.
`description`	Opsional: `string` Deskripsi korpus RAG.
`rag_vector_db.pinecone.index_name`	`string` Ini adalah nama yang digunakan untuk membuat indeks Pinecone yang digunakan dengan korpus RAG. Jika `RagCorpus` Anda dibuat dengan konfigurasi `Pinecone`, dan kolom ini belum pernah disetel sebelumnya, Anda dapat memperbarui nama indeks instance Pinecone.
`rag_vector_db.vertex_vector_search.index`	`string` Ini adalah nama resource indeks Vector Search yang digunakan dengan korpus RAG. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` Jika `RagCorpus` Anda dibuat dengan konfigurasi `Vector Search`, dan kolom ini belum pernah ditetapkan sebelumnya, Anda dapat memperbaruinya.
`rag_vector_db.vertex_vector_search.index_endpoint`	`string` Ini adalah nama resource endpoint indeks Vector Search yang digunakan dengan korpus RAG. Format: `projects/{project}/locations/{location}/indexes/{index}` Jika `RagCorpus` Anda dibuat dengan konfigurasi `Vector Search`, dan kolom ini belum pernah ditetapkan sebelumnya, Anda dapat memperbaruinya.
`rag_vector_db.api_auth.api_key_config.api_key_secret_version`	`string` Nama resource lengkap secret yang disimpan di Secret Manager, yang berisi kunci API Pinecone Anda. Format: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}`

Mencantumkan korpus RAG

Tabel ini mencantumkan parameter yang digunakan untuk mencantumkan korpora RAG.

Parameter

Parameter
`page_size`	Opsional: `int` Ukuran halaman daftar standar.
`page_token`	Opsional: `string` Token halaman daftar standar. Biasanya diperoleh dari `[ListRagCorporaResponse.next_page_token][]` panggilan `[VertexRagDataService.ListRagCorpora][]` sebelumnya.

page_size

Opsional: int

Ukuran halaman daftar standar.

page_token

Opsional: string

Token halaman daftar standar. Biasanya diperoleh dari [ListRagCorporaResponse.next_page_token][] panggilan [VertexRagDataService.ListRagCorpora][] sebelumnya.

Mendapatkan korpus RAG

Tabel ini mencantumkan parameter yang digunakan untuk mendapatkan korpus RAG.

Parameter

Parameter
`name`	`string` Nama resource `RagCorpus`. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`

name

string

Nama resource RagCorpus. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}

Menghapus korpus RAG

Tabel ini mencantumkan parameter yang digunakan untuk menghapus korpus RAG.

Parameter

Parameter
`name`	`string` Nama resource `RagCorpus`. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`

name

string

Nama resource RagCorpus. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}

Parameter pengelolaan file

Untuk mengetahui informasi tentang file RAG, lihat Pengelolaan file.

Mengupload file RAG

Tabel ini mencantumkan parameter yang digunakan untuk mengupload file RAG.

Isi Permintaan

Parameter

Parameter
`parent`	`string` Nama resource `RagCorpus`. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`
`rag_file`	Wajib: `RagFile` File yang akan diupload.
`upload_rag_file_config`	Wajib: `UploadRagFileConfig` Konfigurasi untuk `RagFile` yang akan diupload ke `RagCorpus`.

parent

string

Nama resource RagCorpus. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}

rag_file

Wajib: RagFile

File yang akan diupload.

upload_rag_file_config

Wajib: UploadRagFileConfig

Konfigurasi untuk RagFile yang akan diupload ke RagCorpus.

`RagFile`
`display_name`	Wajib: `string` Nama tampilan file RAG.
`description`	Opsional: `string` Deskripsi file RAG.

RagFile

display_name

Wajib: string

Nama tampilan file RAG.

description

Opsional: string

Deskripsi file RAG.

`UploadRagFileConfig`
`rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_size`	`int32` Jumlah token yang dimiliki setiap potongan.
`rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_overlap`	`int32` Tumpang-tindih antar-chunk.

UploadRagFileConfig

rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_size

int32

Jumlah token yang dimiliki setiap potongan.

rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_overlap

int32

Tumpang-tindih antar-chunk.

Mengimpor file RAG

Tabel ini mencantumkan parameter yang digunakan untuk mengimpor file RAG.

Parameter
`parent`	Wajib: `string` Nama resource `RagCorpus`. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`
`gcs_source`	`oneof` `import_source`: `GcsSource` Lokasi Cloud Storage. Mendukung pengimporan file satu per satu serta seluruh direktori Cloud Storage.
`gcs_source.uris`	`list` dari `string` URI Cloud Storage yang berisi file upload.
`google_drive_source`	`oneof` `import_source`: `GoogleDriveSource` Lokasi Google Drive. Mendukung pengimporan file individual serta folder Google Drive.
`slack_source`	`oneof` `import_source`: `SlackSource` Channel Slack tempat file diupload.
`jira_source`	`oneof` `import_source`: `JiraSource` Kueri Jira tempat file diupload.
`share_point_sources`	`oneof` `import_source`: `SharePointSources` Sumber SharePoint tempat file diupload.
`rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_size`	`int32` Jumlah token yang dimiliki setiap potongan.
`rag_file_transformation_config.rag_file_chunking_config.fixed_length_chunking.chunk_overlap`	`int32` Tumpang-tindih antar-chunk.
`rag_file_parsing_config`	Opsional: `RagFileParsingConfig` Menentukan konfigurasi parsing untuk `RagFiles`. Jika kolom ini tidak disetel, RAG akan menggunakan parser default.
`max_embedding_requests_per_min`	Opsional: `int32` Jumlah maksimum kueri per menit yang diizinkan untuk tugas ini ke model sematan yang ditentukan pada korpus. Nilai ini khusus untuk tugas ini dan tidak dibagikan di tugas impor lainnya. Lihat halaman Kuota di project untuk menetapkan nilai yang sesuai. Jika tidak ditentukan, nilai default 1.000 QPM akan digunakan.

`GoogleDriveSource`
`resource_ids.resource_id`	Wajib: `string` ID resource Google Drive.
`resource_ids.resource_type`	Wajib: `string` Jenis resource Google Drive.

GoogleDriveSource

resource_ids.resource_id

Wajib: string

ID resource Google Drive.

resource_ids.resource_type

Wajib: string

Jenis resource Google Drive.

`SlackSource`
`channels.channels`	Berulang: `SlackSource.SlackChannels.SlackChannel` Informasi channel Slack, termasuk ID dan rentang waktu yang akan diimpor.
`channels.channels.channel_id`	Wajib: `string` ID channel Slack.
`channels.channels.start_time`	Opsional: `google.protobuf.Timestamp` Stempel waktu awal untuk pesan yang akan diimpor.
`channels.channels.end_time`	Opsional: `google.protobuf.Timestamp` Stempel waktu akhir untuk pesan yang akan diimpor.
`channels.api_key_config.api_key_secret_version`	Wajib: `string` Nama lengkap resource secret yang disimpan di Secret Manager, yang berisi token akses saluran Slack yang memiliki akses ke ID saluran Slack. Lihat: https://api.slack.com/tutorials/tracks/getting-a-token. Format: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}`

`JiraSource`
`jira_queries.projects`	Berulang: `string` Daftar project Jira yang akan diimpor secara keseluruhan.
`jira_queries.custom_queries`	Berulang: `string` Daftar kueri Jira kustom yang akan diimpor. Untuk mengetahui informasi tentang JQL (Jira Query Language), lihat Dukungan Jira
`jira_queries.email`	Wajib: `string` Alamat email Jira.
`jira_queries.server_uri`	Wajib: `string` URI server Jira.
`jira_queries.api_key_config.api_key_secret_version`	Wajib: `string` Nama lengkap resource rahasia yang disimpan di Secret Manager, yang berisi kunci API Jira yang memiliki akses ke ID channel Slack. Lihat: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/ Format: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}`

`SharePointSources`
`share_point_sources.sharepoint_folder_path`	`oneof` di `folder_source`: `string` Jalur folder SharePoint yang akan didownload.
`share_point_sources.sharepoint_folder_id`	`oneof` di `folder_source`: `string` ID folder SharePoint yang akan didownload.
`share_point_sources.drive_name`	`oneof` di `drive_source`: `string` Nama perjalanan yang akan didownload.
`share_point_sources.drive_id`	`oneof` di `drive_source`: `string` ID drive yang akan didownload.
`share_point_sources.client_id`	`string` ID Aplikasi untuk aplikasi yang terdaftar di Microsoft Azure Portal. Aplikasi juga harus dikonfigurasi dengan izin MS Graph "Files.ReadAll", "Sites.ReadAll", dan BrowserSiteLists.Read.All.
`share_point_sources.client_secret.api_key_secret_version`	Wajib: `string` Nama lengkap resource secret yang disimpan di Secret Manager, yang berisi secret aplikasi untuk aplikasi yang terdaftar di Azure. Format: `projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}`
`share_point_sources.tenant_id`	`string` ID unik Instance Azure Active Directory.
`share_point_sources.sharepoint_site_name`	`string` Nama situs SharePoint yang akan didownload. Ini bisa berupa nama situs atau ID situs.

`RagFileParsingConfig`
`layout_parser`	`oneof` `parser`: `RagFileParsingConfig.LayoutParser` Parser Tata Letak yang akan digunakan untuk `RagFile`.
`layout_parser.processor_name`	`string` Nama lengkap resource pemroses atau versi pemroses Document AI. Format: `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` Jumlah maksimum permintaan yang diizinkan untuk dibuat tugas ke pemroses Document AI per menit. Lihat https://cloud.google.com/document-ai/quotas dan halaman Kuota untuk project Anda guna menetapkan nilai yang sesuai di sini. Jika tidak ditentukan, nilai default 120 QPM akan digunakan.
`llm_parser`	`oneof` `parser`: `RagFileParsingConfig.LlmParser` Parser LLM yang akan digunakan untuk `RagFile`.
`llm_parser.model_name`	`string` Nama resource model LLM. Format: `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`
`llm_parser.max_parsing_requests_per_min`	`string` Jumlah maksimum permintaan yang diizinkan untuk dibuat tugas ke model LLM per menit. Untuk menetapkan nilai yang sesuai untuk project Anda, lihat bagian kuota model dan halaman Kuota untuk project Anda guna menetapkan nilai yang sesuai di sini. Jika tidak ditentukan, nilai default 5.000 QPM akan digunakan.

Mendapatkan file RAG

Tabel ini mencantumkan parameter yang digunakan untuk mendapatkan file RAG.

Parameter

Parameter
`name`	`string` Nama resource `RagFile`. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_file_id}`

name

string

Nama resource RagFile. Format: projects/{project}/locations/{location}/ragCorpora/{rag_file_id}

Menghapus file RAG

Tabel ini mencantumkan parameter yang digunakan untuk menghapus file RAG.

Parameter

Parameter
`name`	`string` Nama resource `RagFile`. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_file_id}`

name

string

Nama resource RagFile. Format: projects/{project}/locations/{location}/ragCorpora/{rag_file_id}

Parameter pengambilan dan prediksi

Bagian ini mencantumkan parameter pengambilan dan prediksi.

Parameter pengambilan

Tabel ini mencantumkan parameter untuk retrieveContexts API.

Parameter

Parameter
`parent`	Wajib: `string` Nama resource Lokasi yang akan diambil `RagContexts`. Pengguna harus memiliki izin untuk melakukan panggilan di project. Format: `projects/{project}/locations/{location}`
`vertex_rag_store`	`VertexRagStore` Sumber data untuk Vertex RagStore.
`query`	Wajib: `RagQuery` Kueri pengambilan RAG tunggal.

parent

Wajib: string

Nama resource Lokasi yang akan diambil RagContexts.
Pengguna harus memiliki izin untuk melakukan panggilan di project.

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

vertex_rag_store

VertexRagStore

Sumber data untuk Vertex RagStore.

query

Wajib: RagQuery

Kueri pengambilan RAG tunggal.

`VertexRagStore`

`VertexRagStore`
`rag_resources`	daftar: `RagResource` Representasi sumber RAG. Dapat digunakan untuk menentukan hanya korpus atau `RagFile`. Hanya mendukung satu korpus atau beberapa file dari satu korpus.
`rag_resources.rag_corpus`	Opsional: `string` Nama resource `RagCorpora`. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
`rag_resources.rag_file_ids`	daftar: `string` Daftar resource `RagFile`. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`

VertexRagStore

rag_resources

daftar: RagResource

Representasi sumber RAG. Dapat digunakan untuk menentukan hanya korpus atau RagFile. Hanya mendukung satu korpus atau beberapa file dari satu korpus.

rag_resources.rag_corpus

Opsional: string

Nama resource RagCorpora.

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

rag_resources.rag_file_ids

daftar: string

Daftar resource RagFile.

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

`RagQuery`
`text`	`string` Kueri dalam format teks untuk mendapatkan konteks yang relevan.
`rag_retrieval_config`	Opsional: `RagRetrievalConfig` Konfigurasi pengambilan untuk kueri.

RagQuery

text

string

Kueri dalam format teks untuk mendapatkan konteks yang relevan.

rag_retrieval_config

Opsional: RagRetrievalConfig

Konfigurasi pengambilan untuk kueri.

`RagRetrievalConfig`
`top_k`	Opsional: `int32` Jumlah konteks yang akan diambil.
`filter.vector_distance_threshold`	`oneof vector_db_threshold`: `double` Hanya menampilkan konteks dengan jarak vektor yang lebih kecil daripada nilai minimum.
`filter.vector_similarity_threshold`	`oneof vector_db_threshold`: `double` Hanya menampilkan konteks dengan kemiripan vektor yang lebih besar daripada nilai minimum.
`ranking.rank_service.model_name`	Opsional: `string` Nama model layanan peringkat. Contoh: `semantic-ranker-512@latest`
`ranking.llm_ranker.model_name`	Opsional: `string` Nama model yang digunakan untuk penentuan peringkat. Contoh: `gemini-2.5-flash`

Parameter prediksi

Tabel ini mencantumkan parameter prediksi.

`GenerateContentRequest`
`tools.retrieval.vertex_rag_store`	`VertexRagStore` Disetel untuk menggunakan sumber data yang didukung oleh penyimpanan RAG Vertex AI.

GenerateContentRequest

tools.retrieval.vertex_rag_store

VertexRagStore

Disetel untuk menggunakan sumber data yang didukung oleh penyimpanan RAG Vertex AI.

Lihat VertexRagStore untuk mengetahui detailnya.

Parameter pengelolaan project

Tabel ini mencantumkan parameter tingkat project.

`RagEngineConfig`

Parameter
`RagManagedDbConfig.scaled`	Tingkatan ini menawarkan performa skala produksi beserta fungsi penskalaan otomatis.
`RagManagedDbConfig.basic`	Tingkat ini menawarkan tingkat komputasi rendah yang hemat biaya.
`RagManagedDbConfig.unprovisioned`	Tingkatan ini menghapus `RagManagedDb` dan instance Spanner yang mendasarinya.

Contoh pengelolaan korpus

Bagian ini memberikan contoh cara menggunakan API untuk mengelola korpus RAG Anda.

Membuat contoh korpus RAG

Contoh kode ini menunjukkan cara membuat korpus RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
CORPUS_DISPLAY_NAME: Nama tampilan korpus RAG.
CORPUS_DESCRIPTION: Deskripsi korpus RAG.

Metode HTTP dan URL:

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

Isi JSON permintaan:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora"

Powershell

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

  $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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora" | Select-Object -Expand Content

Anda akan menerima kode status yang berhasil (2xx).

Contoh berikut menunjukkan cara membuat korpus RAG menggunakan REST API.

  // 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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora \
  -d '{
        "display_name" : "CORPUS_DISPLAY_NAME"
    }'

Python

Untuk mempelajari cara menginstal atau mengupdate Vertex AI SDK untuk Python, lihat Menginstal Vertex AI SDK untuk Python. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Python.


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# display_name = "test_corpus"
# description = "Corpus Description"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

# Configure backend_config
backend_config = rag.RagVectorDbConfig(
    rag_embedding_model_config=rag.RagEmbeddingModelConfig(
        vertex_prediction_endpoint=rag.VertexPredictionEndpoint(
            publisher_model="publishers/google/models/text-embedding-005"
        )
    )
)

corpus = rag.create_corpus(
    display_name=display_name,
    description=description,
    backend_config=backend_config,
)
print(corpus)
# Example response:
# RagCorpus(name='projects/1234567890/locations/us-central1/ragCorpora/1234567890',
# display_name='test_corpus', description='Corpus Description', embedding_model_config=...
# ...

Memperbarui contoh korpus RAG

Anda dapat memperbarui korpus RAG dengan nama tampilan, deskripsi, dan konfigurasi database vektor baru. Namun, Anda tidak dapat mengubah parameter berikut dalam korpus RAG:

Jenis database vektor. Misalnya, Anda tidak dapat mengubah database vektor dari Weaviate ke Vertex AI Feature Store.
Jika menggunakan opsi database terkelola, Anda tidak dapat memperbarui konfigurasi database vektor.

Contoh ini menunjukkan cara memperbarui korpus RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
CORPUS_ID: ID korpus RAG Anda.
CORPUS_DISPLAY_NAME: Nama tampilan korpus RAG.
CORPUS_DESCRIPTION: Deskripsi korpus RAG.
INDEX_NAME: Nama resource Indeks Penelusuran Vektor. Format: projects/{project}/locations/{location}/indexes/{index}.
INDEX_ENDPOINT_NAME: Nama resource endpoint indeks Vector Search. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}.

Metode HTTP dan URL:

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

Isi JSON permintaan:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/CORPUS_ID"

Powershell

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/CORPUS_ID" | Select-Object -Expand Content

Anda akan menerima kode status yang berhasil (2xx).

Contoh daftar korpus RAG

Contoh kode ini menunjukkan cara mencantumkan semua korpus RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
PAGE_SIZE: Ukuran halaman daftar standar. Anda dapat menyesuaikan jumlah korpus RAG yang ditampilkan per halaman dengan memperbarui parameter page_size.
PAGE_TOKEN: Token halaman daftar standar. Diperoleh biasanya menggunakan ListRagCorporaResponse.next_page_token dari panggilan VertexRagDataService.ListRagCorpora sebelumnya.

Metode HTTP dan URL:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Powershell

Jalankan perintah berikut:

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

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

Anda akan menerima kode status yang berhasil (2xx) dan daftar korpus RAG dalam PROJECT_ID yang diberikan.

Python


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

corpora = rag.list_corpora()
print(corpora)
# Example response:
# ListRagCorporaPager<rag_corpora {
#   name: "projects/[PROJECT_ID]/locations/us-central1/ragCorpora/2305843009213693952"
#   display_name: "test_corpus"
#   create_time {
# ...

Mendapatkan contoh korpus RAG

Contoh kode ini menunjukkan cara mendapatkan korpus RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID resource korpus RAG.

Metode HTTP dan URL:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Powershell

Jalankan perintah berikut:

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

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

Respons yang berhasil akan menampilkan resource RagCorpus.

Perintah get dan list digunakan dalam contoh untuk menunjukkan cara RagCorpus menggunakan kolom rag_embedding_model_config dengan dalam vector_db_config, yang mengarah ke model penyematan yang telah Anda pilih.

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

```sh
  // 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/v1/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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/
  ```

Python


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

corpus = rag.get_corpus(name=corpus_name)
print(corpus)
# Example response:
# RagCorpus(name='projects/[PROJECT_ID]/locations/us-central1/ragCorpora/1234567890',
# display_name='test_corpus', description='Corpus Description',
# ...

Menghapus contoh korpus RAG

Contoh kode ini menunjukkan cara menghapus korpus RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID resource RagCorpus.

Metode HTTP dan URL:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Powershell

Jalankan perintah berikut:

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

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

Respons yang berhasil akan menampilkan DeleteOperationMetadata.

Python


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

rag.delete_corpus(name=corpus_name)
print(f"Corpus {corpus_name} deleted.")
# Example response:
# Successfully deleted the RagCorpus.
# Corpus projects/[PROJECT_ID]/locations/us-central1/ragCorpora/123456789012345 deleted.

Contoh pengelolaan file

Bagian ini memberikan contoh cara menggunakan API untuk mengelola file RAG.

Contoh upload file RAG

Contoh kode ini menunjukkan cara mengupload file RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID korpus RAG Anda.
LOCAL_FILE_PATH: Jalur lokal ke file yang akan diupload.
DISPLAY_NAME: Nama tampilan file RAG.
DESCRIPTION: Deskripsi file RAG.

Untuk mengirim permintaan, gunakan perintah berikut:

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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:upload"

Python


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}"
# path = "path/to/local/file.txt"
# display_name = "file_display_name"
# description = "file description"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

rag_file = rag.upload_file(
    corpus_name=corpus_name,
    path=path,
    display_name=display_name,
    description=description,
)
print(rag_file)
# RagFile(name='projects/[PROJECT_ID]/locations/us-central1/ragCorpora/1234567890/ragFiles/09876543',
#  display_name='file_display_name', description='file description')

Contoh mengimpor file RAG

File dan folder dapat diimpor dari Drive atau Cloud Storage. Anda dapat menggunakan response.metadata untuk melihat kegagalan parsial, waktu permintaan, dan waktu respons dalam objek response SDK.

response.skipped_rag_files_count mengacu pada jumlah file yang dilewati selama impor. File dilewati jika kondisi berikut terpenuhi:

File sudah diimpor.
File tidak berubah.
Konfigurasi chunking untuk file tidak berubah.

Python

from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}"
# paths = ["https://drive.google.com/file/123", "gs://my_bucket/my_files_dir"]  # Supports Cloud Storage and Google Drive Links

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

response = rag.import_files(
    corpus_name=corpus_name,
    paths=paths,
    transformation_config=rag.TransformationConfig(
        rag.ChunkingConfig(chunk_size=1024, chunk_overlap=256)
    ),
    import_result_sink="gs://sample-existing-folder/sample_import_result_unique.ndjson",  # Optional: This must be an existing Cloud Storage bucket folder, and the filename must be unique (non-existent).
    llm_parser=rag.LlmParserConfig(
      model_name="gemini-2.5-pro-preview-05-06",
      max_parsing_requests_per_min=100,
    ),  # Optional
    max_embedding_requests_per_min=900,  # Optional
)
print(f"Imported {response.imported_rag_files_count} files.")

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID korpus RAG Anda.
FOLDER_RESOURCE_ID: ID resource folder Drive Anda.
GCS_URIS: Daftar lokasi Cloud Storage. Contoh: gs://my-bucket1.
CHUNK_SIZE: Jumlah token yang harus dimiliki setiap potongan.
CHUNK_OVERLAP: Jumlah token yang tumpang-tindih antar-potongan.
EMBEDDING_MODEL_QPM_RATE: Kecepatan QPM untuk membatasi akses RAG ke model embedding Anda. Contoh: 1.000.

Metode HTTP dan URL:

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

Isi JSON permintaan:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:import"

Powershell

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$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/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora/RAG_CORPUS_ID/ragFiles:import" | Select-Object -Expand Content

Respons yang berhasil akan menampilkan resource ImportRagFilesOperationMetadata.

Contoh berikut menunjukkan cara mengimpor file dari Cloud Storage. Gunakan kolom kontrol max_embedding_requests_per_min untuk membatasi kecepatan RAG Engine memanggil model embedding selama proses pengindeksan ImportRagFiles. Kolom ini memiliki nilai default 1000 panggilan per menit.

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID korpus RAG Anda.
GCS_URIS: Daftar lokasi Cloud Storage. Contoh: gs://my-bucket1.
CHUNK_SIZE: Jumlah token yang harus dimiliki setiap potongan.
CHUNK_OVERLAP: Jumlah token yang tumpang-tindih antar-potongan.
EMBEDDING_MODEL_QPM_RATE: Tingkat QPM untuk membatasi akses RAG ke model embedding Anda. Contoh: 1.000.

// 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/v1/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
  }
}'

Contoh berikut menunjukkan cara mengimpor file dari Drive. Gunakan kolom kontrol max_embedding_requests_per_min untuk membatasi kecepatan RAG Engine memanggil model embedding selama proses pengindeksan ImportRagFiles. Kolom ini memiliki nilai default 1000 panggilan per menit.

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID korpus RAG Anda.
FOLDER_RESOURCE_ID: ID resource folder Drive Anda.
CHUNK_SIZE: Jumlah token yang harus dimiliki setiap potongan.
CHUNK_OVERLAP: Jumlah token yang tumpang-tindih antar-potongan.
EMBEDDING_MODEL_QPM_RATE: Kecepatan QPM untuk membatasi akses RAG ke model embedding Anda. Contoh: 1.000.

// 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/v1/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
  }
}'

Contoh file RAG daftar

Contoh kode ini menunjukkan cara mencantumkan file RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID resource RagCorpus.
PAGE_SIZE: Ukuran halaman daftar standar. Anda dapat menyesuaikan jumlah RagFiles yang akan ditampilkan per halaman dengan memperbarui parameter page_size.
PAGE_TOKEN: Token halaman daftar standar. Diperoleh menggunakan ListRagFilesResponse.next_page_token dari panggilan VertexRagDataService.ListRagFiles sebelumnya.

Metode HTTP dan URL:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Powershell

Jalankan perintah berikut:

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

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

Anda akan menerima kode status yang berhasil (2xx) beserta daftar RagFiles dalam RAG_CORPUS_ID yang diberikan.

Python


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

files = rag.list_files(corpus_name=corpus_name)
for file in files:
    print(file.display_name)
    print(file.name)
# Example response:
# g-drive_file.txt
# projects/1234567890/locations/us-central1/ragCorpora/111111111111/ragFiles/222222222222
# g_cloud_file.txt
# projects/1234567890/locations/us-central1/ragCorpora/111111111111/ragFiles/333333333333

Mendapatkan contoh file RAG

Contoh kode ini menunjukkan cara mendapatkan file RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID resource RagCorpus.
RAG_FILE_ID: ID resource RagFile.

Metode HTTP dan URL:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Powershell

Jalankan perintah berikut:

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

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

Respons yang berhasil akan menampilkan resource RagFile.

Python


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# file_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}/ragFiles/{rag_file_id}"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

rag_file = rag.get_file(name=file_name)
print(rag_file)
# Example response:
# RagFile(name='projects/1234567890/locations/us-central1/ragCorpora/11111111111/ragFiles/22222222222',
# display_name='file_display_name', description='file description')

Menghapus contoh file RAG

Contoh kode ini menunjukkan cara menghapus file RAG.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID>: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_ID: ID resource RagCorpus.
RAG_FILE_ID: ID resource RagFile. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file_id}.

Metode HTTP dan URL:

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

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Jalankan perintah berikut:

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

Powershell

Jalankan perintah berikut:

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

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

Python


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# file_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}/ragFiles/{rag_file_id}"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

rag.delete_file(name=file_name)
print(f"File {file_name} deleted.")
# Example response:
# Successfully deleted the RagFile.
# File projects/1234567890/locations/us-central1/ragCorpora/1111111111/ragFiles/2222222222 deleted.

Contoh kueri pengambilan

Saat pengguna mengajukan pertanyaan atau memberikan perintah, komponen pengambilan di RAG akan menelusuri pusat informasinya untuk menemukan informasi yang relevan dengan kueri.

Python


from vertexai import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/[PROJECT_ID]/locations/us-central1/ragCorpora/[rag_corpus_id]"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

response = rag.retrieval_query(
    rag_resources=[
        rag.RagResource(
            rag_corpus=corpus_name,
            # Optional: supply IDs from `rag.list_files()`.
            # rag_file_ids=["rag-file-1", "rag-file-2", ...],
        )
    ],
    text="Hello World!",
    rag_retrieval_config=rag.RagRetrievalConfig(
        top_k=10,
        filter=rag.utils.resources.Filter(vector_distance_threshold=0.5),
    ),
)
print(response)
# Example response:
# contexts {
#   contexts {
#     source_uri: "gs://your-bucket-name/file.txt"
#     text: "....
#   ....

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
RAG_CORPUS_RESOURCE: Nama resource RagCorpus. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.
VECTOR_DISTANCE_THRESHOLD: Hanya konteks dengan jarak vektor yang lebih kecil dari nilai minimum yang ditampilkan.
TEXT: Teks kueri untuk mendapatkan konteks yang relevan.
SIMILARITY_TOP_K: Jumlah konteks teratas yang akan diambil.

Metode HTTP dan URL:

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

Meminta isi JSON:

{
"vertex_rag_store": {
    "rag_resources": {
      "rag_corpus": "RAG_CORPUS_RESOURCE"
    },
    "vector_distance_threshold": VECTOR_DISTANCE_THRESHOLD
  },
  "query": {
  "text": TEXT
  "similarity_top_k": SIMILARITY_TOP_K
  }
}

curl

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

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/v1/projects/PROJECT_ID/locations/LOCATION:retrieveContexts"

Powershell

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$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/v1/projects/PROJECT_ID/locations/LOCATION:retrieveContexts" | Select-Object -Expand Content

Anda akan menerima kode status yang berhasil (2xx) dan daftar RagFiles terkait.

Contoh pembuatan

LLM menghasilkan respons yang berisi rujukan menggunakan konteks yang diambil.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Anda.
LOCATION: Region untuk memproses permintaan.
MODEL_ID: Model LLM untuk pembuatan konten. Contoh: gemini-2.5-flash.
GENERATION_METHOD: Metode LLM untuk pembuatan konten. Opsi: generateContent, streamGenerateContent.
INPUT_PROMPT: Teks yang dikirim ke LLM untuk pembuatan konten. Coba gunakan perintah yang relevan dengan File rag yang diupload.
RAG_CORPUS_RESOURCE: Nama resource RagCorpus. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.
SIMILARITY_TOP_K: Opsional: Jumlah konteks teratas yang akan diambil.
VECTOR_DISTANCE_THRESHOLD: Opsional: Konteks dengan jarak vektor yang lebih kecil dari nilai minimum akan ditampilkan.
USER: Nama pengguna Anda.

Metode HTTP dan URL:

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

Isi JSON permintaan:

{
"contents": {
  "role": "USER",
  "parts": {
    "text": "INPUT_PROMPT"
  }
},
"tools": {
  "retrieval": {
  "disable_attribution": false,
  "vertex_rag_store": {
    "rag_resources": {
      "rag_corpus": "RAG_CORPUS_RESOURCE"
    },
    "similarity_top_k": "SIMILARITY_TOP_K",
    "vector_distance_threshold": VECTOR_DISTANCE_THRESHOLD
  }
  }
}
}

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

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/v1/projects/PROJECT_ID/locations/LOCATION/publishers/google/models/MODEL_ID:GENERATION_METHOD"

Powershell

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$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/v1/projects/PROJECT_ID/locations/LOCATION/publishers/google/models/MODEL_ID:GENERATION_METHOD" | Select-Object -Expand Content

Respons yang berhasil akan menampilkan konten yang dihasilkan dengan kutipan.

Python


from vertexai import rag
from vertexai.generative_models import GenerativeModel, Tool
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

rag_retrieval_tool = Tool.from_retrieval(
    retrieval=rag.Retrieval(
        source=rag.VertexRagStore(
            rag_resources=[
                rag.RagResource(
                    rag_corpus=corpus_name,
                    # Optional: supply IDs from `rag.list_files()`.
                    # rag_file_ids=["rag-file-1", "rag-file-2", ...],
                )
            ],
            rag_retrieval_config=rag.RagRetrievalConfig(
                top_k=10,
                filter=rag.utils.resources.Filter(vector_distance_threshold=0.5),
            ),
        ),
    )
)

rag_model = GenerativeModel(
    model_name="gemini-2.0-flash-001", tools=[rag_retrieval_tool]
)
response = rag_model.generate_content("Why is the sky blue?")
print(response.text)
# Example response:
#   The sky appears blue due to a phenomenon called Rayleigh scattering.
#   Sunlight, which contains all colors of the rainbow, is scattered
#   by the tiny particles in the Earth's atmosphere....
#   ...

Contoh pengelolaan project

Tingkat adalah setelan tingkat project yang tersedia di bagian resource RagEngineConfig dan memengaruhi korpus RAG yang menggunakan RagManagedDb. Untuk mendapatkan konfigurasi tingkat, gunakan GetRagEngineConfig. Untuk memperbarui konfigurasi tingkat, gunakan UpdateRagEngineConfig.

Untuk mengetahui informasi selengkapnya tentang cara mengelola konfigurasi tingkat, lihat Mengelola tingkat.

Mendapatkan konfigurasi project

Contoh kode berikut menunjukkan cara membaca RagEngineConfig Anda:

Konsol

Di konsol Google Cloud , buka halaman RAG Engine.
Buka RAG Engine
Pilih region tempat RAG Engine Anda berjalan. Daftar korpus RAG Anda diperbarui.
Klik Configure RAG Engine. Panel Configure RAG Engine akan muncul. Anda dapat melihat tingkatan yang dipilih untuk RAG Engine Anda.
Klik Cancel.

Python

from vertexai 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)

REST

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

Memperbarui konfigurasi project

Bagian ini memberikan contoh kode untuk menunjukkan cara mengubah konfigurasi ke tingkat Berskala, Dasar, atau Belum Disediakan.

Mengupgrade `RagEngineConfig` Anda ke tingkat Scaled

Contoh kode berikut menunjukkan cara menyetel RagEngineConfig ke tingkat yang Diskalakan:

Konsol

Di konsol Google Cloud , buka halaman RAG Engine.
Buka RAG Engine
Pilih region tempat RAG Engine Anda berjalan. Daftar korpus RAG Anda diperbarui.
Klik Configure RAG Engine. Panel Configure RAG Engine akan muncul.
Pilih tingkat yang ingin Anda jalankan RAG Engine.
Klik Simpan.

Python

from vertexai 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(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)

REST

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

Mengubah `RagEngineConfig` Anda ke paket Basic

Contoh kode berikut menunjukkan cara menyetel RagEngineConfig ke tingkat Dasar:

Konsol

Di konsol Google Cloud , buka halaman RAG Engine.
Buka RAG Engine
Pilih region tempat RAG Engine Anda berjalan. Daftar korpus RAG Anda diperbarui.
Klik Configure RAG Engine. Panel Configure RAG Engine akan muncul.
Pilih tingkat yang ingin Anda jalankan RAG Engine.
Klik Simpan.

Python

from vertexai 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(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)

REST

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

Memperbarui `RagEngineConfig` Anda ke tingkat Belum Disediakan

Contoh kode berikut menunjukkan cara menyetel RagEngineConfig ke tingkat Tidak disediakan:

Konsol

Di konsol Google Cloud , buka halaman RAG Engine.
Buka RAG Engine
Pilih region tempat RAG Engine Anda berjalan. Daftar korpus RAG Anda diperbarui.
Klik Configure RAG Engine. Panel Configure RAG Engine akan muncul.
Klik Hapus Mesin RAG. Dialog konfirmasi akan muncul.
Verifikasi bahwa Anda akan menghapus data Anda di RAG Engine dengan mengetik delete, lalu klik Konfirmasi.
Klik Simpan.

Python

from vertexai 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(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)

REST

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

Langkah berikutnya

Untuk mempelajari lebih lanjut model pembuatan yang didukung, lihat Model AI generatif yang mendukung RAG.
Untuk mempelajari lebih lanjut model embedding yang didukung, lihat Model embedding.
Untuk mempelajari model terbuka lebih lanjut, lihat Model terbuka.
Untuk mempelajari RAG Engine lebih lanjut, lihat Ringkasan RAG Engine.

RAG Engine API Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Daftar parameter

Parameter pengelolaan korpus

Membuat korpus RAG

Isi Permintaan

vectorDbConfig

Memperbarui korpus RAG

Isi Permintaan

Mencantumkan korpus RAG

Mendapatkan korpus RAG

Menghapus korpus RAG

Parameter pengelolaan file

Mengupload file RAG

Isi Permintaan

Mengimpor file RAG

Mendapatkan file RAG

Menghapus file RAG

Parameter pengambilan dan prediksi

Parameter pengambilan

VertexRagStore

Parameter prediksi

Parameter pengelolaan project

RagEngineConfig

Contoh pengelolaan korpus

Membuat contoh korpus RAG

REST

curl

Powershell

Python

Memperbarui contoh korpus RAG

REST

curl

Powershell

Contoh daftar korpus RAG

REST

curl

Powershell

Python

Mendapatkan contoh korpus RAG

REST

curl

Powershell

Python

Menghapus contoh korpus RAG

REST

curl

Powershell

Python

Contoh pengelolaan file

Contoh upload file RAG

REST

Python

Contoh mengimpor file RAG

Python

REST

curl

Powershell

Contoh file RAG daftar

REST

curl

Powershell

Python

Mendapatkan contoh file RAG

REST

curl

Powershell

Python

Menghapus contoh file RAG

REST

curl

Powershell

Python

Contoh kueri pengambilan

Python

REST

curl

Powershell

Contoh pembuatan

REST

curl

RAG Engine API

`vectorDbConfig`

`VertexRagStore`

`RagEngineConfig`

Mengupgrade `RagEngineConfig` Anda ke tingkat Scaled

Mengubah `RagEngineConfig` Anda ke paket Basic

Memperbarui `RagEngineConfig` Anda ke tingkat Belum Disediakan