---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/embeddings/openai/types/type-aliases/EmbeddingKind.md
description: >-
  Whether a piece of text is being embedded as a search **query** or as a corpus
  **document**.
---

# Type Alias: EmbeddingKind

```ts
type EmbeddingKind = "query" | "document";
```

Defined in: [src/batteries/embeddings/openai/types.ts:26](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/embeddings/openai/types.ts#L26)

Whether a piece of text is being embedded as a search **query** or as a corpus **document**.

## Remarks

Asymmetric-embedding models (e.g. Snowflake Arctic Embed) expect a short instruction prefix on
queries but not on documents. The battery prepends [BaseEmbeddingsAdapterOptions.queryPrefix](../interfaces/BaseEmbeddingsAdapterOptions.md#property-queryprefix)
when `kind === 'query'` and [BaseEmbeddingsAdapterOptions.documentPrefix](../interfaces/BaseEmbeddingsAdapterOptions.md#property-documentprefix) when
`kind === 'document'` — each only if the corresponding prefix option is set. Defaults to
`'document'`, so the neutral (un-prefixed, unless a document prefix is configured) path is taken
when a caller does not specify.