# cohere_chat

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

---
title: cohere_chat
page-beta-text: This is a beta feature. Beta features are available for testing and feedback. They are not supported by Redpanda and should not be used in production environments.
latest-operator-version: v26.1.4
latest-console-tag: v3.7.3
latest-connect-version: 4.93.0
latest-redpanda-tag: v26.1.9
docname: connect/components/processors/cohere_chat
page-component-name: cloud-data-platform
page-version: master
page-component-version: master
page-component-title: Cloud
page-relative-src-path: connect/components/processors/cohere_chat.adoc
page-edit-url: https://github.com/redpanda-data/cloud-docs/edit/main/modules/develop/pages/connect/components/processors/cohere_chat.adoc
# Beta release status
page-beta: "true"
page-git-created-date: "2024-10-16"
page-git-modified-date: "2026-05-26"
release-status: beta - This is a beta feature. Beta features are available for testing and feedback. They are not supported by Redpanda and should not be used in production environments.
---

<!-- Source: https://docs.redpanda.com/cloud-data-platform/develop/connect/components/processors/cohere_chat.md -->

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

Generates responses to messages in a chat conversation, using the [Cohere API](https://docs.cohere.com/docs/chat-api) and external tools.

#### Common

```yml
processors:
  label: ""
  cohere_chat:
    base_url: https://api.cohere.com
    api_key: "" # No default (required)
    model: "" # No default (required)
    prompt: "" # No default (optional)
    system_prompt: "" # No default (optional)
    max_tokens: "" # No default (optional)
    temperature: "" # No default (optional)
    response_format: text
    json_schema: "" # No default (optional)
    max_tool_calls: 10
    tools: []
```

#### Advanced

```yml
processors:
  label: ""
  cohere_chat:
    base_url: https://api.cohere.com
    api_key: "" # No default (required)
    model: "" # No default (required)
    prompt: "" # No default (optional)
    system_prompt: "" # No default (optional)
    max_tokens: "" # No default (optional)
    temperature: "" # No default (optional)
    response_format: text
    json_schema: "" # No default (optional)
    schema_registry:
      url: "" # No default (required)
      subject: "" # No default (required)
      refresh_interval: "" # No default (optional)
      tls:
        skip_cert_verify: false
        enable_renegotiation: false
        root_cas: ""
        root_cas_file: ""
        client_certs: []
      oauth:
        enabled: false
        consumer_key: ""
        consumer_secret: ""
        access_token: ""
        access_token_secret: ""
      basic_auth:
        enabled: false
        username: ""
        password: ""
      jwt:
        enabled: false
        private_key_file: ""
        signing_method: ""
        claims: {}
        headers: {}
    top_p: "" # No default (optional)
    frequency_penalty: "" # No default (optional)
    presence_penalty: "" # No default (optional)
    seed: "" # No default (optional)
    stop: [] # No default (optional)
    max_tool_calls: 10
    tools: []
```

This processor sends the contents of user prompts to the Cohere API, which generates responses using all available context, including supplementary data provided by external tools. By default, the processor submits the entire payload of each message as a string, unless you use the `prompt` field to customize it.

To learn more about chat completion, see the [Cohere API documentation](https://docs.cohere.com/docs/chat-api).

## [](#fields)Fields

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

The API key for the Cohere API.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

### [](#base_url)`base_url`

The base URL to use for API requests.

**Type**: `string`

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

### [](#frequency_penalty)`frequency_penalty`

A number between `-2.0` and `2.0`. Positive values penalize new tokens based on the frequency of their appearance in the text so far. This decreases the model’s likelihood to repeat the same line verbatim.

**Type**: `float`

### [](#json_schema)`json_schema`

The JSON schema to use when responding in `json_schema` format. To learn more about the JSON schema features supported, see the [Cohere documentation](https://docs.cohere.com/docs/structured-outputs-json).

**Type**: `string`

### [](#max_tokens)`max_tokens`

The maximum number of tokens to allow in the chat completion.

**Type**: `int`

### [](#max_tool_calls)`max_tool_calls`

The maximum number of tool calls the model can perform.

**Type**: `int`

**Default**: `10`

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

The name of the Cohere large language model (LLM) you want to use.

**Type**: `string`

```yaml
# Examples:
model: command-r-plus

# ---

model: command-r

# ---

model: command

# ---

model: command-light
```

### [](#presence_penalty)`presence_penalty`

A number between `-2.0` and `2.0`. Positive values penalize new tokens based on the frequency of their appearance in the text so far. This increases the model’s likelihood to talk about new topics.

**Type**: `float`

### [](#prompt)`prompt`

The user prompt you want to generate a response for. By default, the processor submits the entire payload as a string.

This field supports [interpolation functions](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/interpolation/#bloblang-queries).

**Type**: `string`

### [](#response_format)`response_format`

Choose the model’s output format. If `json_schema` is specified, then you must also configure a `json_schema` or `schema_registry`.

**Type**: `string`

**Default**: `text`

**Options**: `text`, `json`, `json_schema`

### [](#schema_registry)`schema_registry`

The schema registry to dynamically load schemas from when responding in `json_schema` format. Schemas themselves must be in JSON format. To learn more about the JSON schema features supported, see the [Cohere documentation](https://docs.cohere.com/docs/structured-outputs-json).

**Type**: `object`

### [](#schema_registry-basic_auth)`schema_registry.basic_auth`

Configure basic authentication for requests from this component to your schema registry.

**Type**: `object`

### [](#schema_registry-basic_auth-enabled)`schema_registry.basic_auth.enabled`

Whether to use basic authentication in requests.

**Type**: `bool`

**Default**: `false`

### [](#schema_registry-basic_auth-password)`schema_registry.basic_auth.password`

The password to use for authentication. Used together with `username` for basic authentication or with encrypted private keys for secure access.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-basic_auth-username)`schema_registry.basic_auth.username`

The username of the account credentials to authenticate as. Used together with `password` for basic authentication.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-jwt)`schema_registry.jwt`

Beta

Configure JSON Web Token (JWT) authentication for secure data transmission from your schema registry to this component. This feature is in beta and may change in future releases.

**Type**: `object`

### [](#schema_registry-jwt-claims)`schema_registry.jwt.claims`

Values used to pass the identity of the authenticated entity to the service provider. In this case, between this component and the schema registry.

**Type**: `object`

**Default**: `{}`

### [](#schema_registry-jwt-enabled)`schema_registry.jwt.enabled`

Whether to use JWT authentication in requests.

**Type**: `bool`

**Default**: `false`

### [](#schema_registry-jwt-headers)`schema_registry.jwt.headers`

The key/value pairs that identify the type of token and signing algorithm.

**Type**: `object`

**Default**: `{}`

### [](#schema_registry-jwt-private_key_file)`schema_registry.jwt.private_key_file`

Path to a file containing the PEM-encoded private key using PKCS#1 or PKCS#8 format. The private key must be compatible with the algorithm specified in the `signing_method` field.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-jwt-signing_method)`schema_registry.jwt.signing_method`

The cryptographic algorithm used to sign the JWT token. Supported algorithms include RS256, RS384, RS512, and EdDSA. This algorithm must be compatible with the private key specified in the `private_key_file` field.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-oauth)`schema_registry.oauth`

Configure OAuth version 1.0 to give this component authorized access to your schema registry.

**Type**: `object`

### [](#schema_registry-oauth-access_token)`schema_registry.oauth.access_token`

The value this component can use to gain access to the data in the schema registry.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-oauth-access_token_secret)`schema_registry.oauth.access_token_secret`

The secret that establishes ownership of the `oauth.access_token` in OAuth 1.0 authentication.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-oauth-consumer_key)`schema_registry.oauth.consumer_key`

