@agent/openai@0.0.8

latest

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

JSR Score

82%

Published

5 months ago (0.0.8)

@agent/openai

Client

class Client

Examples

Example 1

let client = new OpenAI.Client({
  apikey: '...',
});

// NOTE: All methods can throw!
let reply = await client.completion({
  model: '...',
  prompt: '...',
});

console.assert(reply.object === 'text_completion');

// NOTE: All methods can throw!
let stream = await client.completion({
  model: '...',
  prompt: '...',
  stream: true, // << required!
});

for await (let event of stream) {
  console.assert(event.object === 'text_completion')
}

Constructors

new



Client(options: AuthOptions)

Methods



chat(input: Chat.Request,
signal?: AbortSignal,
): Promise<Chat.Output>

Dispatch a Chat Completions request.

When input includes stream: true, then a ReadableStream is returned for message streaming. Otherwise the full Chat.Output JSON object is returned.

Important: Will throw the Response on 4xx or 5xx status!



chat(input: Chat.Stream.Request,
signal?: AbortSignal,
): Promise<Chat.Stream.Output>



completion(input: Completion.Stream.Request,
signal?: AbortSignal,
): Promise<Completion.Stream.Output>

Dispatch a Completions (legacy) request.

When input includes stream: true, then a ReadableStream is returned for message streaming. Otherwise the full Completion.Output JSON object is returned.

Important: Will throw the Response on 4xx or 5xx status!



completion(input: Completion.Request,
signal?: AbortSignal,
): Promise<Completion.Output>



fetch(input: Request
 | URL
 | string,
init?: RequestInit,
): Promise<Response>

The fetch implementation.

NOTE: You may override method with a custom definition.

Add Package

deno add jsr:@agent/openai

Import symbol

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

Import directly with a jsr specifier

import { Client } 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 { Client } 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 { Client } from "@agent/openai";

Add Package

vlt install jsr:@agent/openai

Import symbol

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

Add Package

npx jsr add @agent/openai

Import symbol

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

Add Package

bunx jsr add @agent/openai

Import symbol

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

@agent/openai@0.0.8

Examples

Example 1

Constructors

Methods

New Ticket: Report package