Interface EmbedCapability<TEmbedInput, TOutput>

Provider-agnostic embedding capability interface.

Providers that implement this interface can create embeddings for text or other data.

interface EmbedCapability<TEmbedInput = any, TOutput = any> {
    embed(
        req: AIRequest<TEmbedInput>,
        ctx: MultiModalExecutionContext,
        signal?: AbortSignal,
    ): Promise<AIResponse<TOutput>>;
}

Type Parameters

TEmbedInput = any
Input type for embedding
TOutput = any
Output type (vector or array of vectors)

Hierarchy (View Summary)

ProviderCapability
- EmbedCapability

Implemented by

Index

Methods

Methods

embed

embed(
    req: AIRequest<TEmbedInput>,
    ctx: MultiModalExecutionContext,
    signal?: AbortSignal,
): Promise<AIResponse<TOutput>>
Generate embeddings for the given input.
Parameters
- req: AIRequest<TEmbedInput>
  AIRequest containing embedding input
- ctx: MultiModalExecutionContext
  Execution context
- Optionalsignal: AbortSignal
  AbortSignal for request cancellation
Returns Promise<AIResponse<TOutput>>
AIResponse wrapping the embedding(s)
- Defined in src/core/provider/capabilities/EmbedCapability.ts:24