Skip to main content
Home
Browse packagesDocs
Sign In with GitHubSign In with GitLab

@luca/openai@0.0.1

latest
Works with
It is unknown whether this package works with Node.js, Deno, Browsers, Cloudflare Workers, Bun
It is unknown whether this package works with Node.js
It is unknown whether this package works with Deno
It is unknown whether this package works with Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Bun
•JSR Score29%•
Published2 years ago (0.0.1)
class default
extends Core.APIClient

API Client for interfacing with the OpenAI API.

Constructors

new default(unnamed 0?: ClientOptions)

API Client for interfacing with the OpenAI API.

Static Properties

APIConnectionError
APIConnectionTimeoutError
APIError
APIUserAbortError
AuthenticationError
BadRequestError
ConflictError
DEFAULT_TIMEOUT: number
InternalServerError
NotFoundError
OpenAI
OpenAIError
PermissionDeniedError
RateLimitError
UnprocessableEntityError
fileFromPath
toFile

Properties

apiKey: string
audio: API.Audio
batches: API.Batches
beta: API.Beta
chat: API.Chat
completions: API.Completions
embeddings: API.Embeddings
files: API.Files
fineTuning: API.FineTuning
images: API.Images
models: API.Models
moderations: API.Moderations
organization: string | null
project: string | null
uploads: API.Uploads

Methods

protected
authHeaders(opts: Core.FinalRequestOptions): Core.Headers
protected
defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers
protected
defaultQuery(): Core.DefaultQuery | undefined

Type Aliases

T
default.AudioModel = API.AudioModel
No documentation available
T
default.Batch = API.Batch
No documentation available
T
default.BatchCreateParams = API.BatchCreateParams
No documentation available
T
default.BatchError = API.BatchError
No documentation available
T
default.BatchListParams = API.BatchListParams
No documentation available
T
default.BatchRequestCounts = API.BatchRequestCounts
No documentation available
T
default.ChatCompletion = API.ChatCompletion
No documentation available
T
default.ChatCompletionAssistantMessageParam = API.ChatCompletionAssistantMessageParam
No documentation available
T
default.ChatCompletionChunk = API.ChatCompletionChunk
No documentation available
T
default.ChatCompletionContentPart = API.ChatCompletionContentPart
No documentation available
T
default.ChatCompletionContentPartImage = API.ChatCompletionContentPartImage
No documentation available
T
default.ChatCompletionContentPartRefusal = API.ChatCompletionContentPartRefusal
No documentation available
T
default.ChatCompletionContentPartText = API.ChatCompletionContentPartText
No documentation available
T
default.ChatCompletionCreateParams = API.ChatCompletionCreateParams
No documentation available
T
default.ChatCompletionCreateParamsNonStreaming = API.ChatCompletionCreateParamsNonStreaming
No documentation available
T
default.ChatCompletionCreateParamsStreaming = API.ChatCompletionCreateParamsStreaming
No documentation available
T
default.ChatCompletionFunctionCallOption = API.ChatCompletionFunctionCallOption
No documentation available
T
default.ChatCompletionFunctionMessageParam = API.ChatCompletionFunctionMessageParam
No documentation available
T
default.ChatCompletionMessage = API.ChatCompletionMessage
No documentation available
T
default.ChatCompletionMessageParam = API.ChatCompletionMessageParam
No documentation available
T
default.ChatCompletionMessageToolCall = API.ChatCompletionMessageToolCall
No documentation available
T
default.ChatCompletionNamedToolChoice = API.ChatCompletionNamedToolChoice
No documentation available
T
default.ChatCompletionRole = API.ChatCompletionRole
No documentation available
T
default.ChatCompletionStreamOptions = API.ChatCompletionStreamOptions
No documentation available
T
default.ChatCompletionSystemMessageParam = API.ChatCompletionSystemMessageParam
No documentation available
T
default.ChatCompletionTokenLogprob = API.ChatCompletionTokenLogprob
No documentation available
T
default.ChatCompletionTool = API.ChatCompletionTool
No documentation available
T
default.ChatCompletionToolChoiceOption = API.ChatCompletionToolChoiceOption
No documentation available
T
default.ChatCompletionToolMessageParam = API.ChatCompletionToolMessageParam
No documentation available
T
default.ChatCompletionUserMessageParam = API.ChatCompletionUserMessageParam
No documentation available
T
default.ChatModel = API.ChatModel
No documentation available
T
default.Completion = API.Completion
No documentation available
T
default.CompletionChoice = API.CompletionChoice
No documentation available
T
default.CompletionCreateParams = API.CompletionCreateParams
No documentation available
T
default.CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming
No documentation available
T
default.CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming
No documentation available
T
default.CompletionUsage = API.CompletionUsage
No documentation available
T
default.CreateEmbeddingResponse = API.CreateEmbeddingResponse
No documentation available
T
default.CursorPageParams = Pagination.CursorPageParams
No documentation available
T
default.CursorPageResponse<Item> = Pagination.CursorPageResponse<Item>
No documentation available
T
default.Embedding = API.Embedding
No documentation available
T
default.EmbeddingCreateParams = API.EmbeddingCreateParams
No documentation available
T
default.ErrorObject = API.ErrorObject
No documentation available
T
default.FileContent = API.FileContent
No documentation available
T
default.FileCreateParams = API.FileCreateParams
No documentation available
T
default.FileDeleted = API.FileDeleted
No documentation available
T
default.FileListParams = API.FileListParams
No documentation available
T
default.FileObject = API.FileObject
No documentation available
T
default.FilePurpose = API.FilePurpose
No documentation available
T
default.FunctionDefinition = API.FunctionDefinition
No documentation available
T
default.FunctionParameters = API.FunctionParameters
No documentation available
T
default.Image = API.Image
No documentation available
T
default.ImageCreateVariationParams = API.ImageCreateVariationParams
No documentation available
T
default.ImageEditParams = API.ImageEditParams
No documentation available
T
default.ImageGenerateParams = API.ImageGenerateParams
No documentation available
T
default.ImageModel = API.ImageModel
No documentation available
T
default.ImagesResponse = API.ImagesResponse
No documentation available
T
default.Model = API.Model
No documentation available
T
default.ModelDeleted = API.ModelDeleted
No documentation available
T
default.Moderation = API.Moderation
No documentation available
T
default.ModerationCreateParams = API.ModerationCreateParams
No documentation available
T
default.ModerationCreateResponse = API.ModerationCreateResponse
No documentation available
T
default.ModerationModel = API.ModerationModel
No documentation available
T
default.PageResponse<Item> = Pagination.PageResponse<Item>
No documentation available
T
default.RequestOptions = Core.RequestOptions
No documentation available
T
default.ResponseFormatJSONObject = API.ResponseFormatJSONObject
No documentation available
T
default.ResponseFormatJSONSchema = API.ResponseFormatJSONSchema
No documentation available
T
default.ResponseFormatText = API.ResponseFormatText
No documentation available
T
default.Upload = API.Upload
No documentation available
T
default.UploadCompleteParams = API.UploadCompleteParams
No documentation available
T
default.UploadCreateParams = API.UploadCreateParams
No documentation available
namespace default

