跳转到内容
LlamaIndex TypeScript API Reference

OpenAI

定义于：.build/typescript/packages/providers/openai/src/llm.ts:62

扩展

Section titled “Extends”
  • ToolCallLLM<OpenAIAdditionalChatOptions>

构造函数

Section titled “Constructors”

构造函数

Section titled “Constructor”

new OpenAI(init?): OpenAI

定义于：.build/typescript/packages/providers/openai/src/llm.ts:94

参数

Section titled “Parameters”
初始化？
Section titled “init?”

Omit<Partial<OpenAI>, "session"> & object

返回

Section titled “Returns”

OpenAI

覆盖设置

Section titled “Overrides”

ToolCallLLM<OpenAIAdditionalChatOptions>.constructor

属性

Section titled “Properties”

模型

Section titled “model”

模型: ChatModel | string & object

定义于：.build/typescript/packages/providers/openai/src/llm.ts:63

温度

Section titled “temperature”

temperature: number

定义于：.build/typescript/packages/providers/openai/src/llm.ts:67

推理力度？

Section titled “reasoningEffort?”

optional 推理强度: "low" | "medium" | "high" | "minimal"

定义于：.build/typescript/packages/providers/openai/src/llm.ts:68

topP

Section titled “topP”

topP: number

定义于：.build/typescript/packages/providers/openai/src/llm.ts:69

最大令牌数？

Section titled “maxTokens?”

optional maxTokens: number

定义于：.build/typescript/packages/providers/openai/src/llm.ts:70

additionalChatOptions?

Section titled “additionalChatOptions?”

optional additionalChatOptions: OpenAIAdditionalChatOptions

定义于：.build/typescript/packages/providers/openai/src/llm.ts:71

API密钥？

Section titled “apiKey?”

optional apiKey: string = undefined

定义于：.build/typescript/packages/providers/openai/src/llm.ts:74

基础URL？

Section titled “baseURL?”

optional 基础URL: string = undefined

定义于：.build/typescript/packages/providers/openai/src/llm.ts:75

maxRetries

Section titled “maxRetries”

maxRetries: number

定义于：.build/typescript/packages/providers/openai/src/llm.ts:76

超时？

Section titled “timeout?”

optional timeout: number

定义于：.build/typescript/packages/providers/openai/src/llm.ts:77

additionalSessionOptions?

Section titled “additionalSessionOptions?”

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

定义于：.build/typescript/packages/providers/openai/src/llm.ts:78

lazySession()

Section titled “lazySession()”

lazySession: () => Promise<LLMInstance>

定义于：.build/typescript/packages/providers/openai/src/llm.ts:85

返回

Section titled “Returns”

Promise<LLMInstance>

访问器

Section titled “Accessors”

会话

Section titled “session”

获取签名

Section titled “Get Signature”

get session(): Promise<LLMInstance>

定义于：.build/typescript/packages/providers/openai/src/llm.ts:87

返回
Section titled “Returns”

Promise<LLMInstance>

supportToolCall

Section titled “supportToolCall”

获取签名

Section titled “Get Signature”

get supportToolCall(): boolean

定义于：.build/typescript/packages/providers/openai/src/llm.ts:132

返回
Section titled “Returns”

boolean

覆盖设置

Section titled “Overrides”

ToolCallLLM.supportToolCall

实时

Section titled “live”

获取签名

Section titled “Get Signature”

get live(): OpenAILive

定义于：.build/typescript/packages/providers/openai/src/llm.ts:136

返回
Section titled “Returns”

OpenAILive

元数据

Section titled “metadata”

获取签名

Section titled “Get Signature”

get metadata(): LLMMetadata & object

定义于：.build/typescript/packages/providers/openai/src/llm.ts:147

返回
Section titled “Returns”

LLMMetadata & object

覆盖设置

Section titled “Overrides”

ToolCallLLM.metadata

方法

Section titled “Methods”

toOpenAIRole()

Section titled “toOpenAIRole()”

static toOpenAIRole(messageType): ChatCompletionRole

定义于：.build/typescript/packages/providers/openai/src/llm.ts:163

参数

Section titled “Parameters”
messageType
Section titled “messageType”

MessageType

返回

Section titled “Returns”

ChatCompletionRole

toOpenAIMessage()

Section titled “toOpenAIMessage()”

static toOpenAIMessage(messages): ChatCompletionMessageParam[]

定义于：.build/typescript/packages/providers/openai/src/llm.ts:176

参数

Section titled “Parameters”
消息
Section titled “messages”

ChatMessage<ToolCallLLMMessageOptions>[]

返回

Section titled “Returns”

ChatCompletionMessageParam[]

chat()

Section titled “chat()”

调用签名

Section titled “Call Signature”

聊天(params): Promise<AsyncIterable<ChatResponseChunk<ToolCallLLMMessageOptions>, any, any>>

定义于：.build/typescript/packages/providers/openai/src/llm.ts:267

参数
Section titled “Parameters”
参数
Section titled “params”

LLMChatParamsStreaming<OpenAIAdditionalChatOptions, ToolCallLLMMessageOptions>

返回
Section titled “Returns”

Promise<AsyncIterable<ChatResponseChunk<ToolCallLLMMessageOptions>, any, any>>

覆盖设置
Section titled “Overrides”

ToolCallLLM.chat

调用签名

Section titled “Call Signature”

chat(params): Promise<ChatResponse<ToolCallLLMMessageOptions>>

定义于：.build/typescript/packages/providers/openai/src/llm.ts:273

参数
Section titled “Parameters”
参数
Section titled “params”

LLMChatParamsNonStreaming<OpenAIAdditionalChatOptions, ToolCallLLMMessageOptions>

返回
Section titled “Returns”

Promise<ChatResponse<ToolCallLLMMessageOptions>>

覆盖设置
Section titled “Overrides”

ToolCallLLM.chat

streamChat()

Section titled “streamChat()”

protected streamChat(baseRequestParams): AsyncIterable<ChatResponseChunk<ToolCallLLMMessageOptions>>

定义于：.build/typescript/packages/providers/openai/src/llm.ts:370

参数

Section titled “Parameters”
baseRequestParams
Section titled “baseRequestParams”

ChatCompletionCreateParams

返回

Section titled “Returns”

AsyncIterable<ChatResponseChunk<ToolCallLLMMessageOptions>>

toTool()

Section titled “toTool()”

static toTool(tool): ChatCompletionTool

定义于：.build/typescript/packages/providers/openai/src/llm.ts:453

参数

Section titled “Parameters”
工具
Section titled “tool”

BaseTool

返回

Section titled “Returns”

ChatCompletionTool