TypeScript SDKReference
Embeddings Types
TypeScript types for the Embeddings API.
OpenAI Compatibility: The Skytells Embeddings API implements the OpenAI Embeddings specification. These TypeScript types mirror the OpenAI API exactly. See POST /v1/embeddings.
See Embeddings for usage.
EmbeddingCreateParams
interface EmbeddingCreateParams {
model: string;
input: string | string[];
encoding_format?: 'float' | 'base64';
dimensions?: number;
user?: string;
}| Parameter | Type | Default | Description |
|---|---|---|---|
model | string | — | Embedding model slug. |
input | string | string[] | — | Text(s) to embed. |
encoding_format | 'float' | 'base64' | 'float' | Return format. |
dimensions | number | — | Reduce output dimensions. |
user | string | — | End-user identifier. |
CreateEmbeddingResponse
Returned by client.embeddings.create() from POST /v1/embeddings. This TypeScript interface matches the OpenAI Embeddings API response exactly — the SDK performs no transformations.
interface CreateEmbeddingResponse {
object: 'list';
data: Embedding[];
model: string;
usage: {
prompt_tokens: number;
total_tokens: number;
};
}| Field | Type | Description |
|---|---|---|
object | 'list' | Object type. |
data | Embedding[] | Array of embeddings (same order as input). |
model | string | Model used. |
usage | { prompt_tokens, total_tokens } | Token usage. |
Embedding
interface Embedding {
object: 'embedding';
index: number;
embedding: number[] | Float32Array;
}| Field | Type | Description |
|---|---|---|
object | 'embedding' | Object type. |
index | number | Position in input array. |
embedding | number[] | Float32Array | The vector. |
Related
- SDK Embeddings — Complete embeddings implementation guide
- Embeddings API — API documentation for embeddings
- Models API — Discover embedding models
How is this guide?