API Client for interfacing with the OpenAI API.

Constructors

new default(unnamed 0?: ClientOptions)

API Client for interfacing with the OpenAI API.

Static Properties

APIConnectionError
APIConnectionTimeoutError
APIError
APIUserAbortError
AuthenticationError
BadRequestError
ConflictError
DEFAULT_TIMEOUT: number
InternalServerError
NotFoundError
OpenAI
OpenAIError
PermissionDeniedError
RateLimitError
UnprocessableEntityError
fileFromPath
toFile

Properties

apiKey: string
audio: API.Audio
batches: API.Batches
beta: API.Beta
chat: API.Chat
completions: API.Completions
embeddings: API.Embeddings
files: API.Files
fineTuning: API.FineTuning
images: API.Images
models: API.Models
moderations: API.Moderations
organization: string | null
project: string | null
uploads: API.Uploads

Methods

protected
authHeaders(opts: Core.FinalRequestOptions): Core.Headers
protected
defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers
protected
defaultQuery(): Core.DefaultQuery | undefined

Type Aliases

T
default.AudioModel = API.AudioModel
No documentation available
T
default.Batch = API.Batch
No documentation available
T
default.BatchCreateParams = API.BatchCreateParams
No documentation available
T
default.BatchError = API.BatchError
No documentation available
T
default.BatchListParams = API.BatchListParams
No documentation available
T
default.BatchRequestCounts = API.BatchRequestCounts
No documentation available
T
default.ChatCompletion = API.ChatCompletion
No documentation available
T
default.ChatCompletionAssistantMessageParam = API.ChatCompletionAssistantMessageParam
No documentation available
T
default.ChatCompletionChunk = API.ChatCompletionChunk
No documentation available
T
default.ChatCompletionContentPart = API.ChatCompletionContentPart
No documentation available
T
default.ChatCompletionContentPartImage = API.ChatCompletionContentPartImage
No documentation available
T
default.ChatCompletionContentPartRefusal = API.ChatCompletionContentPartRefusal
No documentation available
T
default.ChatCompletionContentPartText = API.ChatCompletionContentPartText
No documentation available
T
default.ChatCompletionCreateParams = API.ChatCompletionCreateParams
No documentation available
T
default.ChatCompletionCreateParamsNonStreaming = API.ChatCompletionCreateParamsNonStreaming
No documentation available
T
default.ChatCompletionCreateParamsStreaming = API.ChatCompletionCreateParamsStreaming
No documentation available
T
default.ChatCompletionFunctionCallOption = API.ChatCompletionFunctionCallOption
No documentation available
T
default.ChatCompletionFunctionMessageParam = API.ChatCompletionFunctionMessageParam
No documentation available
T
default.ChatCompletionMessage = API.ChatCompletionMessage
No documentation available
T
default.ChatCompletionMessageParam = API.ChatCompletionMessageParam
No documentation available
T
default.ChatCompletionMessageToolCall = API.ChatCompletionMessageToolCall
No documentation available
T
default.ChatCompletionNamedToolChoice = API.ChatCompletionNamedToolChoice
No documentation available
T
default.ChatCompletionRole = API.ChatCompletionRole
No documentation available
T
default.ChatCompletionStreamOptions = API.ChatCompletionStreamOptions
No documentation available
T
default.ChatCompletionSystemMessageParam = API.ChatCompletionSystemMessageParam
No documentation available
T
default.ChatCompletionTokenLogprob = API.ChatCompletionTokenLogprob
No documentation available
T
default.ChatCompletionTool = API.ChatCompletionTool
No documentation available
T
default.ChatCompletionToolChoiceOption = API.ChatCompletionToolChoiceOption
No documentation available
T
default.ChatCompletionToolMessageParam = API.ChatCompletionToolMessageParam
No documentation available
T
default.ChatCompletionUserMessageParam = API.ChatCompletionUserMessageParam
No documentation available
T
default.ChatModel = API.ChatModel
No documentation available
T
default.Completion = API.Completion
No documentation available
T
default.CompletionChoice = API.CompletionChoice
No documentation available
T
default.CompletionCreateParams = API.CompletionCreateParams
No documentation available
T
default.CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming
No documentation available
T
default.CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming
No documentation available
T
default.CompletionUsage = API.CompletionUsage
No documentation available
T
default.CreateEmbeddingResponse = API.CreateEmbeddingResponse
No documentation available
T
default.CursorPageParams = Pagination.CursorPageParams
No documentation available
T
default.CursorPageResponse<Item> = Pagination.CursorPageResponse<Item>
No documentation available
T
default.Embedding = API.Embedding
No documentation available
T
default.EmbeddingCreateParams = API.EmbeddingCreateParams
No documentation available
T
default.ErrorObject = API.ErrorObject
No documentation available
T
default.FileContent = API.FileContent
No documentation available
T
default.FileCreateParams = API.FileCreateParams
No documentation available
T
default.FileDeleted = API.FileDeleted
No documentation available
T
default.FileListParams = API.FileListParams
No documentation available
T
default.FileObject = API.FileObject
No documentation available
T
default.FilePurpose = API.FilePurpose
No documentation available
T
default.FunctionDefinition = API.FunctionDefinition
No documentation available
T
default.FunctionParameters = API.FunctionParameters
No documentation available
T
default.Image = API.Image
No documentation available
T
default.ImageCreateVariationParams = API.ImageCreateVariationParams
No documentation available
T
default.ImageEditParams = API.ImageEditParams
No documentation available
T
default.ImageGenerateParams = API.ImageGenerateParams
No documentation available
T
default.ImageModel = API.ImageModel
No documentation available
T
default.ImagesResponse = API.ImagesResponse
No documentation available
T
default.Model = API.Model
No documentation available
T
default.ModelDeleted = API.ModelDeleted
No documentation available
T
default.Moderation = API.Moderation
No documentation available
T
default.ModerationCreateParams = API.ModerationCreateParams
No documentation available
T
default.ModerationCreateResponse = API.ModerationCreateResponse
No documentation available
T
default.ModerationModel = API.ModerationModel
No documentation available
T
default.PageResponse<Item> = Pagination.PageResponse<Item>
No documentation available
T
default.RequestOptions = Core.RequestOptions
No documentation available
T
default.ResponseFormatJSONObject = API.ResponseFormatJSONObject
No documentation available
T
default.ResponseFormatJSONSchema = API.ResponseFormatJSONSchema
No documentation available
T
default.ResponseFormatText = API.ResponseFormatText
No documentation available
T
default.Upload = API.Upload
No documentation available
T
default.UploadCompleteParams = API.UploadCompleteParams
No documentation available
T
default.UploadCreateParams = API.UploadCreateParams
No documentation available

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@luca/openai

Import symbol

import mod from "@luca/openai";
or

Import directly with a jsr specifier

import mod from "jsr:@luca/openai";