Skip to main content

Class: TogetherLLM

OpenAI LLM implementation

Hierarchy

Constructors

constructor

new TogetherLLM(init?): TogetherLLM

Parameters

NameType
init?Partial<OpenAI>

Returns

TogetherLLM

Overrides

OpenAI.constructor

Defined in

packages/core/src/llm/together.ts:5

Properties

additionalChatOptions

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

Inherited from

OpenAI.additionalChatOptions

Defined in

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


additionalSessionOptions

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

Inherited from

OpenAI.additionalSessionOptions

Defined in

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


apiKey

Optional apiKey: string = undefined

Inherited from

OpenAI.apiKey

Defined in

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


callbackManager

Optional callbackManager: CallbackManager

Inherited from

OpenAI.callbackManager

Defined in

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


maxRetries

maxRetries: number

Inherited from

OpenAI.maxRetries

Defined in

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


maxTokens

Optional maxTokens: number

Inherited from

OpenAI.maxTokens

Defined in

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


model

model: string

Inherited from

OpenAI.model

Defined in

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


session

session: OpenAISession

Inherited from

OpenAI.session

Defined in

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


temperature

temperature: number

Inherited from

OpenAI.temperature

Defined in

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


timeout

Optional timeout: number

Inherited from

OpenAI.timeout

Defined in

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


topP

topP: number

Inherited from

OpenAI.topP

Defined in

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

Accessors

metadata

get metadata(): Object

Returns

Object

NameType
contextWindownumber
isFunctionCallingModelboolean
maxTokensundefined | number
modelstring
temperaturenumber
tokenizerCL100K_BASE
topPnumber

Inherited from

OpenAI.metadata

Defined in

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

Methods

chat

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

Parameters

NameType
paramsLLMChatParamsStreaming

Returns

Promise<AsyncIterable<ChatResponseChunk>>

Inherited from

OpenAI.chat

Defined in

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

chat(params): Promise<ChatResponse>

Parameters

NameType
paramsLLMChatParamsNonStreaming

Returns

Promise<ChatResponse>

Inherited from

OpenAI.chat

Defined in

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


complete

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

Parameters

NameType
paramsLLMCompletionParamsStreaming

Returns

Promise<AsyncIterable<CompletionResponse>>

Inherited from

OpenAI.complete

Defined in

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

complete(params): Promise<CompletionResponse>

Parameters

NameType
paramsLLMCompletionParamsNonStreaming

Returns

Promise<CompletionResponse>

Inherited from

OpenAI.complete

Defined in

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


mapMessageType

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

Parameters

NameType
messageTypeMessageType

Returns

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

Inherited from

OpenAI.mapMessageType

Defined in

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


streamChat

streamChat(«destructured»): AsyncIterable<ChatResponseChunk>

Parameters

NameType
«destructured»LLMChatParamsStreaming

Returns

AsyncIterable<ChatResponseChunk>

Inherited from

OpenAI.streamChat

Defined in

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


toOpenAIMessage

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

Parameters

NameType
messagesChatMessage[]

Returns

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

Inherited from

OpenAI.toOpenAIMessage

Defined in

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


tokens

tokens(messages): number

Parameters

NameType
messagesChatMessage[]

Returns

number

Inherited from

OpenAI.tokens

Defined in

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