챗봇별 세션 목록(List Sessions) (V2)

호출자와 지정한 Agent 사이의 대화 중 이 클라이언트가 생성한 세션을 최근 갱신순으로 조회합니다. 다른 클라이언트에서 만든 세션과 AIP Chatbot Studio에서 만든 세션은 포함하지 않습니다.

첫 요청에서는 pageToken을 생략합니다. 다음 페이지가 있으면 응답의 nextPageToken을 다음 요청의 pageToken으로 전달합니다. 접근 가능한 모든 Agent의 세션을 모아 조회하려면 별도의 List Sessions For Agents를 사용합니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

GET /api/v2/aipAgents/agents/{agentRid}/sessions

작업 식별자는 v2.listSessions입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:aip-agents-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`agentRid`	`string`	필수	AIP Chatbot Studio에서 만든 챗봇의 Agent RID입니다.	`ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1`

쿼리 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`pageSize`	`integer`	선택	요청할 페이지 크기입니다.
`pageToken`	`string`	선택	페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 `nextPageToken`을 `pageToken`으로 전달합니다.
`preview`	`boolean`	선택	미리보기 기능 사용을 활성화합니다.	`true`

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 ListSessionsResponse입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`data`	`list<Session>`	선택
`nextPageToken`	`string`	선택	다음 페이지를 요청할 때 `pageToken`에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.

`data`의 구조

배열 항목은 Session이며 자료형은 object입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`rid`	`string`	필수	대화 세션의 RID입니다.	`ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6`
`metadata`	`object`	필수	세션 메타데이터입니다.	응답 예시 참조
`agentRid`	`string`	필수	세션에 연결된 Agent의 RID입니다.
`agentVersion`	`string`	필수	세션에 연결한 Agent 버전입니다. 생성할 때 지정하며 생략하면 세션 생성 시점의 최신 게시 버전을 사용합니다.

`metadata`의 구조

이름	자료형	필수 여부	의미와 조건	예시 값
`title`	`string`	필수	세션 제목입니다.	`What is the status of my order?`
`createdTime`	`string (date-time)`	필수	세션 생성 시각입니다.	`2024-10-01T20:04:24.962583055Z`
`updatedTime`	`string (date-time)`	필수	세션의 마지막 갱신 시각입니다.	`2024-10-01T22:04:24.962583055Z`
`messageCount`	`integer`	필수	사용자 메시지와 챗봇 응답을 모두 센 메시지 수입니다. 완료된 대화 왕복 한 번은 두 메시지로 계산합니다.	`6`
`estimatedExpiresTime`	`string (date-time)`	필수	세션의 예상 만료 시각입니다. 만료한 세션에는 접근할 수 없으며 새 세션이 필요합니다. 새 대화 교환을 추가하면 만료 시각이 자동으로 연장됩니다.	`2024-10-02T22:04:24.962583055Z`

가상 챗봇 세션 목록의 응답 예시입니다.

{
  "data": [
    {
      "metadata": {
        "updatedTime": "2024-10-01T22:04:24.962583055Z",
        "estimatedExpiresTime": "2024-10-02T22:04:24.962583055Z",
        "messageCount": 6,
        "createdTime": "2024-10-01T20:04:24.962583055Z",
        "title": "What is the status of my order?"
      },
      "agentRid": "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1",
      "agentVersion": "1.0",
      "rid": "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름	오류 코드	HTTP	의미와 조건	추가 매개변수
`AgentNotFound`	`NOT_FOUND`	404	지정한 Agent를 찾을 수 없습니다.	`agentRid`

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions?preview=true"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions?preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListSessionsExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class ListSessionsExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions?preview=true");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions?preview=true`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions?preview=true" `
	-Headers $headers

$response.content

Keyboard shortcuts

팔란티어 플랫폼 한국어 해설