# openai_embeddings

> For the complete documentation index, see [llms.txt](https://docs.redpanda.com/llms.txt). Component-specific: [connect-full.txt](https://docs.redpanda.com/connect-full.txt)

---
title: openai_embeddings
latest-connect-version: 4.93.0
latest-operator-version: v26.1.4
latest-console-tag: v3.7.3
latest-redpanda-tag: v26.1.9
docname: processors/openai_embeddings
page-component-name: connect
page-version: master
page-component-version: master
page-component-title: Connect
page-relative-src-path: processors/openai_embeddings.adoc
page-edit-url: https://github.com/redpanda-data/rp-connect-docs/edit/main/modules/components/pages/processors/openai_embeddings.adoc
page-git-created-date: "2024-08-15"
page-git-modified-date: "2026-05-26"
---

<!-- Source: https://docs.redpanda.com/connect/components/processors/openai_embeddings.md -->

**Available in:** [Cloud](https://docs.redpanda.com/cloud-data-platform/develop/connect/components/processors/openai_embeddings/%20%22View%20the%20Cloud%20version%20of%20this%20component%22), Self-Managed

Generates vector embeddings to represent input text, using the OpenAI API.

Introduced in version 4.32.0.

```yml
# Config fields, showing default values
label: ""
openai_embeddings:
  server_address: https://api.openai.com/v1
  api_key: "" # No default (required)
  model: text-embedding-3-large # No default (required)
  text_mapping: "" # No default (optional)
```

This processor sends text strings to the OpenAI API, which generates vector embeddings. By default, the processor submits the entire payload of each message as a string, unless you use the `text_mapping` configuration field to customize it.

To learn more about vector embeddings, see the [OpenAI API documentation](https://platform.openai.com/docs/guides/embeddings).

## [](#fields)Fields

### [](#api_key)`api_key`

The API key for OpenAI API.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Secrets](https://docs.redpanda.com/connect/configuration/secrets/).

**Type**: `string`

### [](#dimensions)`dimensions`

The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.

**Type**: `int`

### [](#model)`model`

The name of the OpenAI model to use.

**Type**: `string`

```yaml
# Examples:
model: text-embedding-3-large

# ---

model: text-embedding-3-small

# ---

model: text-embedding-ada-002
```

### [](#server_address)`server_address`

The Open API endpoint that the processor sends requests to. Update the default value to use another OpenAI compatible service.

**Type**: `string`

**Default**: `[https://api.openai.com/v1](https://api.openai.com/v1)`

### [](#text_mapping)`text_mapping`

The text you want to generate a vector embedding for. By default, the processor submits the entire payload as a string.

**Type**: `string`