Chat 앱 API

Chat 앱 API (Chatbot·Legacy Agent)

Chatbot 앱(chat 모드)과 Legacy Agent 앱(agent-chat 모드)은 메시지 보내기, 대화 관리, 파일 처리, 앱 설정 조회에 같은 엔드포인트를 공유해요. 스트리밍되는 답변만 다릅니다. Chatbot 앱은 답변을 message 이벤트로, Legacy Agent 앱은 agent_thought·agent_message 이벤트로 스트리밍하죠.

출처: 공식문서

인증, 베이스 URL, 엔드 유저 데이터를 스코프하는 `user` 필드는 [Get Started](/en/api-reference/guides/get-started)와 [End User Identity](/en/api-reference/guides/end-user-identity)에서 다뤄요.

메시지 보내고 답변 스트리밍하기

  • Send Chat Message: Chatbot 또는 Legacy Agent 앱에 쿼리를 보냅니다. blocking 모드는 완료되면 전체 답변을 돌려주고, Legacy Agent 앱은 스트리밍 모드만 지원해요.
  • Stop Chat Message Generation: 끝나기 전에 스트리밍 답변을 중단합니다.
  • Get Next Suggested Questions: 답변이 끝난 뒤 지금까지의 대화를 바탕으로 후속 질문을 제안해요.

대화 관리하기

API로 만든 대화는 앱의 웹 앱에서 시작된 대화와 격리되어 유지돼요.

파일 다루기

  • Upload File: Send Chat Message가 참조할 이미지·문서·오디오·비디오 파일을 업로드해요. 파일은 업로드한 엔드 유저에게 스코프됩니다.
  • Download File: 앱의 메시지에 속한 파일이라면 미리보기나 다운로드가 가능해요.
  • Get End User Info: 엔드 유저 ID(Upload File 응답의 created_by 같은 것)로 세부 정보를 조회해요.

음성을 텍스트로, 텍스트를 음성으로

  • Convert Audio to Text: 업로드한 오디오(MP3·M4A·WAV·AMR·MPGA, 최대 30MB)를 받아쓰기해, 엔드 유저가 타이핑 대신 말로 입력하게 해줘요.
  • Convert Text to Audio: 답변을 다시 음성으로 합성해요.

앱 정보와 설정 가져오기

  • Get App Info: 앱의 이름, 설명, 태그, 모드.
  • Get App Parameters: 호출이 inputs로 보내는 필드(이름·타입·기본값)와 앱의 기능 스위치—요청이나 클라이언트 UI를 만들 때의 기반이 돼요.
  • Get App Meta: 도구 아이콘과 그 밖의 설정 메타데이터.
  • Get App WebApp Settings: 웹 앱의 사이트 설정, 테마, 커스터마이즈 옵션.

피드백 수집하기

  • Submit Message Feedback: 엔드 유저가 답변을 like/dislike로 평가할 수 있고, 선택적으로 텍스트 코멘트를 달 수 있어요.
  • List App Feedbacks: 앱 전체에서 엔드 유저와 관리자 양쪽이 제출한 모든 피드백.

어노테이션 관리하기

어노테이션은 질문을 고정 답변과 짝지어, 새 응답을 생성하는 대신 그 답을 바로 돌려주는 기능이에요:

더 알아보기 (Learn more)