Mengambil kenangan

Halaman ini menjelaskan cara mengambil kenangan yang dibuat dan diupload dari Bank Memori. Untuk seluruh alur kerja dalam mengonfigurasi, membuat, dan menggunakan Bank Memori, lihat Panduan memulai dengan REST API.

Anda memiliki opsi berikut untuk mengambil kenangan yang dibuat:

Sebelum memulai

Untuk menyelesaikan langkah-langkah yang ditunjukkan di halaman ini, Anda harus terlebih dahulu mengikuti langkah-langkah di Menyiapkan Memory Bank.

Dapatkan kenangan

Gunakan GetMemories untuk mendapatkan konten lengkap dari satu kenangan:

memory = client.agent_engines.get_memory(name="MEMORY_NAME")

Ganti kode berikut:

  • MEMORY_NAME: Nama memori yang sepenuhnya memenuhi syarat dalam format "projects/.../locations/.../reasoningEngines/.../memories...".

Mencantumkan kenangan

Gunakan ListMemories untuk mengambil semua kenangan di Bank Memori Anda.

pager = client.agent_engines.list_memories(name=agent_engine.api_resource.name)
for page in pager:
  print(page)

Mengambil kenangan menggunakan pengambilan berbasis cakupan

Anda dapat menggunakan RetrieveMemories untuk mengambil kenangan untuk cakupan tertentu. Hanya kenangan yang memiliki cakupan yang sama persis (terlepas dari urutan) dengan permintaan pengambilan yang ditampilkan. Misalnya, Anda dapat mengambil semua kenangan yang dicakup ke pengguna tertentu dengan menggunakan {"user_id": "123"}. Jika tidak ada kenangan yang ditampilkan, Bank Kenangan tidak memiliki kenangan untuk cakupan yang diberikan.

Cakupan memori ditentukan saat memori dibuat atau dihasilkan dan bersifat tetap.

Anda dapat menggunakan RetrieveMemories untuk melakukan operasi berikut untuk cakupan tertentu:

Untuk kasus saat Anda memiliki banyak kenangan untuk cakupan tertentu, Anda dapat menggunakan penelusuran kesamaan untuk mengambil hanya kenangan yang paling mirip dengan memberikan parameter penelusuran kesamaan. Bank Memori hanya mempertimbangkan kenangan yang memiliki cakupan yang sama persis dengan permintaan saat melakukan penelusuran kemiripan. Penelusuran kemiripan membandingkan vektor embedding antara fakta memori dan kueri penelusuran permintaan.

Memori yang ditampilkan diurutkan dari yang paling mirip (jarak Euclidean terpendek) hingga yang paling tidak mirip (jarak Euclidean terpanjang):

results = client.agent_engines.retrieve_memories(
    name=agent_engine.api_resource.name,
    scope=SCOPE,
    similarity_search_params={
        "search_query": "QUERY",
        # Optional. Defaults to 3.
        "top_k": 3
    }
)
# RetrieveMemories returns a pager. You can use `list` to retrieve all memories.
list(results)

"""
Returns:

[
    RetrieveMemoriesResponseRetrievedMemory(
      memory=Memory(
        name="projects/.../locations/.../reasoningEngines/.../memories/...",
        ...
        fact="This is a fact."
      },
      distance=0.5
    ),
    RetrieveMemoriesResponseRetrievedMemory(
      memory=Memory(
        name="projects/.../locations/.../reasoningEngines/.../memories/...",
        ...
        fact="This is another fact."
      },
      distance=0.7
    ),
]
"""

Ganti kode berikut:

  • QUERY: Kueri yang akan dilakukan penelusuran kesamaannya. Misalnya, Anda dapat menggunakan giliran pengguna terakhir dalam percakapan sebagai kueri.

  • SCOPE: Kamus, yang mewakili cakupan untuk penelusuran kemiripan. Contoh, {"user_id": "123"}. Hanya kenangan dengan cakupan yang sama dengan permintaan yang dipertimbangkan.

Mengambil semua kenangan

Jika tidak ada parameter penelusuran kesamaan yang diberikan, RetrieveMemories akan menampilkan semua kenangan yang memiliki cakupan yang diberikan, terlepas dari kesamaannya dengan percakapan saat ini.

results = client.agent_engines.retrieve_memories(
    name=agent_engine.api_resource.name,
    scope=SCOPE
)
# RetrieveMemories returns a pager. You can use `list` to retrieve all pages' memories.
list(results)

"""
Returns:

[
    RetrieveMemoriesResponseRetrievedMemory(
      memory=Memory(
        name="projects/.../locations/.../reasoningEngines/.../memories/...",
        ...
        fact="This is a fact."
      }
    ),
    RetrieveMemoriesResponseRetrievedMemory(
      memory=Memory(
        name="projects/.../locations/.../reasoningEngines/.../memories/...",
        ...
        fact="This is another fact."
      }
    ),
]
"""

Ganti kode berikut:

  • SCOPE: Kamus yang mewakili cakupan pengambilan. Contoh, {"user_id": "123"}. Hanya kenangan dengan cakupan yang sama dengan permintaan yang ditampilkan.