Class OpenAI

OpenAI: AI Service

Export

Hierarchy (view full)

BaseAI<OpenAIChatRequest, OpenAIEmbedRequest, OpenAIChatResponse, OpenAIChatResponseDelta, OpenAIEmbedResponse>
- OpenAI

Constructors

constructor

new OpenAI(__namedParameters): OpenAI
Parameters
- __namedParameters: Readonly<OpenAIArgs>
Returns OpenAI
Overrides BaseAI< OpenAIChatRequest, OpenAIEmbedRequest, OpenAIChatResponse, OpenAIChatResponseDelta, OpenAIEmbedResponse >.constructor
- Defined in src/ai/openai/api.ts:87

Properties

`Protected` apiURL

apiURL: string

`Private` config

config: OpenAIConfig

`Protected` `Optional` embedModelInfo

embedModelInfo?: TextModelInfo

`Protected` headers

headers: Record<string, string>

`Protected` modelInfo

modelInfo: TextModelInfo

`Protected` name

name: string

`Protected` supportFor

supportFor: {
functions: boolean;
}

Type declaration

functions: boolean

Methods

chat

chat(_req, options?): Promise<TextResponse | ReadableStream<TextResponse>>
Parameters
- _req: Readonly<AITextChatRequest>
- Optional options: Readonly<AIPromptConfig & AIServiceActionOptions>
Returns Promise<TextResponse | ReadableStream<TextResponse>>
Inherited from BaseAI.chat
- Defined in src/ai/base.ts:207

embed

embed(req, options?): Promise<EmbedResponse>
Parameters
- req: Readonly<AITextEmbedRequest>
- Optional options: Readonly<AIServiceActionOptions>
Returns Promise<EmbedResponse>
Inherited from BaseAI.embed
- Defined in src/ai/base.ts:294

generateChatReq

generateChatReq(req, _config): [API, OpenAIChatRequest]
Parameters
- req: Readonly<AITextChatRequest>
- _config: Readonly<AIPromptConfig>
Returns [API, OpenAIChatRequest]
Overrides BaseAI.generateChatReq
- Defined in src/ai/openai/api.ts:126

generateChatResp

generateChatResp(resp): TextResponse
Parameters
- resp: Readonly<OpenAIChatResponse>
Returns TextResponse
Overrides BaseAI.generateChatResp
- Defined in src/ai/openai/api.ts:251

generateChatStreamResp

generateChatStreamResp(resp): TextResponse
Parameters
- resp: Readonly<OpenAIChatResponseDelta>
Returns TextResponse
Overrides BaseAI.generateChatStreamResp
- Defined in src/ai/openai/api.ts:288

generateEmbedReq

generateEmbedReq(req): [API, OpenAIEmbedRequest]
Parameters
- req: Readonly<AITextEmbedRequest>
Returns [API, OpenAIEmbedRequest]
Overrides BaseAI.generateEmbedReq
- Defined in src/ai/openai/api.ts:221

generateEmbedResp

generateEmbedResp(resp): EmbedResponse
Parameters
- resp: Readonly<OpenAIEmbedResponse>
Returns EmbedResponse
Overrides BaseAI.generateEmbedResp
- Defined in src/ai/openai/api.ts:321

getEmbedModelInfo

getEmbedModelInfo(): undefined | TextModelInfoWithProvider
Returns undefined | TextModelInfoWithProvider
Inherited from BaseAI.getEmbedModelInfo
- Defined in src/ai/base.ts:150

getFeatures

getFeatures(): {
functions: boolean;
}
Returns {
functions: boolean;
}
- functions: boolean
Inherited from BaseAI.getFeatures
- Defined in src/ai/base.ts:160

getModelConfig

getModelConfig(): TextModelConfig
Returns TextModelConfig
Overrides BaseAI.getModelConfig
- Defined in src/ai/openai/api.ts:108

getModelInfo

getModelInfo(): Readonly<TextModelInfoWithProvider>
Returns Readonly<TextModelInfoWithProvider>
Inherited from BaseAI.getModelInfo
- Defined in src/ai/base.ts:146

getName

getName(): string
Returns string
Inherited from BaseAI.getName
- Defined in src/ai/base.ts:156

getTraceRequest

getTraceRequest(): undefined | Readonly<TextRequestBuilder>
Returns undefined | Readonly<TextRequestBuilder>
Inherited from BaseAI.getTraceRequest
- Defined in src/ai/base.ts:168

getTraceResponse

getTraceResponse(): undefined | Readonly<TextResponseBuilder>
Returns undefined | Readonly<TextResponseBuilder>
Inherited from BaseAI.getTraceResponse
- Defined in src/ai/base.ts:172

logTrace

logTrace(): Promise<void>
Returns Promise<void>
Inherited from BaseAI.logTrace
- Defined in src/ai/base.ts:184

setAPIURL

setAPIURL(apiURL): void
Parameters
- apiURL: string
Returns void
Inherited from BaseAI.setAPIURL
- Defined in src/ai/base.ts:116

setHeaders

setHeaders(headers): void
Parameters
- headers: Record<string, string>
Returns void
Inherited from BaseAI.setHeaders
- Defined in src/ai/base.ts:120

setName

setName(name): void
Parameters
- name: string
Returns void
Inherited from BaseAI.setName
- Defined in src/ai/base.ts:112

setOptions

setOptions(options): void
Parameters
- options: Readonly<AIServiceOptions>
Returns void
Inherited from BaseAI.setOptions
- Defined in src/ai/base.ts:124

setStep

setStep(options?): void
Parameters
- Optional options: Readonly<AIServiceActionOptions>
Returns void
Inherited from BaseAI.setStep
- Defined in src/ai/base.ts:377

setStepTextResponse

setStepTextResponse(res, startTime): Promise<void>
Parameters
- res: Readonly<TextResponse>
- startTime: number
Returns Promise<void>
Inherited from BaseAI.setStepTextResponse
- Defined in src/ai/base.ts:383

traceExists

traceExists(): boolean
Returns boolean
Inherited from BaseAI.traceExists
- Defined in src/ai/base.ts:176