Conversational Answer Generation API

POST

curl -X POST https://api.sidetalk.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{
    "message": "안녕하세요, 도움이 필요해요.",
    "stream": false,
    "sessionId": "test-session-id",
    "memberId": "user_123"
  }'

event: message
data: {"chunk":"안녕하세요, ","chat_log_uuid":"2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3"}

event: message
data: {"chunk":"무엇을 도와드릴까요?","chat_log_uuid":"2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3"}

data: [DONE]

event: showCard
data: {
  "schema": "sidetalk.card.v1",
  "cardType": "text",
  "displayMode": "carousel",
  "items": [
    {
      "type": "text",
      "title": "최근 주문 내역",
      "description": "주문번호 1234 / 결제완료",
      "buttons": [
        {
          "label": "상세 보기",
          "action": "user_utterance",
          "value": "주문 상세 보여줘"
        }
      ]
    }
  ]
}

event: inputForm
data: {
  "type": "showInputForm",
  "task_id": "task_101",
  "order": 1,
  "question": "예약 신청할게요.",
  "form_id": 101,
  "form_name": "예약 신청",
  "guide_message": "아래 정보를 입력해 주세요.",
  "field_list": [
    {
      "field_id": "customer_name",
      "field_label": "이름",
      "field_type": "text",
      "field_placeholder": "이름을 입력하세요",
      "field_default_value": "",
      "field_required_value": "1",
      "order_index": 1,
      "linked_column_id": "",
      "field_options": ""
    },
    {
      "field_id": "customer_phone",
      "field_label": "연락처",
      "field_type": "text",
      "field_placeholder": "010-0000-0000",
      "field_default_value": "",
      "field_required_value": "1",
      "order_index": 2,
      "linked_column_id": "",
      "field_options": ""
    }
  ],
  "executionHistory": [
    {
      "task_order": 1,
      "action_type": "showInputForm",
      "description": "입력폼 표시",
      "data": null
    }
  ],
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3"
}

event: reservationBookingForm
data: {
  "type": "reservationBookingForm",
  "form_id": "reservation_booking_request",
  "form_name": "예약 신청",
  "guide_message": "예약에 필요한 정보를 입력해 주세요.",
  "reservation_step": "customer_info",
  "field_list": [
    {
      "field_id": "customer_name",
      "field_label": "이름",
      "field_type": "text",
      "field_placeholder": "이름을 입력하세요",
      "field_required_value": "1"
    },
    {
      "field_id": "customer_phone",
      "field_label": "연락처",
      "field_type": "text",
      "field_placeholder": "010-0000-0000",
      "field_required_value": "1"
    }
  ],
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3"
}

event: reservationLookupForm
data: {
  "type": "reservationLookupForm",
  "form_id": "reservation_lookup_request",
  "form_name": "예약 조회",
  "guide_message": "예약번호를 입력해 주세요.",
  "field_list": [
    {
      "field_id": "reservation_no",
      "field_label": "예약번호",
      "field_type": "text",
      "field_placeholder": "예약번호를 입력하세요",
      "field_required_value": "1"
    }
  ],
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3"
}

event: pageRedirect
data: {
  "url": "https://example.com/reservation"
}

{
  "success": true,
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3",
  "message": {
    "content": "안녕하세요, 무엇을 도와드릴까요?"
  }
}

{
  "success": true,
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3",
  "message": {
    "content": ""
  },
  "extra": {
    "showCard": {
      "schema": "sidetalk.card.v1",
      "cardType": "text",
      "displayMode": "carousel",
      "items": [
        {
          "type": "text",
          "title": "최근 주문 내역",
          "description": "주문번호 1234 / 결제완료",
          "buttons": [
            {
              "label": "상세 보기",
              "action": "user_utterance",
              "value": "주문 상세 보여줘"
            }
          ]
        }
      ]
    }
  }
}