The value used to identify this component or client to your schema registry.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-oauth-consumer_secret)`schema_registry.oauth.consumer_secret`

The secret that establishes ownership of the consumer key in OAuth 1.0 authentication.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-oauth-enabled)`schema_registry.oauth.enabled`

Whether to enable OAuth version 1.0 authentication for requests to the schema registry.

**Type**: `bool`

**Default**: `false`

### [](#schema_registry-refresh_interval)`schema_registry.refresh_interval`

The refresh rate for fetching the latest schema. If not specified the schema does not refresh.

**Type**: `string`

### [](#schema_registry-subject)`schema_registry.subject`

The subject name to fetch the schema for.

**Type**: `string`

### [](#schema_registry-tls)`schema_registry.tls`

Configure Transport Layer Security (TLS) settings to secure network connections. This includes options for standard TLS as well as mutual TLS (mTLS) authentication where both client and server authenticate each other using certificates. Key configuration options include `enabled` to enable TLS, `client_certs` for mTLS authentication, `root_cas`/`root_cas_file` for custom certificate authorities, and `skip_cert_verify` for development environments.

**Type**: `object`

### [](#schema_registry-tls-client_certs)`schema_registry.tls.client_certs[]`

A list of client certificates for mutual TLS (mTLS) authentication. Configure this field to enable mTLS, authenticating the client to the server with these certificates.

You must set `tls.enabled: true` for the client certificates to take effect.

**Certificate pairing rules**: For each certificate item, provide either:

-   Inline PEM data using both `cert` **and** `key` or

-   File paths using both `cert_file` **and** `key_file`.


Mixing inline and file-based values within the same item is not supported.

**Type**: `object`

**Default**: `[]`

```yaml
# Examples:
client_certs:
  - cert: foo
    key: bar

# ---

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key
```

### [](#schema_registry-tls-client_certs-cert)`schema_registry.tls.client_certs[].cert`

A plain text certificate to use.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-tls-client_certs-cert_file)`schema_registry.tls.client_certs[].cert_file`

The path of a certificate to use.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-tls-client_certs-key)`schema_registry.tls.client_certs[].key`

A plain text certificate key to use.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-tls-client_certs-key_file)`schema_registry.tls.client_certs[].key_file`

The path of a certificate key to use.

**Type**: `string`

**Default**: `""`

