クラス：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 extends Questions

パラメーター

request

SystemOneRequest<Q>

状態、質問、および任意のモデル上書き。

options?

RequestOptions = {}

呼び出しごとのタイムアウト、リトライ、ヘッダー、キャンセルの設定。

戻り値

APIPromise<SystemOneResult<Q>>

質問名と criteria で型付けされた答え。モデルと token 使用量を伴います。

スロー

質問が空か、score の criteria が 2 項目以上のリストではありません。

スロー

リトライ後もサーバーが非 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);