@polyweave/openai (1.0.6)

Published 2026-07-10 19:07:56 +00:00 by Dvorak

Set up this registry in your project .npmrc file:

@polyweave:registry=https://hub.kl1.tenere.ai/api/packages/Polyweave/npm/

To install the package using npm, run the following command:

npm install @polyweave/openai@1.0.6

or add it to the package.json file:

"@polyweave/openai": "1.0.6"

For more information on the npm registry, see the documentation.

@polyweave/openai

OpenAI adapter for Polyweave - wraps the official OpenAI SDK to provide a Frame-based duplex stream interface. Supports chat completions (text, vision, audio I/O, tools, streaming), TTS, transcription, translation, image generation/editing, and embeddings.

Synopsis

import { createOpenAIAdapter } from '@polyweave/openai';

const adapter = createOpenAIAdapter({ apiKey: 'YOUR_API_KEY' });
adapter.source.pipe(someSink);
adapter.sink.write({ type: 'PARAM', content: { key: 'model', value: 'gpt-4o' } });
adapter.sink.write({ type: 'TEXT', content: { text: 'Hello!' } });

Install

npm install @polyweave/openai

API

`createOpenAIAdapter(config)`

Returns an IFrameDuplex stream adapter. Configuration options:

Option	Type	Default	Description
`apiKey`	string	`process.env.OPENAI_API_KEY`	OpenAI API key
`organization`	string	`process.env.OPENAI_ORG_ID`	Organization ID
`project`	string	`process.env.OPENAI_PROJECT_ID`	Project ID
`baseURL`	string	auto	API base URL
`timeout`	number	`60000`	Request timeout in ms
`maxRetries`	number	`2`	Max retry count

Frame Types

Input: TEXT, AUDIO, IMAGE, EMBEDDING, TOOL_RESULT, PARAM, COST_CHECK, START, END
Output: TEXT, AUDIO, IMAGE, EMBEDDING, TOOL_CALL, RECEIPT, ERROR, COST, END

Tasks

Route via task PARAM: tts, transcription, translation, image, embedding, diarization. Default: chat completion with full tool calling and streaming support.

Tests

npm test

Requirements

Node.js >= 18.0.0
@polyweave/core (peer)
@polyweave/errors (peer)

License

MIT

Dependencies

ID	Version
openai	^6.15.0

Development Dependencies

ID	Version
@rigor/core	*

Peer Dependencies

ID	Version
@polyweave/core	*
@polyweave/costs	*
@polyweave/errors	*
@polyweave/push-websocket	*

polyweave openai gpt ai adapter

Details

npm

2026-07-10 19:07:56 +00:00

339

John Dvorak

SEE LICENSE IN LICENSE

20 KiB

Assets (1)

openai-1.0.6.tgz 20 KiB

Versions (3) View all

1.0.10

2026-07-11

1.0.7

2026-07-11

1.0.6

2026-07-10