Loading...
Skip to main content

Module: lib/openai

This module provides interfaces to OpenAI's various models.

Type Aliases

ValidChatModel

Ƭ ValidChatModel: "gpt-4" | "gpt-4-0314" | "gpt-4-0613" | "gpt-4-32k" | "gpt-4-32k-0314" | "gpt-4-32k-0613" | "gpt-4-1106-preview" | "gpt-3.5-turbo" | "gpt-3.5-turbo-0301" | "gpt-3.5-turbo-0613" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo-16k-0613" | "gpt-3.5-turbo-1106"

Defined in

ai-jsx/src/lib/openai.tsx:37


ValidCompletionModel

Ƭ ValidCompletionModel: "text-davinci-003" | "text-davinci-002" | "text-curie-001" | "text-babbage-001" | "text-ada-001" | "gpt-3.5-turbo-instruct"

Defined in

ai-jsx/src/lib/openai.tsx:29

Variables

tokenizer

Const tokenizer: Object

Type declaration

NameType
decode(tokens: number[]) => string
encode(text: string) => number[]

Defined in

ai-jsx/src/lib/openai.tsx:139

Functions

DalleImageGen

DalleImageGen(numSamples, size): AsyncGenerator<Element, Element[], unknown>

Generates an image from a prompt using the DALL-E model.

See

https://platform.openai.com/docs/guides/images/introduction

Parameters

NameTypeDescription
numSamplesImageGenPropsWithChildrenThe number of images to generate. Defaults to 1.
sizeComponentContextThe size of the image to generate. Defaults to 512x512.

Returns

AsyncGenerator<Element, Element[], unknown>

URL(s) to the generated image, wrapped in Image component(s).

Defined in

ai-jsx/src/lib/openai.tsx:704


OpenAI

OpenAI(«destructured»): Node

An AI.JSX component that invokes an OpenAI Large Language Model.

Parameters

NameType
«destructured»{ children: Node ; chatModel?: ValidChatModel ; client?: OpenAI ; completionModel?: ValidCompletionModel } & ModelProps

Returns

Node

Defined in

ai-jsx/src/lib/openai.tsx:100


OpenAIChatModel

OpenAIChatModel(props, «destructured»): RenderableStream

Represents an OpenAI text chat model (e.g., gpt-4).

Parameters

NameType
propsObject
«destructured»ComponentContext

Returns

RenderableStream

Defined in

ai-jsx/src/lib/openai.tsx:377


OpenAICompletionModel

OpenAICompletionModel(props, «destructured»): RenderableStream

Represents an OpenAI text completion model (e.g., text-davinci-003).

Parameters

NameType
propsModelProps & { children: Node } & { model: ValidCompletionModel ; logitBias?: Record<string, number> }
«destructured»ComponentContext

Returns

RenderableStream

Defined in

ai-jsx/src/lib/openai.tsx:172