Get Memory API

출처: 문서

본문

메모리 API 가져오기

2.12에서 도입됨 {: .label .label-purple }

이 API를 사용하여 대화형 검색을 위한 대화 메모리를 조회할 수 있어요.

메모리 정보를 조회하려면 다음을 사용할 수 있어요.

• ID로 메모리 가져오기.
• 모든 메모리 가져오기.

메모리에 대한 메시지 정보를 조회하려면 다음을 사용할 수 있어요.

• 메모리 내 모든 메시지 가져오기.
• 메모리 내 메시지 검색.

Security 플러그인이 활성화되면 모든 메모리는 private 보안 모드로 존재해요. 메모리를 생성한 사용자만 해당 메모리와 그 메시지와 상호 작용할 수 있어요. {: .important}

ID로 메모리 가져오기

memory_id를 사용하여 메모리 정보를 조회할 수 있어요. 응답에는 메모리 내의 모든 메시지가 포함돼요.

엔드포인트

GET /_plugins/_ml/memory/{memory_id}

경로 매개변수

다음 표는 사용 가능한 경로 매개변수를 나열해요.

예제 요청

GET /_plugins/_ml/memory/N8AE1osB0jLkkocYjz7D

{% include copy-curl.html %}

예제 응답

{
  "memory_id": "gW8Aa40BfUsSoeNTvOKI",
  "create_time": "2024-02-02T18:07:06.887061463Z",
  "updated_time": "2024-02-02T19:01:32.121444968Z",
  "name": "Conversation for a RAG pipeline",
  "user": "admin"
}

모든 메모리 가져오기

이 명령을 사용하여 모든 메모리를 가져와요.

엔드포인트

GET /_plugins/_ml/memory

쿼리 매개변수

다음 쿼리 매개변수를 사용하여 결과를 사용자 지정할 수 있어요. 모든 쿼리 매개변수는 선택 사항이에요.

결과 페이징

next_token 매개변수는 결과에 반환할 정렬된 메모리 목록에서 첫 번째 메모리의 순서 위치를 제공해요. 후속 GET Memory 호출 사이에 메모리가 추가되면 나열된 메모리 중 하나가 결과에 중복돼요. 예를 들어, 현재 정렬된 메모리 목록이 BCDEF이고 B가 가장 최근에 생성된 메모리라고 가정해요. next_token=0 및 max_results=3으로 Get Memory API를 호출하면 API는 BCD를 반환해요. 그런 다음 다른 메모리 A를 생성한다고 가정해요. 이제 메모리 목록은 ABCDEF로 나타나요. 다음에 next_token=3 및 max_results=3으로 Get Memory API를 호출하면 결과에 DEF가 수신돼요. D가 첫 번째 및 두 번째 결과 배치에서 반환된다는 점에 주목해요. 다음 다이어그램은 중복을 보여줘요.

예제 요청: 모든 메모리 가져오기

GET /_plugins/_ml/memory/

{% include copy-curl.html %}

예제 요청: 결과 페이징

GET /_plugins/_ml/memory?max_results=2&next_token=1

예제 응답

{
  "memories": [
    {
      "memory_id": "gW8Aa40BfUsSoeNTvOKI",
      "create_time": "2024-02-02T18:07:06.887061463Z",
      "updated_time": "2024-02-02T19:01:32.121444968Z",
      "name": "Conversation for a RAG pipeline",
      "user": "admin"
    }
  ]
}

응답 본문 필드

다음 표는 사용 가능한 응답 필드를 나열해요.

더 알아보기 (Learn more)

• 원문 전체: https://docs.opensearch.org/latest/ml-commons-plugin/api/memory-apis/get-memory/