Class: OpenAI

OpenAI LLM implementation

Hierarchy

• BaseLLM

  ↳ OpenAI

  ↳↳ FireworksLLM

  ↳↳ Groq

  ↳↳ TogetherLLM

Constructors

constructor

• new OpenAI(init?): OpenAI

Parameters

Name	Type
init?	Partial<OpenAI> & { azure?: AzureOpenAIConfig }

Returns

OpenAI

Overrides

BaseLLM.constructor

Defined in

packages/core/src/llm/LLM.ts:106

Properties

additionalChatOptions

• Optional additionalChatOptions: Omit<Partial<ChatCompletionCreateParams>, "stream" | "max_tokens" | "messages" | "model" | "temperature" | "top_p" | "tools" | "toolChoice">

Defined in

packages/core/src/llm/LLM.ts:82

---

additionalSessionOptions

• Optional additionalSessionOptions: Omit<Partial<ClientOptions>, "apiKey" | "timeout" | "maxRetries">

Defined in

packages/core/src/llm/LLM.ts:99

---

apiKey

• Optional apiKey: string = undefined

Defined in

packages/core/src/llm/LLM.ts:95

---

callbackManager

• Optional callbackManager: CallbackManager

Defined in

packages/core/src/llm/LLM.ts:104

---

maxRetries

• maxRetries: number

Defined in

packages/core/src/llm/LLM.ts:96

---

maxTokens

• Optional maxTokens: number

Defined in

packages/core/src/llm/LLM.ts:81

---

model

• model: string

Defined in

packages/core/src/llm/LLM.ts:78

---

session

• session: OpenAISession

Defined in

packages/core/src/llm/LLM.ts:98

---

temperature

• temperature: number

Defined in

packages/core/src/llm/LLM.ts:79

---

timeout

• Optional timeout: number

Defined in

packages/core/src/llm/LLM.ts:97

---

topP

• topP: number

Defined in

packages/core/src/llm/LLM.ts:80

Accessors

metadata

• get metadata(): Object

Returns

Object

Name	Type
contextWindow	number
isFunctionCallingModel	boolean
maxTokens	undefined | number
model	string
temperature	number
tokenizer	CL100K_BASE
topP	number

Overrides

BaseLLM.metadata

Defined in

packages/core/src/llm/LLM.ts:161

Methods

chat

▸ chat(params): Promise<AsyncIterable<ChatResponseChunk>>

Parameters

Name	Type
params	LLMChatParamsStreaming

Returns

Promise<AsyncIterable<ChatResponseChunk>>

Overrides

BaseLLM.chat

Defined in

packages/core/src/llm/LLM.ts:228

▸ chat(params): Promise<ChatResponse>

Parameters

Name	Type
params	LLMChatParamsNonStreaming

Returns

Promise<ChatResponse>

Overrides

BaseLLM.chat

Defined in

packages/core/src/llm/LLM.ts:231

---

complete

▸ complete(params): Promise<AsyncIterable<CompletionResponse>>

Parameters

Name	Type
params	LLMCompletionParamsStreaming

Returns

Promise<AsyncIterable<CompletionResponse>>

Inherited from

BaseLLM.complete

Defined in

packages/core/src/llm/base.ts:18

▸ complete(params): Promise<CompletionResponse>

Parameters

Name	Type
params	LLMCompletionParamsNonStreaming

Returns

Promise<CompletionResponse>

Inherited from

BaseLLM.complete

Defined in

packages/core/src/llm/base.ts:21

---

mapMessageType

▸ mapMessageType(messageType): "function" | "user" | "assistant" | "system" | "tool"

Parameters

Name	Type
messageType	MessageType

Returns

"function" | "user" | "assistant" | "system" | "tool"

Defined in

packages/core/src/llm/LLM.ts:192

---

streamChat

▸ streamChat(«destructured»): AsyncIterable<ChatResponseChunk>

Parameters

Name	Type
«destructured»	LLMChatParamsStreaming

Returns

AsyncIterable<ChatResponseChunk>

Defined in

packages/core/src/llm/LLM.ts:275

---

toOpenAIMessage

▸ toOpenAIMessage(messages): { content: any = message.content; role: "function" | "user" | "assistant" | "system" | "tool" }[]

Parameters

Name	Type
messages	ChatMessage[]

Returns

{ content: any = message.content; role: "function" | "user" | "assistant" | "system" | "tool" }[]

Defined in

packages/core/src/llm/LLM.ts:211

---

tokens

▸ tokens(messages): number

Parameters

Name	Type
messages	ChatMessage[]

Returns

number

Overrides

BaseLLM.tokens

Defined in

packages/core/src/llm/LLM.ts:177