Ringkasan Vertex AI API

Halaman ini memberikan ringkasan penggunaan API yang diinstal dengan Vertex AI di Google Distributed Cloud (GDC) yang terisolasi dan dokumentasi referensinya.

Endpoint layanan dan dokumen discovery

Endpoint layanan diperlukan untuk berinteraksi secara terprogram dengan Vertex AI API.

Mendapatkan endpoint dan dokumen discovery Vertex AI Workbench

Endpoint API untuk Vertex AI Workbench KRM API adalah:

https://ENDPOINT/apis/aiplatform.gdc.goog/v1

Ganti ENDPOINT dengan endpoint API server Management API.

Untuk mengakses dokumen discovery Vertex AI Workbench, lakukan salah satu tindakan berikut:

  • Masukkan URL endpoint di browser.

  • Jalankan perintah kubectl proxy di alat seperti curl untuk membuka proxy ke server Management API di mesin lokal Anda. Setelah perintah tersebut berjalan, masukkan URL berikut di browser Anda:

    http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1.

Mendapatkan endpoint API terlatih

Untuk mendapatkan endpoint API terlatih, lihat status dan endpoint layanan.

REST, gRPC, KRM, dan library klien

Anda dapat mengakses API terlatih menggunakan gRPC atau salah satu library klien yang disediakan. Library klien dibangun berdasarkan gRPC.

Atau, Anda dapat mengakses beberapa API terlatih menggunakan REST.

Anda dapat mengelola Vertex AI Workbench menggunakan Kubernetes Resource Model (KRM) API.

Library klien

Vertex AI menyediakan library klien Python untuk API terlatih. Tabel berikut menunjukkan perbandingan kelebihan dan kekurangan penggunaan library klien:

Kelebihan Kekurangan
Dikelola oleh Google.
Autentikasi bawaan.
Percobaan ulang bawaan.
Isi permintaan HTTP buffer protokol yang efisien. 		Tidak tersedia untuk semua bahasa pemrograman.

REST

OCR dan Translation API mendukung REST. Untuk mengetahui informasi selengkapnya, lihat referensi REST API untuk layanan ini:

Tabel berikut menunjukkan perbandingan kelebihan dan kekurangan penggunaan REST:

Kelebihan Kekurangan
Antarmuka JSON sederhana.
Didukung dengan baik oleh banyak alat dan library Google dan pihak ketiga. 		Anda harus membuat klien Anda sendiri.
Anda harus menerapkan autentikasi.
Anda harus menerapkan percobaan ulang.
Isi permintaan HTTP JSON yang kurang efisien.
Streaming REST tidak didukung oleh API ini.

gRPC

API terlatih mendukung gRPC. Untuk mengetahui informasi selengkapnya tentang deskripsi umum jenis, metode, dan kolom yang dihasilkan untuk library gRPC, lihat referensi gRPC berikut:

Tabel berikut menunjukkan perbandingan kelebihan dan kekurangan penggunaan gRPC:

Kelebihan Kekurangan
Mendukung banyak bahasa pemrograman.
Isi permintaan HTTP buffer protokol yang efisien. 		Anda harus membuat klien Anda sendiri dari buffer protokol yang disediakan Google.
Anda harus menerapkan autentikasi.
Anda harus menerapkan percobaan ulang.

KRM

Vertex AI Workbench API mendukung KRM. Untuk mengetahui informasi selengkapnya, lihat referensi API Vertex AI Workbench KRM.

Nama jenis, metode, dan kolom

Bergantung pada apakah Anda menggunakan library klien, REST, gRPC, atau KRM, nama jenis, metode, dan kolom untuk API akan bervariasi dengan cara berikut:

  • REST diatur berdasarkan hierarki resource dan metodenya.
  • Library klien dan gRPC diatur berdasarkan layanan dan metodenya.
  • Nama kolom KRM menggunakan camelCase, tetapi layanan API menerima camelCase atau snake_case.
  • Nama kolom REST dan gRPC menggunakan snake_case.
  • Nama kolom library klien menggunakan title case, camelCase, atau snake_case, bergantung pada nama yang idiomatis untuk bahasa tersebut.

REST dan buffer protokol

Saat memanggil REST API, perilaku nilai default untuk buffer protokol dapat menyebabkan kolom yang tidak ada dalam respons JSON. Kolom ini ditetapkan ke nilai default, sehingga tidak disertakan dalam respons.