Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/1openwindow/azure-openai-node
/ functions
Functions
75 in github.com/1openwindow/azure-openai-node
⨍
Functions
75
◇
Types & classes
59
↓ 29 callers
Function
OpenAIApiFp
(configuration?: Configuration)
api.ts:3000
↓ 29 callers
Function
assertParamExists
(functionName: string, paramName: string, paramValue: unknown)
common.ts:33
↓ 28 callers
Function
createRequestFunction
(axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration)
common.ts:146
↓ 28 callers
Function
setSearchParams
(url: URL, ...objects: any[])
common.ts:114
↓ 28 callers
Function
toPathString
(url: URL)
common.ts:138
↓ 10 callers
Function
serializeDataIfNeeded
(value: any, requestOptions: any, configuration?: Configuration)
common.ts:124
↓ 2 callers
Method
cancelFineTune
* * @summary Immediately cancel a fine-tune job. * @param {string} fineTuneId The ID of the fine-tune job to cancel * @param {*} [op
api.ts:3665
↓ 2 callers
Method
createAnswer
* * @summary Answers the specified question using the provided documents and examples. The endpoint first [searches](/docs/api-reference/search
api.ts:3678
↓ 2 callers
Method
createChatCompletion
* * @summary Creates a completion for the chat message * @param {CreateChatCompletionRequest} createChatCompletionRequest * @param {*
api.ts:3690
↓ 2 callers
Method
createClassification
* * @summary Classifies the specified `query` using provided examples. The endpoint first [searches](/docs/api-reference/searches) over the lab
api.ts:3703
↓ 2 callers
Method
createCompletion
* * @summary Creates a completion for the provided prompt and parameters * @param {CreateCompletionRequest} createCompletionRequest *
api.ts:3715
↓ 2 callers
Method
createEdit
* * @summary Creates a new edit for the provided input, instruction, and parameters. * @param {CreateEditRequest} createEditRequest *
api.ts:3727
↓ 2 callers
Method
createEmbedding
* * @summary Creates an embedding vector representing the input text. * @param {CreateEmbeddingRequest} createEmbeddingRequest * @par
api.ts:3739
↓ 2 callers
Method
createFile
* * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded
api.ts:3752
↓ 2 callers
Method
createFineTune
* * @summary Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job
api.ts:3764
↓ 2 callers
Method
createImage
* * @summary Creates an image given a prompt. * @param {CreateImageRequest} createImageRequest * @param {*} [options] Override http r
api.ts:3776
↓ 2 callers
Method
createImageEdit
* * @summary Creates an edited or extended image given an original image and a prompt. * @param {File} image The image to edit. Must be a v
api.ts:3794
↓ 2 callers
Method
createImageVariation
* * @summary Creates a variation of a given image. * @param {File} image The image to use as the basis for the variation(s). Must be a vali
api.ts:3810
↓ 2 callers
Method
createModeration
* * @summary Classifies if text violates OpenAI\'s Content Policy * @param {CreateModerationRequest} createModerationRequest * @param
api.ts:3822
↓ 2 callers
Method
createSearch
* * @summary The search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the API if
api.ts:3836
↓ 2 callers
Method
createTranscription
* * @summary Transcribes audio into the input language. * @param {File} file The audio file to transcribe, in one of these formats: mp3, mp
api.ts:3853
↓ 2 callers
Method
createTranslation
* * @summary Translates audio into into English. * @param {File} file The audio file to translate, in one of these formats: mp3, mp4, mpeg,
api.ts:3869
↓ 2 callers
Method
deleteFile
* * @summary Delete a file. * @param {string} fileId The ID of the file to use for this request * @param {*} [options] Override http r
api.ts:3881
↓ 2 callers
Method
deleteModel
* * @summary Delete a fine-tuned model. You must have the Owner role in your organization. * @param {string} model The model to delete
api.ts:3893
↓ 2 callers
Method
downloadFile
* * @summary Returns the contents of the specified file * @param {string} fileId The ID of the file to use for this request * @param {
api.ts:3905
↓ 2 callers
Method
listEngines
* * @summary Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availabil
api.ts:3917
↓ 2 callers
Method
listFiles
* * @summary Returns a list of files that belong to the user\'s organization. * @param {*} [options] Override http request option. * @
api.ts:3928
↓ 2 callers
Method
listFineTuneEvents
* * @summary Get fine-grained status updates for a fine-tune job. * @param {string} fineTuneId The ID of the fine-tune job to get events f
api.ts:3941
↓ 2 callers
Method
listFineTunes
* * @summary List your organization\'s fine-tuning jobs * @param {*} [options] Override http request option. * @throws {RequiredError
api.ts:3952
↓ 2 callers
Method
listModels
* * @summary Lists the currently available models, and provides basic information about each one such as the owner and availability. * @par
api.ts:3963
↓ 2 callers
Method
retrieveEngine
* * @summary Retrieves a model instance, providing basic information about it such as the owner and availability. * @param {string} engineI
api.ts:3976
↓ 2 callers
Method
retrieveFile
* * @summary Returns information about a specific file. * @param {string} fileId The ID of the file to use for this request * @param {
api.ts:3988
↓ 2 callers
Method
retrieveFineTune
* * @summary Gets info about the fine-tune job. [Learn more about Fine-tuning](/docs/guides/fine-tuning) * @param {string} fineTuneId The
api.ts:4000
↓ 2 callers
Method
retrieveModel
* * @summary Retrieves a model instance, providing basic information about the model such as the owner and permissioning. * @param {string}
api.ts:4012
↓ 1 callers
Function
OpenAIApiAxiosParamCreator
(configuration?: Configuration)
api.ts:1864
↓ 1 callers
Function
createPrompt
(systemMessage: string, messages: { sender: string, text: string }[])
common.ts:157
↓ 1 callers
Method
isJsonMime
* Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLIC
configuration.ts:144
↓ 1 callers
Function
setFlattenedQueryParams
(urlSearchParams: URLSearchParams, parameter: any, key: string = "")
common.ts:88
Function
OpenAIApiFactory
(configuration?: Configuration, basePath?: string, axios?: AxiosInstance)
api.ts:3341
Function
cancelFineTune
* * @summary Immediately cancel a fine-tune job. * @param {string} fineTuneId The ID of the fine-tune job to cancel * @p
api.ts:3010
Method
constructor
(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globa
base.ts:53
Method
constructor
(public field: string, msg?: string)
base.ts:68
Method
constructor
(param: ConfigurationParameters = {})
configuration.ts:98
Function
createAnswer
* * @summary Answers the specified question using the provided documents and examples. The endpoint first [searches](/docs/api-reference/se
api.ts:3022
Function
createChatCompletion
* * @summary Creates a completion for the chat message * @param {CreateChatCompletionRequest} createChatCompletionRequest
api.ts:3033
Function
createClassification
* * @summary Classifies the specified `query` using provided examples. The endpoint first [searches](/docs/api-reference/searches) over the
api.ts:3045
Function
createCompletion
* * @summary Creates a completion for the provided prompt and parameters * @param {CreateCompletionRequest} createCompletionRequest
api.ts:3056
Function
createEdit
* * @summary Creates a new edit for the provided input, instruction, and parameters. * @param {CreateEditRequest} createEditRequest
api.ts:3067
Function
createEmbedding
* * @summary Creates an embedding vector representing the input text. * @param {CreateEmbeddingRequest} createEmbeddingRequest
api.ts:3078
Function
createFile
* * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uplo
api.ts:3090
Function
createFineTune
* * @summary Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including
api.ts:3101
Function
createImage
* * @summary Creates an image given a prompt. * @param {CreateImageRequest} createImageRequest * @param {*} [options] Ove
api.ts:3112
Function
createImageEdit
* * @summary Creates an edited or extended image given an original image and a prompt. * @param {File} image The image to edit. Mus
api.ts:3129
Function
createImageVariation
* * @summary Creates a variation of a given image. * @param {File} image The image to use as the basis for the variation(s). Must b
api.ts:3144
Function
createModeration
* * @summary Classifies if text violates OpenAI\'s Content Policy * @param {CreateModerationRequest} createModerationRequest
api.ts:3155
Function
createSearch
* * @summary The search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the AP
api.ts:3168
Function
createTranscription
* * @summary Transcribes audio into the input language. * @param {File} file The audio file to transcribe, in one of these formats:
api.ts:3184
Function
createTranslation
* * @summary Translates audio into into English. * @param {File} file The audio file to translate, in one of these formats: mp3, mp
api.ts:3199
Function
deleteFile
* * @summary Delete a file. * @param {string} fileId The ID of the file to use for this request * @param {*} [options] Ove
api.ts:3210
Function
deleteModel
* * @summary Delete a fine-tuned model. You must have the Owner role in your organization. * @param {string} model The model to del
api.ts:3221
Function
downloadFile
* * @summary Returns the contents of the specified file * @param {string} fileId The ID of the file to use for this request
api.ts:3232
Function
listEngines
* * @summary Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and avail
api.ts:3243
Function
listFiles
* * @summary Returns a list of files that belong to the user\'s organization. * @param {*} [options] Override http request option.
api.ts:3253
Function
listFineTuneEvents
* * @summary Get fine-grained status updates for a fine-tune job. * @param {string} fineTuneId The ID of the fine-tune job to get
api.ts:3265
Function
listFineTunes
* * @summary List your organization\'s fine-tuning jobs * @param {*} [options] Override http request option. * @throws {R
api.ts:3275
Function
listModels
* * @summary Lists the currently available models, and provides basic information about each one such as the owner and availability.
api.ts:3285
Function
messageToAzurePrompt
(messages: Array<ChatCompletionRequestMessage>)
common.ts:166
Function
retrieveEngine
* * @summary Retrieves a model instance, providing basic information about it such as the owner and availability. * @param {string}
api.ts:3297
Function
retrieveFile
* * @summary Returns information about a specific file. * @param {string} fileId The ID of the file to use for this request
api.ts:3308
Function
retrieveFineTune
* * @summary Gets info about the fine-tune job. [Learn more about Fine-tuning](/docs/guides/fine-tuning) * @param {string} fineTu
api.ts:3319
Function
retrieveModel
* * @summary Retrieves a model instance, providing basic information about the model such as the owner and permissioning. * @param
api.ts:3330
Function
setApiKeyToObject
(object: any, keyParamName: string, configuration?: Configuration)
common.ts:43
Function
setBasicAuthToObject
(object: any, configuration?: Configuration)
common.ts:56
Function
setBearerAuthToObject
(object: any, configuration?: Configuration)
common.ts:66
Function
setOAuthToObject
(object: any, name: string, scopes: string[], configuration?: Configuration)
common.ts:79