TypeScript SDK: サードパーティ インテグレーション ガイド

weave.wrapOpenAI(new OpenAI());

​

TypeScript project で Weave インテグレーションを使用する

​

どのタイプの project かわからない場合

npx tsx test.ts

"type": "module"

• type が "module" の場合、project は ESM を使用します。
• type フィールドが存在しないか "commonjs" に設定されている場合、project はデフォルトで CommonJS を使用します。

​

CommonJS project を設定する

1. package.json を作成または更新します。
   {
     "type": "commonjs"
   }
   
2. CommonJS と互換性のある設定で tsconfig.json を作成します。
   {
     "compilerOptions": {
       "module": "CommonJS",
       "target": "es2022",
       "rootDir": ".",
       "outDir": "dist"
     }
   }
   
   これらの設定により、TypeScript は CommonJS 向けにコンパイルするようになります。
   • module: "CommonJS"。モジュールを CommonJS 形式 (require または module.exports) にコンパイルします。 このコンパイラーオプションの詳細については、TypeScript - Module を参照してください。
   • target: "es2022" (推奨)。最近の Node.js バージョンと互換性のあるモダンな JavaScript を出力します。 このコンパイラーオプションの詳細については、TypeScript - Target を参照してください。
   • rootDir: "."。tsconfig.json を含むディレクトリを入力ファイルのルートとして扱います。TypeScript はこれを outDir と組み合わせて使用し、ソースフォルダーの構成を出力先にそのまま反映します。 このコンパイラーオプションの詳細については、TypeScript - Root Dir を参照してください。
   • outDir: "dist"。生成された JavaScript やその他のコンパイラー出力を dist フォルダーに書き込みます。 このコンパイラーオプションの詳細については、TypeScript - Out Dir を参照してください。
3. Weave とその他の必要なライブラリをインストールします。
   npm install weave
   
4. TypeScript ファイルをコンパイルします。 サンプルファイル test.ts の場合:
   npx tsc
   
   これにより、ファイルが dist/test.js にコンパイルされます。
5. コンパイルしたファイルを Node.js で実行します。
   node dist/test.js
   

​

ESM project を設定する

1. package.json を作成または更新します。
   {
     "type": "module"
   }
   
2. Node 互換の ESM 設定を含む tsconfig.json を作成します。
   {
     "compilerOptions": {
       "module": "nodenext",
       "moduleResolution": "nodenext",
       "target": "es2022",
       "rootDir": ".",
       "outDir": "dist"
     }
   }
   
   これらの設定により、TypeScript は最新の Node.js ESM 向けにコンパイルを行います。
   • module: "nodenext"：Node.js ESM のセマンティクスに従ってモジュールをコンパイルします。 このコンパイラーオプションの詳細については、TypeScript - Module を参照してください。
   • moduleResolution: "nodenext"：モジュール解決が Node.js ESM のルールに従うようにします。 このコンパイラーオプションの詳細については、TypeScript - Module Resolution を参照してください。
   • target: "es2022" (推奨) ：最近の Node.js バージョンと互換性のあるモダンな JavaScript を出力します。 このコンパイラーオプションの詳細については、TypeScript - Target を参照してください。
   • rootDir: "."：tsconfig.json を含むディレクトリを入力ファイルのルートとして扱います。TypeScript はこの設定と outDir を組み合わせて、ソースのフォルダー構成を出力先に再現します。 このコンパイラーオプションの詳細については、TypeScript - Root Dir を参照してください。
   • outDir: "dist"：生成された JavaScript やその他のコンパイラーの出力を dist フォルダーに書き込みます。 このコンパイラーオプションの詳細については、TypeScript - Out Dir を参照してください。
3. Weave と、その他の必要なライブラリをインストールします。
   npm install weave
   
4. TypeScript ファイルをコンパイルします。 サンプルファイル test.ts の場合:
   npx tsc
   
   これにより、ファイルが dist/test.js にコンパイルされます。
5. Weave のインストルメンテーションをプリロードして、コンパイル済みファイルを Node.js で実行します。
   node --import=weave/instrument dist/test.js
   

​

高度な使い方とトラブルシューティング

​

NODE_OPTIONS を使用する (ESM のみ)

export NODE_OPTIONS="--import=weave/instrument"

​

バンドラーとの互換性

1. バンドラーの設定で、LLM ライブラリを外部モジュールとして指定します。これにより、バンドラーがこれらのライブラリをバンドルしなくなるため、Weave が実行時に正しくパッチを適用できるようになります。 次の例は、next.config.js の設定で openai パッケージを外部モジュールとして指定し、バンドラーによってバンドルされないようにする方法を示しています。モジュールは実行時に読み込まれるため、Weave が自動的にパッチを適用してトラッキングできます。Next.js などのフレームワークで自動インストルメンテーションを有効にするには、この設定を使用してください。
   externals: {
   'openai': 'commonjs openai'
   }
   
2. それでもパッチの適用に失敗する場合は、手動インストルメンテーションに切り替えてください。

​

手動パッチ適用 (フォールバック)

import { wrapOpenAI } from 'weave';
const client = wrapOpenAI(new OpenAI());