{
  "success": true,
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3",
  "message": {
    "content": "예약 입력이 필요합니다."
  },
  "extra": {
    "inputForm": {
      "type": "showInputForm",
      "task_id": "task_101",
      "order": 1,
      "question": "예약 신청할게요.",
      "form_id": 101,
      "form_name": "예약 신청",
      "guide_message": "아래 정보를 입력해 주세요.",
      "field_list": [
        {
          "field_id": "customer_name",
          "field_label": "이름",
          "field_type": "text",
          "field_placeholder": "이름을 입력하세요",
          "field_default_value": "",
          "field_required_value": "1",
          "order_index": 1,
          "linked_column_id": "",
          "field_options": ""
        },
        {
          "field_id": "customer_phone",
          "field_label": "연락처",
          "field_type": "text",
          "field_placeholder": "010-0000-0000",
          "field_default_value": "",
          "field_required_value": "1",
          "order_index": 2,
          "linked_column_id": "",
          "field_options": ""
        }
      ],
      "executionHistory": [
        {
          "task_order": 1,
          "action_type": "showInputForm",
          "description": "입력폼 표시",
          "data": null
        }
      ],
      "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3"
    }
  }
}

{
  "success": true,
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3",
  "message": {
    "content": "예약 입력이 필요합니다."
  },
  "extra": {
    "reservationBookingForm": {
      "type": "reservationBookingForm",
      "form_id": "reservation_booking_request",
      "form_name": "예약 신청",
      "guide_message": "예약에 필요한 정보를 입력해 주세요.",
      "reservation_step": "customer_info",
      "field_list": [
        {
          "field_id": "customer_name",
          "field_label": "이름",
          "field_type": "text",
          "field_placeholder": "이름을 입력하세요",
          "field_required_value": "1"
        },
        {
          "field_id": "customer_phone",
          "field_label": "연락처",
          "field_type": "text",
          "field_placeholder": "010-0000-0000",
          "field_required_value": "1"
        }
      ]
    }
  }
}

{
  "success": true,
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3",
  "message": {
    "content": "예약 조회가 필요합니다."
  },
  "extra": {
    "reservationLookupForm": {
      "type": "reservationLookupForm",
      "form_id": "reservation_lookup_request",
      "form_name": "예약 조회",
      "guide_message": "예약번호를 입력해 주세요.",
      "field_list": [
        {
          "field_id": "reservation_no",
          "field_label": "예약번호",
          "field_type": "text",
          "field_placeholder": "예약번호를 입력하세요",
          "field_required_value": "1"
        }
      ]
    }
  }
}

{
  "success": true,
  "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3",
  "message": {
    "content": "예약 페이지로 이동합니다."
  },
  "extra": {
    "pageRedirect": {
      "url": "https://example.com/reservation"
    }
  }
}

https://api.sidetalk.ai/v1/chat/feedback

POST

curl -X POST https://api.sidetalk.ai/v1/chat/feedback \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{
    "session_id": "test-session-id",
    "chat_log_uuid": "2b9cc8fb-3cc6-4d40-aef6-d44af3d074f3",
    "chat_log_feedback": "1"
  }'

{
  "success": true,
  "updated": true,
  "already_saved": false,
  "feedback": "1"
}

function sendMessage(message) {
    const apiUrl = "https://api.sidetalk.ai/v1/chat/completions";
    const requestData = {
        "message": message,
        "stream": true // 없는 경우 기본값 false로 설정됩니다.
    };

    fetch(apiUrl, {
        method: "POST",
        headers: {
            "Content-Type": "application/json",
            "Authorization": "Bearer [API_KEY]"
        },
        body: JSON.stringify(requestData),
    })
    .then(async response => {
        // HTTP 상태 코드 확인
        if (!response.ok) {
            const errorData = await response.json();
            console.error("Server Error:", errorData.message || 'Unknown error');
            return;
        }

        if (!response.body) throw new Error("ReadableStream not supported in response.");

        const reader = response.body.getReader();
        const decoder = new TextDecoder();

        function readStream() {
            return reader.read().then(({ done, value }) => {
                if (done) {
                    console.log("Stream complete.");
                    return;
                }

                const chunk = decoder.decode(value, { stream: true });
                const messages = chunk.split("\n\n");

                messages.forEach(message => {
                    if (message.startsWith("data: ")) {
                        const dataStr = message.replace("data: ", "");

                        if (dataStr === "[DONE]") {
                            console.log("Stream finished with [DONE] signal.");
                            reader.cancel();
                            return;
                        }

                        try {
                            const data = JSON.parse(dataStr);

                            // 서버에서 success: false를 보내는 경우 오류 처리
                            if (data.success === false) {
                                console.error("Error from server:", data.message || 'Unknown error');
                                reader.cancel();
                                return;
                            }

                            if (data.chunk) {
                                console.log("Chunk received:", data.chunk);
                                // 응답 처리 로직 추가
                            }

                            if (data.outsideData) {
                                console.log("Outside data received:", data.outsideData);
                                // 추가 데이터 처리 로직 추가
                            }
                        } catch (error) {
                            console.error("Error parsing JSON:", error);
                        }
                    }
                });

                return readStream();
            });
        }

        return readStream();
    })
    .catch(error => {
        console.error("Error receiving stream:", error);
    });
}

