Skip to main content
Home
Browse packagesDocsSign in

@agent/openai@0.0.8

latest

A tiny (1.18kB), tree-shakeable OpenAI client. Optionally supports response streaming in all JavaScript runtimes.

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
82%
Published
6 months ago (0.0.8)
function stream
stream<
T,
I extends Input & { stream: true; } = Input & { stream: true; },
>(
credentials: Credentials,
options: Options<I>,
): Promise<ReadableStream<T>>

Send a HTTP request and, if 2xx, begin streaming the chunks of T object type.

The request body (options.body) is required if I is defined, otherwise I is inferred.

NOTE: The Response is thrown if not 2xx status!

Examples

Usage

import * as OpenAI from '@agent/openai';

let ctx = OpenAI.credentials({
  apikey: '...',
});

// NOTE: may throw
let events = await OpenAI.stream<
  OpenAI.Chat.Stream.Chunk,
  OpenAI.Chat.Stream.Request,
>(ctx, {
  method: 'POST',
  path: '/chat/completions',
  body: {
    stream: true,
    model: '...',
    messages: [...]
  },
});

for await (let msg of events) {
  console.log(msg.choices);
}

Type Parameters

I extends Input & { stream: true; } = Input & { stream: true; }

Parameters

credentials: Credentials
options: Options<I>

Return Type

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@agent/openai

Import symbol

import { stream } from "@agent/openai";
or

Import directly with a jsr specifier

import { stream } from "jsr:@agent/openai";

Add Package

pnpm i jsr:@agent/openai
or (using pnpm 10.8 or older)
pnpm dlx jsr add @agent/openai

Import symbol

import { stream } from "@agent/openai";

Add Package

yarn add jsr:@agent/openai
or (using Yarn 4.8 or older)
yarn dlx jsr add @agent/openai

Import symbol

import { stream } from "@agent/openai";

Add Package

vlt install jsr:@agent/openai

Import symbol

import { stream } from "@agent/openai";

Add Package

npx jsr add @agent/openai

Import symbol

import { stream } from "@agent/openai";

Add Package

bunx jsr add @agent/openai

Import symbol

import { stream } from "@agent/openai";