개요

본 문서는 Timely 서비스에 통합되어 제공되는 Timely GPT AI 모듈의 기능과 사용법에 대한 상세 정보를 제공합니다. Timely GPT AI 모듈은 Timely 서비스 내에서 다양한 AI 기능을 활용할 수 있도록 설계되었으며, 사용자는 본 문서를 통해 모듈의 기능을 이해하고 실제 서비스에 적용하는 방법을 익힐 수 있습니다.

설치

cdn 주소

https://github.com/timely-hub/timely-chat/tree/master

사용

<script src="[<https://cdn.jsdelivr.net/gh/timely-hub/timely-chat@p.1.0.0/index.js>](<https://cdn.jsdelivr.net/gh/timely-hub/timely-chat@p.1.0.0/index.js>)"></script>

window.TimelyChat

사용자 인증

TimelyChat을 사용하기 위해서는 사용자 인증을 거쳐야 합니다. 인증을 통해 발급받은 엑세스 토큰은 TimelyChat 객체를 생성할 때 사용됩니다. 토큰은 24시간 후 만료됩니다.

CDN 사용 시

TimelyChat SDK에서 제공하는 getToken 함수를 직접 호출하여 토큰을 발급받을 수 있습니다.

const token: string = await TimelyChat.getToken({
	spaceRefId: "", 
	providerId: "",
	name: "",
	apiKey: "",
});

직접 호출

직접 API를 사용하여 호출합니다.

URL

staging : https://ai.stg.timelygpt.co.kr/api-back

production : https://ai.timelygpt.co.kr/api-back

// AUTH_API_URL =  
// staging : <https://ai.stg.timelygpt.co.kr/api-back>
// production : <https://ai.timelygpt.co.kr/api-back>
export const login = async (configs: {
  name: string;
  providerId: string;
  apiKey: string;
  spaceRefId: string;
}) => {
  const { apiKey, ...rest } = configs;
  const response = await fetch(`${AUTH_API_URL}/user/auth/login`, {
    method: "POST",
    body: JSON.stringify(rest),
    headers: {
      "x-api-key": apiKey,
      "Content-Type": "application/json",
    },
  });
  const result = await response.json();
  if (!result.success) {
    throw new Error("Failed to login");
  }
  return result.data as string;
};