Class Registry

constructor

• new Registry(parent?: Registry): Registry

  Parameters

  • Optionalparent: Registry

  Returns Registry

apiStability

Optionalcontext

Readonlydotprompt

Optional Readonlyparent

getDynamicAction

• getDynamicAction(
      key: ParsedRegistryKey,
  ): Promise<
      | Action<
          z.ZodTypeAny,
          z.ZodTypeAny,
          z.ZodTypeAny,
          ActionRunOptions<any>,
      >
      | undefined,
  >

  Parameters

  • key: ParsedRegistryKey

  Returns Promise<
      | Action<
          z.ZodTypeAny,
          z.ZodTypeAny,
          z.ZodTypeAny,
          ActionRunOptions<any>,
      >
      | undefined,
  >

initializeAllPlugins

• initializeAllPlugins(): Promise<void>

  Initializes all plugins in the registry.

  Returns Promise<void>

initializePlugin

• initializePlugin(name: string): Promise<void | InitializedPlugin>

  Initializes a plugin already registered with registerPluginProvider.

  Parameters

  • name: string

    The name of the plugin to initialize.

  Returns Promise<void | InitializedPlugin>

  The plugin.

listActions

• listActions(): Promise<ActionsRecord>

  Returns all actions that have been registered in the registry.

  Returns Promise<ActionsRecord>

  All actions in the registry as a map of <key, action>.

listResolvableActions

• listResolvableActions(): Promise<ActionMetadataRecord>

  Returns all actions that are resolvable by plugins as well as those that are already in the registry.

  NOTE: this method should not be used in latency sensitive code paths. It may rely on "admin" API calls such as "list models", which may cause increased cold start latency.

  Returns Promise<ActionMetadataRecord>

  All resolvable action metadata as a map of <key, action metadata>.

listValues

• listValues<T>(type: string): Promise<Record<string, T>>

  Type Parameters

  • T

  Parameters

  • type: string

  Returns Promise<Record<string, T>>

lookupAction

• lookupAction<
      I extends z.ZodTypeAny,
      O extends z.ZodTypeAny,
      R extends Action<I, O, z.ZodTypeAny, ActionRunOptions<any>>,
  >(
      key: string,
  ): Promise<R>

  Looks up an action in the registry.

  Type Parameters

  • I extends z.ZodTypeAny
  • O extends z.ZodTypeAny
  • R extends Action<I, O, z.ZodTypeAny, ActionRunOptions<any>>

  Parameters

  • key: string

    The key of the action to lookup.

  Returns Promise<R>

  The action.

lookupBackgroundAction

• lookupBackgroundAction(
      key: string,
  ): Promise<
      | BackgroundAction<
          z.ZodTypeAny,
          z.ZodTypeAny,
          BackgroundActionRunOptions,
      >
      | undefined,
  >

  Looks up a background action from the registry.

  Parameters

  • key: string

    The key of the action to lookup.

  Returns Promise<
      | BackgroundAction<
          z.ZodTypeAny,
          z.ZodTypeAny,
          BackgroundActionRunOptions,
      >
      | undefined,
  >

  The action.

lookupPlugin

• lookupPlugin(name: string): PluginProvider | undefined

  Looks up a plugin.

  Parameters

  • name: string

    The name of the plugin to lookup.

  Returns PluginProvider | undefined

  The plugin provider.

lookupSchema

• lookupSchema(name: string): Schema | undefined

  Looks up a schema.

  Parameters

  • name: string

    The name of the schema to lookup.

  Returns Schema | undefined

  The schema.

lookupValue

• lookupValue<T = unknown>(type: string, key: string): Promise<T | undefined>

  Type Parameters

  • T = unknown

  Parameters

  • type: string
  • key: string

  Returns Promise<T | undefined>

registerAction

