0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/functions/requireTextOnlyEmbeddingInput.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

754 B

id title
requireTextOnlyEmbeddingInput requireTextOnlyEmbeddingInput

Function: requireTextOnlyEmbeddingInput()

function requireTextOnlyEmbeddingInput(
   input, 
   provider, 
   model): string[];

Defined in: packages/ai/src/utilities/embedding-input.ts:53

Extract plain text inputs for a text-only embedding model, throwing a uniform error if any item carries an image. The per-model modality typing rejects these at compile time; this guard covers untyped/dynamic callers.

Parameters

input

EmbeddingInputItem[]

provider

string

model

string

Returns

string[]