Pengelolaan dialog konfirmasi

Halaman ini memperkenalkan serangkaian kemampuan terpadu untuk menentukan, menyimpan, mengambil, dan mengelola perintah dalam project Google Cloud Anda menggunakan modul pengelolaan perintah Vertex AI SDK.

Ringkasan

Vertex AI menawarkan alat untuk membantu mengelola template perintah dan data perintah. Template perintah dapat diberi versi dan digunakan dengan model generatif di Vertex AI. Setiap perintah dapat disusun dan diberi versi di Vertex AI Studio atau Vertex AI SDK.

Pengelolaan perintah di Vertex AI SDK mencakup dukungan penuh untuk perusahaan, termasuk dukungan untuk Kunci Enkripsi yang Dikelola Pelanggan (CMEK) dan Kontrol Layanan VPC (VPCSC).

Kemampuan pengelolaan perintah

Untuk menggunakan kemampuan AI generatif dari Vertex AI SDK, lakukan hal berikut:

  1. Instal Vertex AI SDK versi terbaru.

    pip install --upgrade google-cloud-aiplatform
    
  2. Buat klien AI generatif menggunakan contoh kode Python berikut:

        import vertexai
        from vertexai import types
    
        # Instantiate GenAI client from Vertex SDK
        # Replace with your project ID and location
        client = vertexai.Client(project='my-project', location='my-location')
    

Setelah membuat klien AI generatif, Anda dapat menggunakan salah satu kemampuan pengelolaan perintah berikut di Vertex AI SDK:

Membuat perintah lokal

Bagian ini memberikan contoh cara menentukan variabel types.Prompt untuk digunakan di seluruh halaman ini.

Class Prompt digunakan untuk menentukan, menyusun, dan menggunakan perintah. Atribut prompt_data ditentukan untuk class Prompt dan mencakup hal berikut:

Atribut

model

Wajib: Nama model.

contents

Wajib: Konten percakapan dengan model. Hanya perintah sekali putar yang didukung.

generation_config

Opsional: Konfigurasi pembuatan

tool_config

Opsional: Konfigurasi ini dibagikan untuk semua alat yang disediakan dalam permintaan.

tools

Opsional: Daftar Tools yang mungkin digunakan model untuk membuat respons berikutnya. Tool adalah bagian kode yang memungkinkan sistem berinteraksi dengan sistem eksternal untuk melakukan tindakan, atau serangkaian tindakan, di luar pengetahuan dan cakupan model.

safety_settings

Opsional: Setelan permintaan untuk memblokir konten tidak aman, yang diterapkan pada GenerateContentResponse.candidates.

system_instruction

Opsional: Petunjuk sistem yang disediakan pengguna untuk model.

variables

Opsional: Jika perintah Anda berisi variabel template, berikan nilai yang akan digunakan untuk variabel tersebut. Misalnya, jika konten teks perintah Anda adalah "Halo, {name}". Daftar variabel Anda harus menyertakan kamus semua kemungkinan nilai untuk variabel "{name}". Contoh:

        "variables": [
            {"name": {"text": "Alice"}},
            {"name": {"text": "Bob"}},
        ],
        

Contoh kode ini menunjukkan cara menentukan variabel types.Prompt.

  import vertexai
  from vertexai import types
  from google.genai import types

  prompt = types.Prompt(
      prompt_data=types.PromptData(
        contents=[genai_types.Content(parts=[genai_types.Part(text="Hello, {name}! How are you?")])],
        variables=[
          {"name": genai_types.Part(text="Alice")},
          {"name": genai_types.Part(text="Bob")},
        ],
        model="your-model",
      ),
  )

Menyimpan perintah ke project Google Cloud

Bagian ini menyajikan parameter dan contoh cara menyimpan perintah ke project Google Cloud .

Parameter

Tabel ini menjelaskan parameter yang digunakan oleh metode create:

Parameter

prompt

Data untuk perintah tertentu.

config

Opsional: Objek types.CreatePromptConfig yang merepresentasikan konfigurasi untuk membuat perintah.

Tabel ini menjelaskan parameter yang digunakan oleh metode create_version:

Parameter

prompt

Wajib: Data untuk perintah tertentu.

config

Opsional: Objek types.CreatePromptConfig yang merepresentasikan konfigurasi untuk membuat versi perintah.

Prompt ditampilkan oleh metode create_version.

Contoh

Untuk menyimpan perintah ke project Google Cloud , gunakan metode client.prompts.create dan client.prompts.create_version.

Metode client.prompts.create membuat resource perintah di project Google Cloud . Metode client.prompts.create_version membuat versi perintah dalam resource tersebut, dan Anda dapat mengakses resource di konsolGoogle Cloud .

Metode client.prompts.create mengambil objek Prompt sebagai input dan membuat perintah di project Google Cloud . Metode client.prompts.create_version juga memerlukan penerusan prompt_id, yang merupakan ID resource perintah untuk membuat versi. Objek Prompt baru ditampilkan, yang terkait dengan Google Cloud project. Setiap pembaruan yang dilakukan pada objek Prompt bersifat lokal hingga create atau create_version dipanggil.

Contoh kode berikut menunjukkan cara menyimpan perintah dan versi perintah:

  # Save `Prompt` to a Google Cloud project.
  # Returns a new `Prompt` object associated with the saved prompt resource.
  prompt_resource = client.prompts.create(prompt=prompt)
  prompt_version_resource = client.prompts.create_version(prompt=prompt, prompt_id=prompt_resource.prompt_id)

Mendapatkan perintah tersimpan

Bagian ini menyajikan parameter dan contoh cara mendapatkan prompt dan versi prompt.

Ada dua metode: client.prompts.get dan client.prompts.get_version.

