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)

Classes

c
AzureOpenAI(unnamed 0?: AzureClientOptions)

API Client for interfacing with the Azure OpenAI API.

  • _azureADTokenProvider: (() => Promise<string>) | undefined
    No documentation available
  • _deployment: string | undefined
    No documentation available
  • _getAzureADToken(): Promise<string | undefined>
    No documentation available
  • apiVersion: string
    No documentation available
  • authHeaders(opts: Core.FinalRequestOptions): Core.Headers
    No documentation available
  • buildRequest(options: Core.FinalRequestOptions<unknown>): { req: RequestInit; url: string; timeout: number; }
    No documentation available
  • prepareOptions(opts: Core.FinalRequestOptions<unknown>): Promise<void>
    No documentation available
c
N
default(unnamed 0?: ClientOptions)

API Client for interfacing with the OpenAI API.

c
N
OpenAI(unnamed 0?: ClientOptions)

API Client for interfacing with the OpenAI API.

Functions

f
toFile(
value: ToFileInput | PromiseLike<ToFileInput>,
name?: string | null | undefined,
options?: FilePropertyBag | undefined
): Promise<FileLike>

Helper for creating a File to pass to an SDK upload method from a variety of different data formats

Interfaces

I
AzureClientOptions

API Client for interfacing with the Azure OpenAI API.

  • apiKey: string | undefined

    Defaults to process.env['AZURE_OPENAI_API_KEY'].

  • apiVersion: string | undefined

    Defaults to process.env['OPENAI_API_VERSION'].

  • azureADTokenProvider: (() => Promise<string>) | undefined

    A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), which will be invoked on every request.

  • deployment: string | undefined

    A model deployment, if given, sets the base client URL to include /deployments/{deployment}. Note: this means you won't be able to use non-deployment endpoints. Not supported with Assistants APIs.

  • endpoint: string | undefined

    Your Azure endpoint, including the resource, e.g. https://example-resource.azure.openai.com/

I
ClientOptions
No documentation available
  • apiKey: string | undefined

    Defaults to process.env['OPENAI_API_KEY'].

  • baseURL: string | null | undefined

    Override the default base URL for the API, e.g., "https://api.example.com/v2/"

  • dangerouslyAllowBrowser: boolean

    By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. Only set this option to true if you understand the risks and have appropriate mitigations in place.

  • defaultHeaders: Core.Headers

    Default headers to include with every request to the API.

  • defaultQuery: Core.DefaultQuery

    Default query parameters to include with every request to the API.

  • fetch: Core.Fetch | undefined

    Specify a custom fetch function implementation.

  • httpAgent: Agent

    An HTTP agent used to manage HTTP(S) connections.

  • maxRetries: number

    The maximum number of times that the client will retry a request in case of a temporary failure, like a network error or a 5XX error from the server.

  • organization: string | null | undefined

    Defaults to process.env['OPENAI_ORG_ID'].

  • project: string | null | undefined

    Defaults to process.env['OPENAI_PROJECT_ID'].

  • timeout: number

    The maximum amount of time (in milliseconds) that the client should wait for a response from the server before timing out a single request.

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

Variables

v
APIConnectionError
No documentation available
v
APIConnectionTimeoutError
No documentation available
v
APIError
No documentation available
v
APIUserAbortError
No documentation available
v
AuthenticationError
No documentation available
v
BadRequestError
No documentation available
v
ConflictError
No documentation available
v
InternalServerError
No documentation available
v
NotFoundError
No documentation available
v
OpenAIError
No documentation available
v
PermissionDeniedError
No documentation available
v
RateLimitError
No documentation available
v
UnprocessableEntityError
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 * as mod from "@luca/openai";
or

Import directly with a jsr specifier

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