챗봇의 Agent API (V2)
이 API의 Agent는 AIP Chatbot Studio에서 만든 AIP 챗봇입니다. 제품은 이전에 AIP Agent와 AIP Agent Studio로 불렸으며, API는 호환성을 위해 Agent라는 이름과 관련 식별자를 유지합니다.
챗봇 정보 조회
Get Agent는 RID와 버전에 해당하는 표시 메타데이터 및 애플리케이션 상태 변수 정의를 반환합니다. version을 생략하면 최신 게시 버전을 사용합니다. 게시 버전이 없을 때는 사용할 버전을 명시하거나 Chatbot Studio에서 게시해야 합니다.
| Agent 필드 | 내용 |
|---|---|
rid | 챗봇을 식별하는 Agent RID |
version | 조회한 버전 문자열 |
metadata | 표시 이름, 설명, 입력 안내 문구와 대화 시작 메시지 예시 |
parameters | 애플리케이션 상태 변수 ID에서 변수 정의로 연결되는 맵 |
rid, version, metadata는 필수 응답 필드이며 parameters는 선택 필드입니다.
변수 정의
변수는 애플리케이션 상태에서 구성합니다. 각 Parameter에는 필수 parameterType과 access, 선택적인 description이 있습니다.
parameterType.type | 정의 |
|---|---|
string | 문자열 변수. 선택적인 defaultValue로 기본값 지정 |
objectSet | 객체 집합 변수. expectedObjectTypes에 기대하는 객체 유형 ID 표시 |
access는 챗봇이 변수와 상호작용하는 READ_ONLY 또는 READ_WRITE 모드입니다. 변수 설명은 언제 해당 변수를 사용할지에 관한 문맥으로 챗봇 프롬프트에 주입됩니다. 이 메타데이터는 변수의 정의이며 개별 대화에 전달하는 실제 값과 구분합니다.
버전 문자열과 major/minor 구성 요소는 Agent Version API로 조회합니다.
여러 챗봇의 세션 목록
List Sessions For Agents는 호출자와 접근 가능한 Agent 사이의 세션 중 현재 클라이언트가 만든 세션을 최근 갱신 순으로 조회합니다. 다른 클라이언트가 만든 대화와 다른 사용자의 전체 대화 목록은 이 조회 범위가 아닙니다.
메타데이터 조회는 api:aip-agents-read, 여러 챗봇의 세션 목록 조회는 GET이지만 api:aip-agents-write OAuth 권한 범위를 요청합니다. 두 API는 미리보기 기능이므로 preview=true가 필요하며 언제든 변경되거나 제거될 수 있습니다.