Panduan migrasi Agent Runtime SDK

Di Vertex AI SDK versi v1.112.0, modul agent_engines dalam Vertex AI SDK for Python telah difaktorkan ulang ke desain berbasis klien. Halaman ini menjelaskan perubahan utama pada modul dan cara memigrasikan kode yang ada ke desain berbasis klien. Untuk mengetahui informasi umum tentang Agent Runtime, lihat Ringkasan.

Perubahan penting

Pada tingkat tinggi, parameter klien layanan diinisialisasi 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(...)

diganti dengan

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

Namespace berikut untuk Agent Runtime di Vertex AI SDK berada dalam fase penghentian. Gunakan namespace yang setara dari Vertex AI SDK berbasis klien, yang memiliki paritas fitur lengkap dengan modul dan paket yang tidak digunakan lagi.

Namespace Vertex AI SDK Kode yang terpengaruh Penggantian Vertex AI SDK berbasis klien
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.agent_engines.create
  • client.agent_engines.get
  • client.agent_engines.list
  • client.agent_engines.update
  • client.agent_engines.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.agent_engines.memories.create
  • client.agent_engines.memories.delete
  • client.agent_engines.memories.generate
  • client.agent_engines.memories.get
  • client.agent_engines.memories.list
  • client.agent_engines.memories.retrieve
  • client.agent_engines.sessions.create
  • client.agent_engines.sessions.delete
  • client.agent_engines.sessions.get
  • client.agent_engines.sessions.list
  • client.agent_engines.sessions.events.append
  • client.agent_engines.sessions.events.list

Bermigrasi ke desain berbasis klien

Bagian ini berisi cuplikan kode yang menunjukkan cara memigrasikan kode Agent Runtime yang ada ke desain berbasis klien. Catatan: Contoh ini 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 vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
client.agent_engines.create(
    agent=local_agent,
    config={
        "staging_bucket": STAGING_BUCKET,
        "requirements": REQUIREMENTS,
        "extra_packages": EXTRA_PACKAGES,
        # ...
    },
)

Mengupdate 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 vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
client.agent_engines.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 vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = client.agent_engines.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 vertexai
client = vertexai.Client(
  project=PROJECT,
  location=LOCATION,
)
agent_engine = client.agent_engines.list()

Menghapus instance Agent Runtime

Sebelum

agent_engine.delete(
    force=True,  # Optional
)

Atau, py 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

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

Atau, py import vertexai client = vertexai.Client( project=PROJECT, location=LOCATION, ) agent_engine = client.agent_engines.delete( name=resource_name, # Required. force=True, # Optional. )