メインコンテンツへ移動

Mastra.addGateway()

Mastra インスタンスに Gateway を動的に追加します。初期化中にも、初期化後にも使用できます。

使用例
使用例への直接リンク

import { Mastra } from '@mastra/core'

const mastra = new Mastra()

// Add with explicit key
mastra.addGateway(new MyCustomGateway(), 'myGateway')

// Add using gateway's ID as the key
mastra.addGateway(new MyCustomGateway())
// Stored with key 'my-custom-gateway' (the gateway's id)

パラメータ
パラメータへの直接リンク

gateway:

MastraModelGateway
追加する Gateway インスタンス

key?:

string
任意の登録キー。指定しない場合は gateway.getId() を使用します

戻り値
戻り値への直接リンク

なし。Gateway が内部レジストリに追加されます。

動作
動作への直接リンク

  • 同じキーの Gateway がすでに存在する場合、追加はスキップされます
  • 開発モード(MASTRA_DEV=true)では、カスタム Gateway の型生成が自動的に開始されます
  • Gateway はモデル解決にすぐ使用できるようになります