Panduan migrasi Agent Runtime SDK

Pada Agent Platform SDK versi 2.0.1, modul agent_engines dalam SDK telah di-refactor dan diganti namanya menjadi runtimes dalam paket agentplatform mandiri. Halaman ini menjelaskan perubahan utama pada modul dan cara memigrasikan kode yang ada ke struktur SDK baru. Untuk mengetahui informasi umum tentang Agent Runtime, lihat Ringkasan.

Perubahan penting

Secara umum, parameter klien layanan diinisialisasi berdasarkan per klien, dan klien berisi modul yang relevan untuk interaksi layanan. Yaitu:

import vertexai
from vertexai import agent_engines
vertexai.init(project=GCP_PROJECT, location=GCP_REGION)
agent_engines.create(...)

digantikan oleh

import agentplatform
# Mandatory for cross-project deployment and for use of the framework-specific templates.
client = agentplatform.Client(project=GCP_PROJECT, location=GCP_REGION)
client.runtimes.create(...)

Namespace berikut di SDK berada dalam fase penghentian penggunaan. Gunakan namespace yang setara dari SDK Agent Platform berbasis klien, yang memiliki paritas fitur penuh dengan modul dan paket yang tidak digunakan lagi.

Namespace lama	Kode yang terpengaruh	Penggantian (agentplatform)
vertexai.agent_engines	Metode yang terpengaruh: vertexai.agent_engines.create vertexai.agent_engines.get vertexai.agent_engines.list vertexai.agent_engines.update vertexai.agent_engines.delete	Penggantian: client.runtimes.create client.runtimes.get client.runtimes.list client.runtimes.update client.runtimes.delete
client.agent_engines	Metode yang terpengaruh: client.agent_engines.create_memory client.agent_engines.delete_memory client.agent_engines.generate_memories client.agent_engines.get_memory client.agent_engines.list_memories client.agent_engines.retrieve_memories client.agent_engines.create_session client.agent_engines.delete_session client.agent_engines.get_session client.agent_engines.list_sessions client.agent_engines.append_session_event client.agent_engines.list_session_events	Penggantian: client.memory_banks.memories.create client.memory_banks.memories.delete client.memory_banks.memories.generate client.memory_banks.memories.get client.memory_banks.memories.list client.memory_banks.memories.retrieve client.sessions.create client.sessions.delete client.sessions.get client.sessions.list client.sessions.events.append client.sessions.events.list

Bermigrasi ke desain berbasis klien

Bagian ini berisi cuplikan kode yang menunjukkan cara memigrasikan kode Agent Runtime yang ada ke desain SDK agentplatform. Catatan: Contoh dapat menghilangkan impor, dependensi, dan kode boilerplate lainnya untuk meningkatkan keterbacaan.

Membuat instance Agent Runtime

Sebelum

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
  staging_bucket=STAGING_BUCKET,
)
agent_engines.create(
    local_agent,
    requirements=REQUIREMENTS,
    extra_packages=EXTRA_PACKAGES,
    # ...
)

Setelah

import agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
client.runtimes.create(
    agent=local_agent,
    config={
        "staging_bucket": STAGING_BUCKET,
        "requirements": REQUIREMENTS,
        "extra_packages": EXTRA_PACKAGES,
        # ...
    },
)

Memperbarui instance Agent Runtime

Sebelum

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
  staging_bucket=STAGING_BUCKET,
)
agent_engines.update(
    resource_name,
    agent_engine=local_agent,
    requirements=REQUIREMENTS,
    extra_packages=EXTRA_PACKAGES,
    # ...
)

Setelah

import agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
client.runtimes.update(
    name=resource_name,
    agent=local_agent,
    config={
        "staging_bucket": STAGING_BUCKET,
        "requirements": REQUIREMENTS,
        "extra_packages": EXTRA_PACKAGES,
        # ...
    },
)

Mendapatkan instance Agent Runtime

Sebelum

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = agent_engines.get(resource_name)

Setelah

import agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
remote_agent = client.runtimes.get(name=resource_name)

Mencantumkan instance Agent Runtime

Sebelum

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = agent_engines.list()

Setelah

import agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
runtimes = client.runtimes.list()

Menghapus instance Agent Runtime

Sebelum

agent_engine.delete(
    force=True,  # Optional
)

Sebagai alternatif,

import vertexai
from vertexai import agent_engines
vertexai.init(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = agent_engines.delete(
    resource_name,  # Required.
    force=True,  # Optional
)

Setelah

remote_agent.delete(
    force=True,     # Optional.
)

Sebagai alternatif,

import agentplatform
client = agentplatform.Client(
  project=PROJECT,
  location=LOCATION,
)
remote_agent = client.runtimes.delete(
    name=resource_name,  # Required.
    force=True,          # Optional.
)