Completion 앱 API

Completion 앱 API (Text Generator)

Text Generator 앱은 completion 모드로 돌아요. 각 호출이 자기 입력 값을 제출하고 응답 하나를 받으며, 호출 사이에 대화 상태가 없습니다.

출처: 공식문서

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

텍스트 생성하기

  • Send Completion Message: 앱의 프롬프트 템플릿을 채우기 위해 inputs를 보내 응답을 생성해요. blocking 모드는 완료되면 전체 응답을 돌려주고, 스트리밍 모드는 message_end로 끝나는 message 이벤트를 전달하며, 앱에 텍스트-음성 자동 재생이 켜져 있으면 tts_message 이벤트도 함께 와요.
  • Stop Completion Message Generation: 끝나기 전에 스트리밍 응답을 중단합니다.

파일 다루기

  • Upload File: Send Completion 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)