embeddings
Convert text into numeric vectors for similarity scoring and ranking. Use with vector similarity or rerank operations to compare documents or queries.
Instructions
Generate one embedding vector per input string (a single string or a list of strings). The default text.hash_embedding_v1 model produces deterministic lexical hash embeddings — identical input always yields the identical vector; provider-backed embedding models advertised by list_models are routed through the configured provider service. Use embedding_similarity to score two vectors or rerank to order documents against a query vector. Read-only; nothing is stored. Returns one {index, embedding, token_count} item per input plus total token usage. An unsupported model id fails with model_not_supported.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| input | Yes | Text to embed: one string, or a list embedded item by item. | |
| model | No | Embedding model id from list_models. | text.hash_embedding_v1 |
| dimensions | No | Length of each returned embedding vector. |