챗봇 Agent 정보 조회(Get Agent) (V2)

AIP Chatbot Studio에서 만든 챗봇의 메타데이터와 애플리케이션 상태 변수 정의를 조회합니다. API는 호환성을 위해 Agent라는 이름을 유지합니다.

version을 생략하면 최신 게시 버전을 반환합니다. 게시된 버전이 없으면 NoPublishedAgentVersion이 발생하므로 특정 버전을 명시하거나 챗봇을 게시해야 합니다.

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

HTTP 요청

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

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

경로 매개변수

쿼리 매개변수

요청 본문

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

응답

응답 형식은 Agent입니다. parameters는 변수 정의의 맵이며 parameterType.type은 string 또는 objectSet입니다. access는 챗봇이 변수에 접근하는 모드입니다.

metadata의 구조

parameters의 구조

맵의 키는 ParameterId(string), 값은 Parameter(object)입니다.

키: AIP Chatbot Studio에서 구성한 애플리케이션 상태 변수의 고유 식별자입니다.

AIP Chatbot Studio의 애플리케이션 상태 변수 정의입니다.

parameterType의 구조

분기 string

분기 objectSet

expectedObjectTypes의 구조

배열 항목은 ObjectTypeId이며 자료형은 string입니다.

Ontology Manager에서 확인할 수 있는 객체 유형의 고유 ID입니다.

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

{
  "metadata": {
    "displayName": "Supply Chain Support Agent",
    "suggestedPrompts": [
      "What is the status of my order?",
      "How do I track my shipment?"
    ],
    "description": "An intelligent assistant to help answer questions about supply chain operations.",
    "inputPlaceholder": "Ask about supply chain operations..."
  },
  "rid": "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1",
  "version": "1.0",
  "parameters": {
    "customerName": {
      "access": "READ_ONLY",
      "description": "The name of the customer to answer supply chain-related questions for.",
      "parameterType": {
        "type": "string"
      }
    }
  }
}

개별 오류

요청 예제

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?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?preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

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

$response.content