### [](#schema_registry-tls-client_certs-password)`schema_registry.tls.client_certs[].password`

A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete `pbeWithMD5AndDES-CBC` algorithm is not supported for the PKCS#8 format.

Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

**Default**: `""`

```yaml
# Examples:
password: foo

# ---

password: ${KEY_PASSWORD}
```

### [](#schema_registry-tls-enable_renegotiation)`schema_registry.tls.enable_renegotiation`

Whether to allow the remote server to request renegotiation. Enable this option if you’re seeing the error message `local error: tls: no renegotiation`.

**Type**: `bool`

**Default**: `false`

### [](#schema_registry-tls-root_cas)`schema_registry.tls.root_cas`

Specify a root certificate authority to use (optional). This is a string that represents a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for inline certificate data or `root_cas_file` for file-based certificate loading.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

**Default**: `""`

```yaml
# Examples:
root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----
```

### [](#schema_registry-tls-root_cas_file)`schema_registry.tls.root_cas_file`

Specify the path to a root certificate authority file (optional). This is a file, often with a `.pem` extension, which contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for file-based certificate loading or `root_cas` for inline certificate data.

**Type**: `string`

**Default**: `""`

```yaml
# Examples:
root_cas_file: ./root_cas.pem
```

### [](#schema_registry-tls-skip_cert_verify)`schema_registry.tls.skip_cert_verify`

Whether to skip server-side certificate verification. Set to `true` only for testing environments as this reduces security by disabling certificate validation. When using self-signed certificates or in development, this may be necessary, but should never be used in production. Consider using `root_cas` or `root_cas_file` to specify trusted certificates instead of disabling verification entirely.

**Type**: `bool`

**Default**: `false`

### [](#schema_registry-url)`schema_registry.url`

The base URL of the schema registry service.

**Type**: `string`

### [](#seed)`seed`

If specified, Redpanda Connect makes a best effort to sample deterministically. Repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed.

**Type**: `int`

### [](#stop)`stop[]`

Specify up to four sequences to stop the API from generating further tokens.

**Type**: `array`

### [](#system_prompt)`system_prompt`

The system prompt to submit along with the user prompt.

This field supports [interpolation functions](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/interpolation/#bloblang-queries).

**Type**: `string`

### [](#temperature)`temperature`

Choose a sampling temperature between `0` and `2`:

-   Higher values, such as `0.8` make the output more random.

-   Lower values, such as `0.2` make the output more focused and deterministic.


Redpanda recommends adding a value for this field or `top_p`, but not both.

**Type**: `float`

### [](#tools)`tools[]`

External tools that the model can invoke, such as functions, APIs, or web browsing. You can define a series of processors that describe these tools, enabling the model to use agent-like behavior to decide when and how to invoke them to enhance response generation.

**Type**: `object`

**Default**: `[]`

### [](#tools-description)`tools[].description`

A description of this tool, the LLM uses this to decide if the tool should be used.

**Type**: `string`

### [](#tools-name)`tools[].name`

The name of this tool.

**Type**: `string`

### [](#tools-parameters)`tools[].parameters`

The parameters the LLM needs to provide to invoke this tool.

**Type**: `object`

### [](#tools-parameters-properties)`tools[].parameters.properties`

The properties for the processor’s input data

**Type**: `object`

### [](#tools-parameters-properties-description)`tools[].parameters.properties.description`

A description of this parameter.

**Type**: `string`

### [](#tools-parameters-properties-enum)`tools[].parameters.properties.enum[]`

Specifies that this parameter is an enum and only these specific values should be used.

**Type**: `array`

**Default**: `[]`

### [](#tools-parameters-properties-type)`tools[].parameters.properties.type`

The type of this parameter.

**Type**: `string`

### [](#tools-parameters-required)`tools[].parameters.required[]`

The required parameters for this pipeline.

**Type**: `array`

**Default**: `[]`

### [](#tools-processors)`tools[].processors[]`

The pipeline to execute when the LLM uses this tool.

**Type**: `processor`

### [](#top_p)`top_p`

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. For example, a `top_p` of `0.1` means only the tokens comprising the top 10% probability mass are sampled.

Redpanda recommends adding a value for this field or `temperature`, but not both.

**Type**: `float`

## [](#example)Example

In this pipeline configuration, the Command R+ model executes a number of processors, which make a tool call to retrieve weather data for a specific city.

```yaml
input:
  generate:
    count: 1
    mapping: |
      root = "What is the weather like in Chicago?"
pipeline:
  processors:
    - cohere_chat:
        auth_token: my_cohere_api_token
        model: command-r-plus
        prompt: "${!content().string()}"
        tools:
          - name: GetWeather
            description: "Retrieve the weather for a specific city"
            parameters:
              required: ["city"]
              properties:
                city:
                  type: string
                  description: the city to look up the weather for
            processors:
              - http:
                  verb: GET
                  url: 'https://wttr.in/${!this.city}?T'
                  headers:
                    User-Agent: curl/8.11.1 # Returns a text string from the weather website
output:
  stdout: {}
```