Openai response
openai_response
OpenAIEndpointBase
OpenAIEndpointBase(endpoint_name, model_id, api_key=None, provider='openai', **kwargs)
Bases: Endpoint[TOpenAIResponseBase], Generic[TOpenAIResponseBase]
Base class for OpenAI Responses API endpoints (streaming and non-streaming)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
endpoint_name
|
str
|
Name of the endpoint |
required |
model_id
|
str
|
ID of the OpenAI model to use |
required |
api_key
|
str | None
|
OpenAI API key (optional, uses OPENAI_API_KEY env var if not provided) |
None
|
provider
|
str
|
Provider name (default: "openai") |
'openai'
|
**kwargs
|
Any
|
Additional arguments passed to OpenAI client |
{}
|
Source code in llmeter/endpoints/openai_response.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | |
create_payload
staticmethod
create_payload(user_message, max_output_tokens=256, instructions=None, **kwargs)
Create a payload for the Responses API request.
This is a convenience helper. You can also build the payload directly
using openai.types.responses.ResponseCreateParams.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_message
|
str | Sequence[str]
|
User message(s) to send (can be string or array of messages) |
required |
max_output_tokens
|
int
|
Maximum tokens in response (default: 256) |
256
|
instructions
|
str | None
|
Optional system-level instructions |
None
|
**kwargs
|
Additional payload parameters (temperature, top_p, text.format, etc.) |
{}
|
Returns:
| Type | Description |
|---|---|
ResponseCreateParams
|
ResponseCreateParams formatted for Responses API |
Source code in llmeter/endpoints/openai_response.py
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | |
OpenAIResponseEndpoint
OpenAIResponseEndpoint(model_id, endpoint_name='openai-response', api_key=None, provider='openai', **kwargs)
Bases: OpenAIEndpointBase[Response]
Endpoint for OpenAI Responses API (non-streaming).
This endpoint provides access to OpenAI's newer Responses API which offers structured outputs, better response format control, and improved multi-turn conversation handling.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_id
|
str
|
ID of the OpenAI model to use |
required |
endpoint_name
|
str
|
Name of the endpoint (default: "openai-response") |
'openai-response'
|
api_key
|
str | None
|
OpenAI API key (optional, uses OPENAI_API_KEY env var if not provided) |
None
|
provider
|
str
|
Provider name (default: "openai") |
'openai'
|
**kwargs
|
Any
|
Additional arguments passed to OpenAI client |
{}
|
Source code in llmeter/endpoints/openai_response.py
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | |
invoke
invoke(payload)
Invoke the Responses API.
Source code in llmeter/endpoints/openai_response.py
147 148 149 150 151 | |
prepare_payload
prepare_payload(payload)
Ensure payload specifies correct model ID and streaming disabled
Source code in llmeter/endpoints/openai_response.py
153 154 155 156 157 158 159 | |
OpenAIResponseStreamEndpoint
OpenAIResponseStreamEndpoint(model_id, endpoint_name='openai-response-stream', api_key=None, provider='openai', ttft_visible_tokens_only=True, **kwargs)
Bases: OpenAIEndpointBase[Iterable[ResponseStreamEvent]]
Endpoint for OpenAI Responses API (streaming).
This endpoint provides streaming access to OpenAI's Responses API, enabling time-to-first-token measurements and incremental response processing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ttft_visible_tokens_only
|
bool
|
Controls how |
True
|
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_id
|
str
|
ID of the OpenAI model to use |
required |
endpoint_name
|
str
|
Name of the endpoint (default: "openai-response-stream") |
'openai-response-stream'
|
api_key
|
str | None
|
OpenAI API key (optional, uses OPENAI_API_KEY env var if not provided) |
None
|
provider
|
str
|
Provider name (default: "openai") |
'openai'
|
ttft_visible_tokens_only
|
bool
|
When True (default), TTFT measures time to first visible text token. When False, TTFT includes reasoning token events. |
True
|
**kwargs
|
Additional arguments passed to OpenAI client |
{}
|
Source code in llmeter/endpoints/openai_response.py
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | |
invoke
invoke(payload)
Invoke the Responses API with streaming.
Source code in llmeter/endpoints/openai_response.py
241 242 243 244 245 | |
prepare_payload
prepare_payload(payload)
Ensure payload specifies correct model ID and streaming options
Source code in llmeter/endpoints/openai_response.py
247 248 249 250 251 252 253 | |
process_raw_response
process_raw_response(raw_response, start_t, response)
Parse streaming Response API output into InvocationResponse.
Processes typed events from the stream:
ResponseCreatedEvent: capturesresponse.idResponseTextDeltaEvent: accumulates text deltas, records TTFTResponseCompletedEvent: extracts usage fromresponse.usageResponseFailedEvent: captures API-level errors- Reasoning events (
response.reasoning_summary_text.delta,response.reasoning_text.delta): whenttft_visible_tokens_onlyisFalse, these set TTFT on the first reasoning token.
Source code in llmeter/endpoints/openai_response.py
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 | |