openai_chat_completion
Generates responses to messages in a chat conversation, using the OpenAI API and external tools.
-
Common
-
Advanced
# Common configuration fields, showing default values
label: ""
openai_chat_completion:
server_address: https://api.openai.com/v1
api_key: "" # No default (required)
model: gpt-4o # No default (required)
prompt: "" # No default (optional)
system_prompt: "" # No default (optional)
history: "" # No default (optional)
image: 'root = this.image.decode("base64") # decode base64 encoded image' # No default (optional)
max_tokens: 0 # No default (optional)
temperature: 0 # No default (optional)
user: "" # No default (optional)
response_format: text
json_schema:
name: "" # No default (required)
schema: "" # No default (required)
tools: [] # No default (required)# All configuration fields, showing default values
label: ""
openai_chat_completion:
server_address: https://api.openai.com/v1
api_key: "" # No default (required)
model: gpt-4o # No default (required)
prompt: "" # No default (optional)
system_prompt: "" # No default (optional)
history: "" # No default (optional)
image: 'root = this.image.decode("base64") # decode base64 encoded image' # No default (optional)
max_tokens: 0 # No default (optional)
temperature: 0 # No default (optional)
user: "" # No default (optional)
response_format: text
json_schema:
name: "" # No default (required)
description: "" # No default (optional)
schema: "" # No default (required)
schema_registry:
url: "" # No default (required)
name_prefix: schema_registry_id_
subject: "" # No default (required)
refresh_interval: "" # No default (optional)
tls:
skip_cert_verify: false
enable_renegotiation: false
root_cas: "" # No default (optional)
root_cas_file: "" # No default (optional)
client_certs: [] # Optional
oauth:
enabled: false
consumer_key: "" # No default (optional)
consumer_secret: "" # No default (optional)
access_token: "" # No default (optional)
access_token_secret: "" # No default (optional)
basic_auth:
enabled: false
username: "" # No default (optional)
password: "" # No default (optional)
jwt:
enabled: false
private_key_file: "" # No default (optional)
signing_method: "" # No default (optional)
claims: {} # Optional
headers: {} # Optional
top_p: 0 # No default (optional)
frequency_penalty: 0 # No default (optional)
presence_penalty: 0 # No default (optional)
seed: 0 # No default (optional)
stop: [] # No default (optional)
tools: [] # No default (required)This processor sends user prompts to the OpenAI API, and the specified large language model (LLM) 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 configuration field to customize it.
To learn more about chat completion, see the OpenAI API documentation, and Examples.
Fields
api_key
The API secret key for OpenAI API.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
frequency_penalty
Specify 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
history
Include messages from a prior conversation. You must use a Bloblang query to create an array of objects in the form of [{"role": "user", "content": "<text>"}, {"role":"assistant", "content":"<text>"}] where:
-
roleis the sender of the original messages, eithersystem,user, orassistant. -
contentis the text of the original messages.
For more information, see Examples.
Type: string
image
An optional image to submit along with the prompt. The result of the Bloblang mapping must be a byte array.
Type: string
# Examples:
image: root = this.image.decode("base64") # decode base64 encoded imagejson_schema
The JSON schema used by the model when generating responses in json_schema format. To learn more about supported JSON schema features, see the OpenAI documentation.
Type: object
json_schema.description
An optional description, which helps the model understand the schema’s purpose.
Type: string
model
The name of the OpenAI model to use.
Type: string
# Examples:
model: gpt-4o
model: gpt-4o-mini
model: gpt-4
model: gpt4-turbopresence_penalty
Specify a number between -2.0 and 2.0. Positive values penalize new tokens if they have appeared in the text so far. This increases the model’s likelihood to talk about new topics.
Type: float
prompt
The user prompt for which a response is generated. By default, the processor sends the entire payload as a string unless customized using this field.
Type: string
response_format
Specify the configured model’s output format.
If you choose the json_schema option, you must also configure a json_schema or schema_registry.
Type: string
Default: text
Options: text, json, json_schema
schema_registry
The schema registry to dynamically load schemas for model responses in json_schema format. Schemas must be in JSON format. To learn more about supported JSON schema features, see the OpenAI documentation.
Type: object
schema_registry.basic_auth
Configure basic authentication for requests from this component to your schema registry.
Type: object
schema_registry.basic_auth.enabled
Whether to use basic authentication in requests.
Type: bool
Default: false
schema_registry.basic_auth.password
The password of the account credentials to authenticate with.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
Default: ""
schema_registry.basic_auth.username
The username of the account credentials to authenticate as.
Type: string
Default: ""
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
Whether to use JWT authentication in requests.
Type: bool
Default: false
schema_registry.jwt.headers
The key/value pairs that identify the type of token and signing algorithm (optional).
Type: object
Default: {}
schema_registry.jwt.private_key_file
A file in PEM format, encoded using PKCS1 or PKCS8 as private key.
Type: string
Default: ""
schema_registry.jwt.signing_method
The method used to sign the token, such as RS256, RS384, RS512, or EdDSA.
Type: string
Default: ""
schema_registry.name_prefix
A prefix to add to the schema registry name. To form the complete schema registry name, the schema ID is appended as a suffix.
Type: string
Default: schema_registry_id_
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
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
The secret that establishes ownership of the oauth.access_token.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
Default: ""
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
The secret used to establish ownership of the consumer key.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
Default: ""
schema_registry.oauth.enabled
Whether to use OAuth version 1 in requests to the schema registry.
Type: bool
Default: false
schema_registry.refresh_interval
How frequently to poll the schema registry for updates. If not specified, the schema does not refresh automatically.
Type: string
schema_registry.subject
The subject name used to fetch the schema from the schema registry.
Type: string
schema_registry.tls.client_certs[]
A list of client certificates to use. For each certificate, specify values for either the cert and key fields, or cert_file and key_file fields.
Type: object
Default: []
# Examples:
client_certs:
- cert: foo
key: bar
- cert_file: ./example.pem
key_file: ./example.keyschema_registry.tls.client_certs[].cert_file
The path of a certificate to use.
Type: string
Default: ""
schema_registry.tls.client_certs[].key
A plain text certificate key to use.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
Default: ""
schema_registry.tls.client_certs[].key_file
The path of a certificate key to use.
Type: string
Default: ""
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.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
Default: ""
# Examples:
password: foo
password: ${KEY_PASSWORD}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
Specify a 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.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. |
Type: string
Default: ""
# Examples:
root_cas: |-
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----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, that contains a certificate chain from the parent trusted root certificate, through possible intermediate signing certificates, to the host certificate.certificate.
Type: string
Default: ""
# Examples:
root_cas_file: ./root_cas.pemschema_registry.tls.skip_cert_verify
Whether to skip server-side certificate verification.
Type: bool
Default: false
seed
When set to a specific number, Redpanda Connect attempts to generate consistent responses for requests that use the same prompt, seed, and parameters.
Type: int
server_address
The OpenAI API endpoint to which the processor sends requests. Update the default value to use a different OpenAI-compatible service.
Type: string
Default: https://api.openai.com/v1
stop[]
Specify up to four stop sequences to use. When the model encounters a stop pattern, it stops generating text and returns the final response.
Type: array
system_prompt
The system prompt to submit along with the user prompt. This field supports interpolation functions.
Type: string
temperature
Choose a sampling temperature between 0 and 2:
-
Higher values, such as
0.8make the output more random. -
Lower values, such as
0.2make the output more focused and deterministic.
Redpanda recommends adding a value for this field or top_p, but not both.
Type: float
tools[]
External tools the model can invoke, such as functions, APIs, or web browsing. You can build a series of processors that include definitions of these tools, and the specified model can choose when to invoke them to help answer a prompt. For more information, see Examples.
If you don’t want to use external tools, enter an empty array tools:[].
|
Type: object
tools[].description
A description of this tool, the LLM uses this to decide if the tool should be used.
Type: string
tools[].parameters
The parameters the LLM needs to provide to invoke this tool.
Type: object
Default: []
tools[].parameters.properties.enum[]
Specifies that this parameter is an enum and only these specific values should be used.
Type: array
Default: []
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
user
A unique identifier that represents the end-user generating the prompt. This value can help OpenAI monitor and detect platform abuse. This field supports interpolation functions.
Type: string
nclude::redpanda-connect:components:partial$examples/processors/openai_chat_completion.adoc[]
