--- url: >- https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/interfaces/OpenAIEmbeddingsAdapterOptions.md description: >- Constructor options for {@link @nhtio/adk/batteries/embeddings/openai/adapter!OpenAIEmbeddingsAdapter}. --- # Interface: OpenAIEmbeddingsAdapterOptions Defined in: [src/batteries/embeddings/openai/types.ts:95](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L95) Constructor options for [@nhtio/adk/batteries/embeddings/openai/adapter!OpenAIEmbeddingsAdapter](../../adapter/classes/OpenAIEmbeddingsAdapter.md). ## Remarks Extends [BaseEmbeddingsAdapterOptions](BaseEmbeddingsAdapterOptions.md) with the HTTP transport fields the WebLLM battery deliberately omits. Targets any OpenAI-`/v1/embeddings`-compatible endpoint (OpenAI proper, Azure-behind-proxy, vLLM, Together, a local gateway, etc.). ## Extends * [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md) ## Properties | Property | Type | Description | Inherited from | Defined in | | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `apiKey?` | `string` | Bearer token. Sent as `Authorization: Bearer ` unless overridden by `headers`. | - | [src/batteries/embeddings/openai/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L97) | | `baseURL?` | `string` | API base URL. Default `https://api.openai.com/v1`. A trailing slash is trimmed. | - | [src/batteries/embeddings/openai/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L99) | | `dimensions?` | `number` | Declared output dimensionality, surfaced via `adapter.dimensions`. Optional metadata for callers that pre-allocate buffers; the battery does not enforce it against responses. | [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md).[`dimensions`](BaseEmbeddingsAdapterOptions.md#property-dimensions) | [src/batteries/embeddings/openai/types.ts:84](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L84) | | `documentPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'document'`. Unset → no prefix. Most asymmetric models (including Arctic) use no document prefix; exposed for symmetry and the models that do. | [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md).[`documentPrefix`](BaseEmbeddingsAdapterOptions.md#property-documentprefix) | [src/batteries/embeddings/openai/types.ts:79](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L79) | | `fetch?` | { (`input`: `URL` | `RequestInfo`, `init?`: `RequestInit`): `Promise`<`Response`>; (`input`: `string` | `URL` | `Request`, `init?`: `RequestInit`): `Promise`<`Response`>; } | Custom `fetch` implementation. Default `globalThis.fetch`. | - | [src/batteries/embeddings/openai/types.ts:103](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L103) | | `headers?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string`> | Extra request headers. Override built defaults (including `Authorization`) key-by-key. | - | [src/batteries/embeddings/openai/types.ts:101](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L101) | | `model` | `string` | Model id to embed with. **Required, no default.** For OpenAI this is e.g. `text-embedding-3-small`; for WebLLM it is an MLC embedding model id (e.g. `snowflake-arctic-embed-m-q0f32-MLC`). | [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md).[`model`](BaseEmbeddingsAdapterOptions.md#property-model) | [src/batteries/embeddings/openai/types.ts:67](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L67) | | `queryPrefix?` | `string` | Instruction prefix prepended to inputs embedded with `kind: 'query'`. Unset → no prefix. For Snowflake Arctic Embed, the documented value is `'Represent this sentence for searching relevant passages: '`. | [`BaseEmbeddingsAdapterOptions`](BaseEmbeddingsAdapterOptions.md).[`queryPrefix`](BaseEmbeddingsAdapterOptions.md#property-queryprefix) | [src/batteries/embeddings/openai/types.ts:73](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L73) | | `requestTimeoutMs?` | `number` | Per-request handshake timeout in ms. `0`/unset disables the timeout. | - | [src/batteries/embeddings/openai/types.ts:107](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L107) | | `retry?` | [`EmbeddingsRetryConfig`](EmbeddingsRetryConfig.md) | Retry/backoff configuration. Default: a single attempt (no retry). | - | [src/batteries/embeddings/openai/types.ts:105](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L105) |