Overview
OpenAIDecisionsClassifier answers classifier questions through OpenAI’s Decisions API. All the questions about one state go to OpenAI in one request. Structured state, instructions, and descriptions are sent as JSON.
An OpenAIDecisionsClassifier asks through an OpenAIDecisionsClient, which holds the HTTP/2 connection, adds the auth header, retries when OpenAI is busy, and counts tokens. Build the classifier with an API key to give it a client of its own, or pass an OpenAIDecisionsClient to share one connection between several classifiers.
Classifier Questions
Ask yes/no, choice, and score questions about a call transcript. Run with
--openai.Questions About an Image
Ask about an image, such as a frame from a camera. Run with
--openai.Installation
Prerequisites
An OpenAI API key, usually set as an environment variable:Configuration
OpenAIDecisionsClassifier
OpenAI API key, when the classifier should have a client of its own. One of
api_key and client is required.A client to share with other classifiers. One of
api_key and client is
required.OpenAIDecisionsClient
Where the API is served, such as
https://eu.api.openai.com/v1 for data
residency in Europe.How many times to retry a request OpenAI refused because it was busy (HTTP 429
or 503), with exponential backoff.
Usage
Basic Usage
VoicemailDetector or UIWorker.
Sharing a Client
Several classifiers can share oneOpenAIDecisionsClient, and with it one connection pool and one token count:
cleanup(). A shared client is left open, so close it yourself with await client.close() when every classifier using it is done.
Asking About Images
The Decisions API can see images. Pass them ininputs= to ask(), yes_no(), choice() or score(), as ClassifierImage objects:
Opening the Connection Early
setup() opens the connection to OpenAI ahead of the first question, so the first answer does not pay for the TLS handshake. Components that own a classifier, such as VoicemailDetector, call it for you. If the connection cannot be opened at setup, a warning is logged and the first question opens it instead.
OpenAIDecisionsClassifier Properties
OpenAIDecisionsClient Reference
Properties
Methods
connect
ClassifierError if OpenAI could not be reached or refused the request.
close
Metrics
After every call, anOpenAIDecisionsClassifier reports the time it took as ProcessingMetricsData and the tokens used as LLMUsageMetricsData through its on_metrics event.
Notes
- Limits: a choice question takes at most 255 options, available as
OPENAI_DECISIONS_MAX_CHOICE_OPTIONSinpipecat.classifiers.openai.decisions.classifier. A question with more raisesClassifierErrorbefore anything is sent. - Images: a call takes up to 128 images, available as
OPENAI_DECISIONS_MAX_IMAGESinpipecat.classifiers.openai.decisions.classifier. More than 128 raisesClassifierErrorbefore anything is sent. The API’sdetailoption is not exposed, so OpenAI uses its default,auto. - Errors: a rejected request, a busy OpenAI after every retry, an unreachable server, a refusal to answer a question, or a reply missing an answer all raise
ClassifierError. - Idle connections are kept open for 240 seconds, so a gap between questions does not cost a new TLS handshake.