Skip to main content

Interface: EmbedTextOptions

Defined in: packages/agentos/src/api/embedText.ts:40

Options for an embedText call.

At minimum, input must be provided. Provider/model resolution follows the same rules as generateText: supply provider, model (the combined provider:model string is also accepted), or rely on env-var auto-detection.

Example​

const opts: EmbedTextOptions = {
  provider: 'openai',
  model: 'text-embedding-3-small',
  input: ['Hello world', 'Goodbye world'],
  dimensions: 256,
};

Properties​

apiKey?​

optional apiKey: string

Defined in: packages/agentos/src/api/embedText.ts:79

Override the API key instead of reading from environment variables.

baseUrl?​

optional baseUrl: string

Defined in: packages/agentos/src/api/embedText.ts:82

Override the provider base URL (useful for local proxies or Ollama).

dimensions?​

optional dimensions: number

Defined in: packages/agentos/src/api/embedText.ts:76

Desired output dimensionality. Only honoured by models that support dimension reduction (e.g. OpenAI text-embedding-3-* with dimensions). Ignored when the model has a fixed output size.

input​

input: string | string[]

Defined in: packages/agentos/src/api/embedText.ts:69

Text(s) to embed. Pass a single string for one embedding or an array for batch processing.

Example​

// Single input
input: 'Hello world'
// Batch input
input: ['Hello world', 'Goodbye world']

model?​

optional model: string

Defined in: packages/agentos/src/api/embedText.ts:55

Model identifier. Prefer the plain model name with provider set; the combined "provider:model" string is also accepted.

Example​

`"text-embedding-3-small"` (with `provider: 'openai'`), `"nomic-embed-text"`

provider?​

optional provider: string

Defined in: packages/agentos/src/api/embedText.ts:47

Provider name. When supplied without model, the default embedding model for the provider is resolved automatically from the built-in defaults.

Example​

`"openai"`, `"ollama"`, `"openrouter"`

usageLedger?​

optional usageLedger: AgentOSUsageLedgerOptions

Defined in: packages/agentos/src/api/embedText.ts:85

Optional durable usage ledger configuration for helper-level accounting.