Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Dimensions | *int64 | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 |
EncodingFormat | *operations.EncodingFormat | :heavy_minus_sign: | The format of the output embeddings | float |
Input | operations.InputUnion | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog |
InputType | *string | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query |
Model | string | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small |
Provider | optionalnullable.OptionalNullable[components.ProviderPreferences] | :heavy_minus_sign: | N/A | { “allow_fallbacks”: true } |
SessionID | *string | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 |
Trace | *components.TraceConfig | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | { “trace_id”: “trace-abc123”, “trace_name”: “my-app-trace” } |
User | *string | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 |