Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

챗봇 버전 상세 조회(Get Agent Version) (V2)

Agent RID와 majorVersion.minorVersion 형식의 버전 문자열로 버전의 구성 요소를 조회합니다. 챗봇의 표시 메타데이터와 변수 정의를 얻는 Get Agent와 반환 내용이 다릅니다.

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

HTTP 요청

GET /api/v2/aipAgents/agents/{agentRid}/agentVersions/{agentVersionString}

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
agentRidstring필수AIP Chatbot Studio에서 만든 챗봇의 Agent RID입니다.ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1
agentVersionStringstring필수majorVersion.minorVersion 형식의 Agent 버전 문자열입니다.1.0

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
previewboolean선택미리보기 기능 사용을 활성화합니다.true

요청 본문

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

응답

응답 형식은 AgentVersion입니다.

이름자료형필수 여부의미와 조건예시 값
stringstring필수majorVersion.minorVersion 형식의 Agent 버전 문자열입니다.1.0
versionobject필수Agent 버전의 major 및 minor 구성 요소입니다.응답 예시 참조

version의 구조

이름자료형필수 여부의미와 조건예시 값
majorinteger필수게시할 때마다 증가하는 major 버전입니다.1
minorinteger필수저장할 때마다 증가하는 minor 버전입니다.0

가상 챗봇 버전의 응답 예시입니다.

{
  "string": "1.0",
  "version": {
    "major": 1,
    "minor": 0
  }
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
InvalidAgentVersionINVALID_ARGUMENT400지정한 문자열이 Agent 버전 형식에 맞지 않습니다.agentRid, version
NoPublishedAgentVersionINVALID_ARGUMENT400게시된 버전이 없어 최신 게시 버전을 조회할 수 없습니다. Chatbot Studio에서 게시하거나 사용할 버전을 명시합니다.agentRid
AgentVersionNotFoundNOT_FOUND404지정한 Agent 버전을 찾을 수 없습니다.agentRid, agentVersionString
AgentNotFoundNOT_FOUND404지정한 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/agentVersions/1.0?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/agentVersions/1.0?preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetAgentVersionExample.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 GetAgentVersionExample {
    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/agentVersions/1.0?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/agentVersions/1.0?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/agentVersions/1.0?preview=true" `
	-Headers $headers

$response.content