跳至主要內容

Mastra.getGatewayById()

依唯一 ID（gateway 執行個體的 id 屬性）取得 gateway。需要依本身的識別碼而非註冊鍵尋找 gateway 時，此方法非常有用。

使用範例
「使用範例」的直接連結

import { Mastra } from '@mastra/core'

const mastra = new Mastra({
  gateways: {
    customKey: new MyCustomGateway(), // id = 'my-custom-gateway'
  },
})

// Retrieve by ID (not registration key)
const gateway = mastra.getGatewayById('my-custom-gateway')
console.log(gateway.name) // 'My Custom Gateway'

使用情境
「使用情境」的直接連結

  • Gateway 版本控制：不同版本使用不同的唯一 ID ('gateway-v1', 'gateway-v2')
  • 在註冊鍵未知時尋找 gateway
  • 跨不同 Mastra 執行個體識別 gateway

參數
「參數」的直接連結

id:

string
gateway 的唯一 ID（gateway.id 屬性）

傳回值
「傳回值」的直接連結

gateway:

MastraModelGateway | undefined
gateway 執行個體；如果找不到，則為 undefined
On this page