async function sendMessage(message) {
  const response = await fetch("https://api.sidetalk.ai/v1/chat/completions", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer [API_KEY]"
    },
    body: JSON.stringify({
      message,
      stream: false,
      sessionId: "test-session-id",
      memberId: "user_123"
    })
  });

  const data = await response.json();

  if (!response.ok || !data.success) {
    console.error("Server Error:", data.message || data.error || "Unknown error");
    return;
  }

  console.log("AI 답변:", data.message.content);
  console.log("chat_log_uuid:", data.chat_log_uuid);

  return {
    answer: data.message.content,
    chatLogUuid: data.chat_log_uuid
  };
}

async function sendMessageStream(message) {
  const response = await fetch("https://api.sidetalk.ai/v1/chat/completions", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer [API_KEY]"
    },
    body: JSON.stringify({
      message,
      stream: true,
      sessionId: "test-session-id"
    })
  });

  if (!response.ok) {
    const errorData = await response.json();
    console.error("Server Error:", errorData.message || errorData.error || "Unknown error");
    return;
  }

  if (!response.body) {
    throw new Error("ReadableStream not supported in response.");
  }

  const reader = response.body.getReader();
  const decoder = new TextDecoder();
  let savedChatLogUuid = "";

  while (true) {
    const { done, value } = await reader.read();
    if (done) break;

    const chunkText = decoder.decode(value, { stream: true });
    const blocks = chunkText.split("\n\n");

    for (const block of blocks) {
      if (!block.trim()) continue;

      const lines = block.split("\n");
      let eventName = "message";
      const dataLines = [];

      for (const line of lines) {
        if (line.startsWith("event:")) {
          eventName = line.replace("event:", "").trim();
        }
        if (line.startsWith("data:")) {
          dataLines.push(line.replace("data:", "").trimStart());
        }
      }

      const dataStr = dataLines.join("\n").trim();
      if (!dataStr) continue;

      if (dataStr === "[DONE]") {
        console.log("Stream finished.");
        return savedChatLogUuid;
      }

      try {
        const data = JSON.parse(dataStr);

        if (eventName === "message" && data.chunk) {
          console.log("Chunk:", data.chunk);
        }

        if (data.chat_log_uuid && !savedChatLogUuid) {
          savedChatLogUuid = data.chat_log_uuid;
          console.log("chat_log_uuid:", savedChatLogUuid);
        }

        if (eventName === "showCard") {
          console.log("Show card payload:", data);
        }

        if (eventName === "inputForm") {
          console.log("Input form payload:", data);
        }

        if (eventName === "pageRedirect") {
          console.log("Redirect payload:", data);
        }
      } catch (error) {
        console.error("Error parsing stream JSON:", error);
      }
    }
  }

  return savedChatLogUuid;
}

async function sendFeedback({ sessionId, chatLogUuid, isHelpful }) {
  const feedbackValue = isHelpful ? "1" : "2";

  const response = await fetch("https://api.sidetalk.ai/v1/chat/feedback", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer [API_KEY]"
    },
    body: JSON.stringify({
      session_id: sessionId,
      chat_log_uuid: chatLogUuid,
      chat_log_feedback: feedbackValue
    })
  });

  const data = await response.json();

  if (!response.ok || !data.success) {
    console.error("Feedback Error:", data.error || data.message || "Unknown error");
    return null;
  }

  console.log("Feedback saved:", data);
  return data;
}

{
  "success": false,
  "message": "서버 오류가 발생했습니다.",
  "error": "오류 메시지 내용"
}

{
  "success": false,
  "error": "chat_log_feedback must be 1 or 2"
}