OpenAI
Updated
Integrate OpenAI ASR with the Conversational AI Engine.
OpenAI provides real-time speech-to-text with low latency and reliable performance, making it ideal for conversational AI applications.
Info
This integration is fully supported for use with Conversational AI Engine. While it has completed functional validation, it is newer to the platform, and additional provider-specific edge cases may be identified as usage scales across a broader range of applications and workloads.
Sample configuration
The following example shows how to configure OpenAI ASR when starting a conversational AI agent.
from agora_agent import Agent, OpenAISTT
# client is your configured Agora client
agent = (
Agent(client)
.with_stt(OpenAISTT(
api_key='your-openai-key',
model='gpt-4o-mini-transcribe',
language='en',
prompt='Please transcribe the following audio into text. Output in English.',
))
.with_llm(...) # configure your LLM vendor
.with_tts(...) # configure your TTS vendor
)import { Agent, OpenAISTT } from 'agora-agents';
// client is your configured Agora client
const agent = new Agent({ client })
.withStt(new OpenAISTT({
apiKey: 'your-openai-key',
model: 'gpt-4o-mini-transcribe',
language: 'en',
prompt: 'Please transcribe the following audio into text. Output in English.',
}))
.withLlm(/* configure your LLM vendor */)
.withTts(/* configure your TTS vendor */);import "github.com/AgoraIO/agora-agents-go/v2/agentkit/vendors"
// client is your configured Agora client
agent := agentkit.NewAgent(client).WithStt(
vendors.NewOpenAISTT(vendors.OpenAISTTOptions{
APIKey: "your-openai-key",
Model: "gpt-4o-mini-transcribe",
Language: "en",
Prompt: "Please transcribe the following audio into text. Output in English.",
}),
).WithLlm(/* configure your LLM vendor */).
WithTts(/* configure your TTS vendor */)Use the following asr configuration in your request:
"asr": {
"vendor": "openai",
"language": "en-US",
"params": {
"api_key": "<openai_key>",
"input_audio_transcription": {
"model": "gpt-4o-mini-transcribe",
"prompt": "Please transcribe the following audio into text. Output in English.",
"language": "en"
}
}
}Caution
The parameters listed on this page are validated for use with Conversational AI Engine. Required parameters must be provided as documented. Any additional parameters are passed through directly to the underlying vendor without validation. For a full list of supported options, refer to the OpenAI documentation.
Key parameters
api_keystringThe OpenAI API key used to authenticate requests. You must provide a valid key for the service to function.
input_audio_transcriptionobjectThe configuration object for audio transcription. Use this object to specify the model, prompt, and language for the transcription task.
modelstringThe OpenAI ASR model to use for transcription. For example, gpt-4o-mini-transcribe.
promptstringA prompt that guides the transcription process. Use this parameter to provide context or instructions for how the audio should be transcribed.
languagestringThe language code to use for transcription. For example, use en for English.