문서

클래스: TypeSafeClient

TypeSafe AI API용 클라이언트입니다.

생성자

생성자

new TypeSafeClient(config?): TypeSafeClient;

TypeSafe AI API용 클라이언트를 생성합니다.

명시적 옵션은 환경 변수보다 우선하며, 환경 변수는 SDK 기본값보다 우선합니다. 비어 있거나 공백만 있는 환경 변수 값은 무시됩니다.

매개변수

config?

TypeSafeClientConfig = {}

반환값

TypeSafeClient

예외

API 키가 없거나, 구성이 유효하지 않거나, 런타임이 지원되지 않는 경우입니다.

속성

baseURL

readonly baseURL: string;

끝의 슬래시를 제거한 API 루트입니다.


defaultHeaders

readonly defaultHeaders: Readonly<Record<string, string>>;

각 요청과 함께 전송되는 추가 헤더입니다.


defaultModel

readonly defaultModel: string;

요청이 model을 생략할 때 사용되는 모델입니다.


fetch

readonly fetch: Fetch;

HTTP fetch 구현입니다.


logger

readonly logger: Logger;

구성된 로거이며, logLevel로 필터링됩니다.


logLevel

readonly logLevel: LogLevel;

구성된 로그 상세 수준입니다.


models

readonly models: Models;

해당 계정에서 사용할 수 있는 모델입니다.


retry

readonly retry: RetryPolicy;

생성자 재정의가 적용된 재시도 설정입니다.


timeout

readonly timeout: number;

시도당 타임아웃(밀리초)입니다.

메서드

systemOne()

systemOne<Q>(request, options?): APIPromise<SystemOneResult<Q>>;

텍스트 또는 구조화된 상태에 대해 명명된 질문에 답합니다.

타입 매개변수

Q

Q 확장 Questions

매개변수

request

SystemOneRequest<Q>

상태, 질문, 그리고 선택적 모델 재정의입니다.

options?

RequestOptions = {}

호출별 타임아웃, 재시도, 헤더, 취소 설정입니다.

반환값

APIPromise<SystemOneResult<Q>>

질문 이름과 criteria로 타입이 지정된 답변이며, 모델과 토큰 사용량을 포함합니다.

예외

질문이 비어 있거나, score criteria가 최소 두 항목의 목록이 아닌 경우입니다.

예외

재시도 후에도 서버가 2xx가 아닌 응답을 반환한 경우입니다.

예외

재시도 후에도 연결할 수 없거나 요청이 타임아웃된 경우입니다.

예외

호출자가 요청을 중단한 경우입니다.

예시

const { answers } = await client.systemOne({
  state: "I was charged twice. Please help.",
  questions: { billing: noul("Is this about billing?") },
});
console.log(answers.billing.noul);