Parameter

Tabel ini menjelaskan parameter yang digunakan oleh metode client.prompts.get:

Parameter

prompt_id

Wajib: ID perintah yang akan diambil.

config

Opsional: Objek types.GetPromptConfig yang merepresentasikan konfigurasi untuk mendapatkan perintah.

Tabel ini menjelaskan parameter yang digunakan oleh metode client.prompts.get_version:

Parameter

prompt_id

Wajib: ID perintah yang akan diambil.

version_id

Wajib: ID versi perintah yang ingin Anda ambil.

config

Opsional: Objek types.GetPromptConfig yang merepresentasikan konfigurasi untuk mendapatkan perintah.

Prompt ditampilkan oleh metode get dan get_version.

Contoh

Untuk mendapatkan (memuat) perintah yang telah disimpan ke project Google Cloud , gunakan metode client.prompts.get. Metode ini menggunakan ID perintah sebagai input dan menampilkan objek Prompt yang sesuai. Contoh kode ini menunjukkan cara memuat perintah tersimpan:

  # Get prompt
  retrieved_prompt = client.prompts.get(prompt_id=prompt_resource.prompt_id)

Contoh kode berikut menunjukkan cara mendapatkan versi perintah.

  retrieved_prompt_version = client.prompts.get_version(prompt_id='your-prompt-id', version_id='your-prompt-version-id')

Kode berikut menunjukkan cara mengubah perintah untuk memanggil generate_content di SDK AI generatif.

  from google import genai
  from google.genai import types as genai_types

  genai_client = genai.Client(vertexai=True, project="my-project", location="my-location")

  response = genai_client.models.generate_content(
      model=retrieved_prompt.prompt_data.model,
      contents=retrieved_prompt.assemble_contents(),
  )

Mencantumkan perintah dan versi

Bagian ini menyajikan parameter dan contoh cara mencantumkan perintah dan versi perintah.

Ada dua metode: client.prompts.list dan client.prompts.list_versions.

Parameter

Tabel ini menjelaskan parameter yang digunakan oleh metode list:

Parameter

config

Opsional: Objek types.ListPromptsConfig yang merepresentasikan konfigurasi untuk mencantumkan perintah.

Tabel ini menjelaskan parameter yang digunakan oleh metode list_versions:

Parameter

prompt_id

Wajib: ID perintah untuk mencantumkan versi.

config

Opsional: Objek types.ListPromptsConfig yang merepresentasikan konfigurasi untuk mencantumkan versi perintah.

Metode list dan list_versions menampilkan Iterator objek types.PromptRef. PromptRef berisi referensi ke perintah.

Contoh

Untuk melihat ID dan model perintah untuk semua perintah yang disimpan di Google Cloud project Anda, gunakan metode list.

Contoh kode berikut menunjukkan cara mengambil PromptRef untuk semua perintah tersimpan dalam project saat ini:

  prompt_refs = list(client.prompts.list())

  # Get a prompt from the list
  prompt1 = client.prompts.get(prompt_id=prompt_refs[0].prompt_id)

Contoh kode berikut menunjukkan cara mencantumkan ID perintah dan versi untuk semua versi perintah yang disimpan dalam perintah:

  prompt_versions_metadata = client.prompts.list_versions(prompt_id="123456789")

  # Get a specific prompt version from the versions metadata list
  prompt1 = client.prompts.get_version(
      prompt_id=prompt_versions_metadata[0].prompt_id,
      version_id=prompt_versions_metadata[0].version_id
  )

Menghapus perintah

Bagian ini menyajikan parameter dan contoh cara menghapus perintah.

Ada dua metode: delete dan delete_version.

Parameter

Tabel ini menjelaskan parameter yang digunakan oleh metode delete:

Parameter

prompt_id

ID perintah yang akan dihapus.

config

Opsional: Objek types.DeletePromptConfig yang merepresentasikan konfigurasi untuk menghapus perintah.

Tabel ini menjelaskan parameter yang digunakan oleh metode delete_version:

Parameter

prompt_id

ID perintah yang akan dihapus versinya.

version_id

Versi perintah yang akan dihapus.

config

Opsional: Objek types.DeletePromptConfig yang merepresentasikan konfigurasi untuk menghapus versi perintah.

Contoh

Untuk menghapus perintah dan semua versinya, gunakan metode delete.

  client.prompts.delete(prompt_id=retrieved_prompt.prompt_id)

Untuk menghapus versi tertentu dari resource perintah, gunakan metode delete_version.

  client.prompts.delete_version(prompt_id=retrieved_prompt.prompt_id, version_id='your-version-id')

Memulihkan versi perintah

Bagian ini menyajikan parameter dan contoh cara memulihkan versi perintah.

Parameter

Tabel ini menjelaskan parameter yang digunakan oleh metode restore_version:

Parameter

prompt_id

ID untuk perintah tertentu.

version_id

Versi perintah yang akan dipulihkan.

config

Konfigurasi untuk memulihkan versi perintah.

Objek Prompt ditampilkan oleh metode restore_version.

Contoh

Resource perintah juga berisi histori versi yang menyimpan versi perintah yang disimpan sebelumnya. Anda dapat menggunakan metode restore_version() untuk memulihkan versi perintah yang lebih lama sebagai versi terbaru. Metode ini menampilkan objek Prompt.

  # Restore to prompt version id 1
  restored_prompt = client.prompts.restore_version(prompt_id=retrieved_prompt.prompt_id, version_id='1')

Langkah berikutnya

  • Untuk mempelajari lebih lanjut perintah yang mendukung panggilan fungsi, lihat Pengantar panggilan fungsi untuk mempelajari lebih lanjut.