@godspeedai/cognate-provider-openai-responses 0.8.0 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +4 -4
  2. package/src/EGM.md +39 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@godspeedai/cognate-provider-openai-responses",
3
- "version": "0.8.0",
3
+ "version": "0.9.1",
4
4
  "description": "OpenAI Responses API ModelProvider with streaming settlement and credential leasing.",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
@@ -22,8 +22,8 @@
22
22
  ".": "./src/index.ts"
23
23
  },
24
24
  "dependencies": {
25
- "@godspeedai/cognate-capabilities": "^0.8.0",
26
- "@godspeedai/cognate-provider-auth": "^0.8.0",
27
- "@godspeedai/cognate-provider-wire": "^0.8.0"
25
+ "@godspeedai/cognate-capabilities": "^0.9.1",
26
+ "@godspeedai/cognate-provider-auth": "^0.9.1",
27
+ "@godspeedai/cognate-provider-wire": "^0.9.1"
28
28
  }
29
29
  }
package/src/EGM.md ADDED
@@ -0,0 +1,39 @@
1
+ # provider-openai-responses / src — Responses API request and stream mapping
2
+
3
+ ## Overview
4
+
5
+ `src/index.ts` exports `openAIResponses(options)` plus its options interface. It converts framework `ModelRequest` values into the Responses API body (`input` items, `instructions`, `tools`, `max_output_tokens`, `text.format`), POSTs once per call through the shared wire helpers, and either parses the completed JSON response or consumes the event stream until `response.completed`. Streaming is settlement-oriented: the terminal `done` delta carries the fully assembled `ModelResponse`.
6
+
7
+ ## Interface
8
+
9
+ - `OpenAIResponsesOptions` — `id`, `baseURL`, `model`, `credentials: CredentialSource`, optional `fetch`, `timeoutMs`, and optional `subscription` grant/usage-mode pair `[packages/provider-openai-responses/src/index.ts:OpenAIResponsesOptions]`
10
+ - `openAIResponses(options)` — returns a `ModelProvider` with id `openai-responses:<id>` `[packages/provider-openai-responses/src/index.ts:openAIResponses]`
11
+ - `wireInput(request)` — flattens messages into Responses input items `[packages/provider-openai-responses/src/index.ts:wireInput]`
12
+ - `body(options, request, stream)` — builds the JSON request body `[packages/provider-openai-responses/src/index.ts:body]`
13
+ - `result(raw, fallbackModel)` — maps a completed response payload to `ModelResponse` `[packages/provider-openai-responses/src/index.ts:result]`
14
+
15
+ ## Invariants
16
+
17
+ - `store` is always `false` in the request body `[packages/provider-openai-responses/src/index.ts:body]`
18
+ - A `tool` message becomes a `function_call_output` item keyed by `call_id`; assistant tool calls become sibling `function_call` items with `arguments` stringified `[packages/provider-openai-responses/src/index.ts:wireInput]`
19
+ - Tools are sent as `{type:"function", name, description, parameters: inputSchema}`, unwrapped unlike Chat Completions `[packages/provider-openai-responses/src/index.ts:body]`
20
+ - `responseFormat.schema` maps to `text.format` `json_schema` named `response`; without a schema it maps to `json_object` `[packages/provider-openai-responses/src/index.ts:body]`
21
+ - A payload whose `status` is not `"completed"` or whose `output` is not an array is rejected as `malformed_response` `[packages/provider-openai-responses/src/index.ts:result]`
22
+ - Non-object function `arguments` fail closed as `malformed_response` `invalid response function arguments` rather than yielding empty arguments `[packages/provider-openai-responses/src/index.ts:result]`
23
+ - `finishReason` is `tool_calls` when any call was parsed, otherwise `stop` `[packages/provider-openai-responses/src/index.ts:result]`
24
+ - The advertised feature set is fixed at `context_limit: 128000` with `multimodal_input: false`; options cannot widen it `[packages/provider-openai-responses/src/index.ts:openAIResponses]`
25
+ - If a subscription grant is configured, `assertSubscriptionUse` runs before signals and credentials on every request `[packages/provider-openai-responses/src/index.ts:post]`
26
+ - The URL is `baseURL` with one trailing slash removed plus `/responses` `[packages/provider-openai-responses/src/index.ts:post]`
27
+ - Stream events `response.failed`, `error`, and `response.incomplete` raise `unavailable` `Responses did not complete` `[packages/provider-openai-responses/src/index.ts:stream]`
28
+ - Text deltas are only re-sent on `done` when no `response.output_text.delta` was yielded, avoiding duplication `[packages/provider-openai-responses/src/index.ts:stream]`
29
+ - A stream that ends without `response.completed` is `malformed_response`, including a bare `[DONE]` `[packages/provider-openai-responses/src/index.ts:stream]`
30
+
31
+ ## Side Effects
32
+
33
+ - Network: one injected `fetch` POST per call, defaulting to the global `fetch` when `options.fetch` is absent `[packages/provider-openai-responses/src/index.ts:openAIResponses]`
34
+ - Clock: a timeout signal is created from `timeoutMs` through `requestSignal` `[packages/provider-openai-responses/src/index.ts:post]`
35
+ - Secret access: the caller's `CredentialSource.acquire` is awaited per request and its headers are forwarded, never stored `[packages/provider-openai-responses/src/index.ts:post]`
36
+
37
+ ## Verification
38
+
39
+ - Run: `cd packages/provider-openai-responses && bun test`