• registerAction<I extends z.ZodTypeAny, O extends z.ZodTypeAny>(
      type:
          | "custom"
          | "prompt"
          | "model"
          | "tool"
          | "dynamic-action-provider"
          | "embedder"
          | "evaluator"
          | "executable-prompt"
          | "flow"
          | "indexer"
          | "background-model"
          | "check-operation"
          | "cancel-operation"
          | "reranker"
          | "retriever"
          | "tool.v2"
          | "util"
          | "resource",
      action: Action<I, O>,
      opts?: { namespace?: string },
  ): void

  Registers an action in the registry.

  Type Parameters

  • I extends z.ZodTypeAny
  • O extends z.ZodTypeAny

  Parameters

  • type:
        | "custom"
        | "prompt"
        | "model"
        | "tool"
        | "dynamic-action-provider"
        | "embedder"
        | "evaluator"
        | "executable-prompt"
        | "flow"
        | "indexer"
        | "background-model"
        | "check-operation"
        | "cancel-operation"
        | "reranker"
        | "retriever"
        | "tool.v2"
        | "util"
        | "resource"

    The type of the action to register.

  • action: Action<I, O>

    The action to register.

  • Optionalopts: { namespace?: string }

  Returns void

registerActionAsync

• registerActionAsync<I extends z.ZodTypeAny, O extends z.ZodTypeAny>(
      type:
          | "custom"
          | "prompt"
          | "model"
          | "tool"
          | "dynamic-action-provider"
          | "embedder"
          | "evaluator"
          | "executable-prompt"
          | "flow"
          | "indexer"
          | "background-model"
          | "check-operation"
          | "cancel-operation"
          | "reranker"
          | "retriever"
          | "tool.v2"
          | "util"
          | "resource",
      name: string,
      action: PromiseLike<Action<I, O, z.ZodTypeAny, ActionRunOptions<any>>>,
      opts?: { namespace?: string },
  ): void

  Registers an action promise in the registry.

  Type Parameters

  • I extends z.ZodTypeAny
  • O extends z.ZodTypeAny

  Parameters

  • type:
        | "custom"
        | "prompt"
        | "model"
        | "tool"
        | "dynamic-action-provider"
        | "embedder"
        | "evaluator"
        | "executable-prompt"
        | "flow"
        | "indexer"
        | "background-model"
        | "check-operation"
        | "cancel-operation"
        | "reranker"
        | "retriever"
        | "tool.v2"
        | "util"
        | "resource"
  • name: string
  • action: PromiseLike<Action<I, O, z.ZodTypeAny, ActionRunOptions<any>>>
  • Optionalopts: { namespace?: string }

  Returns void

registerPluginProvider

• registerPluginProvider(name: string, provider: PluginProvider): void

  Registers a plugin provider. This plugin must be initialized before it can be used by calling initializePlugin or initializeAllPlugins.

  Parameters

  • name: string

    The name of the plugin to register.

  • provider: PluginProvider

    The plugin provider.

  Returns void

registerSchema

• registerSchema(name: string, data: Schema): void

  Registers a schema.

  Parameters

  • name: string

    The name of the schema to register.

  • data: Schema

    The schema to register (either a Zod schema or a JSON schema).

  Returns void

registerValue

• registerValue(type: string, name: string, value: any): void

  Parameters

  • type: string
  • name: string
  • value: any

  Returns void

resolveActionNames

• resolveActionNames(key: string): Promise<string[]>

  Parameters

  • key: string

  Returns Promise<string[]>

resolvePluginAction

• resolvePluginAction(
      pluginName: string,
      actionType:
          | "custom"
          | "prompt"
          | "model"
          | "tool"
          | "dynamic-action-provider"
          | "embedder"
          | "evaluator"
          | "executable-prompt"
          | "flow"
          | "indexer"
          | "background-model"
          | "check-operation"
          | "cancel-operation"
          | "reranker"
          | "retriever"
          | "tool.v2"
          | "util"
          | "resource",
      actionName: string,
  ): Promise<void>

  Resolves a new Action dynamically by registering it.

  Parameters

  • pluginName: string

    The name of the plugin

  • actionType:
        | "custom"
        | "prompt"
        | "model"
        | "tool"
        | "dynamic-action-provider"
        | "embedder"
        | "evaluator"
        | "executable-prompt"
        | "flow"
        | "indexer"
        | "background-model"
        | "check-operation"
        | "cancel-operation"
        | "reranker"
        | "retriever"
        | "tool.v2"
        | "util"
        | "resource"

    The type of the action

  • actionName: string

    The name of the action

  Returns Promise<void>

StaticwithParent

• withParent(parent: Registry): Registry

  Creates a new registry overlaid onto the provided registry.

  Parameters

  • parent: Registry

    The parent registry.

  Returns Registry

  The new overlaid registry.