basant307/AI_Governance_Project

1import type { RequestInit, RequestInfo } from "./internal/builtin-types.mjs";2import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.mjs";3export type { Logger, LogLevel } from "./internal/utils/log.mjs";4import * as Opts from "./internal/request-options.mjs";5import * as Errors from "./core/error.mjs";6import * as Pagination from "./core/pagination.mjs";7import { type CursorPageParams, CursorPageResponse, PageResponse } from "./core/pagination.mjs";8import * as Uploads from "./core/uploads.mjs";9import * as API from "./resources/index.mjs";10import { APIPromise } from "./core/api-promise.mjs";11import { Batch, BatchCreateParams, BatchError, BatchListParams, BatchRequestCounts, Batches, BatchesPage } from "./resources/batches.mjs";12import { Completion, CompletionChoice, CompletionCreateParams, CompletionCreateParamsNonStreaming, CompletionCreateParamsStreaming, CompletionUsage, Completions } from "./resources/completions.mjs";13import { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, EmbeddingModel, Embeddings } from "./resources/embeddings.mjs";14import { FileContent, FileCreateParams, FileDeleted, FileListParams, FileObject, FileObjectsPage, FilePurpose, Files } from "./resources/files.mjs";15import { Image, ImageCreateVariationParams, ImageEditCompletedEvent, ImageEditParams, ImageEditParamsNonStreaming, ImageEditParamsStreaming, ImageEditPartialImageEvent, ImageEditStreamEvent, ImageGenCompletedEvent, ImageGenPartialImageEvent, ImageGenStreamEvent, ImageGenerateParams, ImageGenerateParamsNonStreaming, ImageGenerateParamsStreaming, ImageModel, Images, ImagesResponse } from "./resources/images.mjs";16import { Model, ModelDeleted, Models, ModelsPage } from "./resources/models.mjs";17import { Moderation, ModerationCreateParams, ModerationCreateResponse, ModerationImageURLInput, ModerationModel, ModerationMultiModalInput, ModerationTextInput, Moderations } from "./resources/moderations.mjs";18import { Webhooks } from "./resources/webhooks.mjs";19import { Audio, AudioModel, AudioResponseFormat } from "./resources/audio/audio.mjs";20import { Beta } from "./resources/beta/beta.mjs";21import { Chat } from "./resources/chat/chat.mjs";22import { ContainerCreateParams, ContainerCreateResponse, ContainerListParams, ContainerListResponse, ContainerListResponsesPage, ContainerRetrieveResponse, Containers } from "./resources/containers/containers.mjs";23import { EvalCreateParams, EvalCreateResponse, EvalCustomDataSourceConfig, EvalDeleteResponse, EvalListParams, EvalListResponse, EvalListResponsesPage, EvalRetrieveResponse, EvalStoredCompletionsDataSourceConfig, EvalUpdateParams, EvalUpdateResponse, Evals } from "./resources/evals/evals.mjs";24import { FineTuning } from "./resources/fine-tuning/fine-tuning.mjs";25import { Graders } from "./resources/graders/graders.mjs";26import { Responses } from "./resources/responses/responses.mjs";27import { Upload, UploadCompleteParams, UploadCreateParams, Uploads as UploadsAPIUploads } from "./resources/uploads/uploads.mjs";28import { AutoFileChunkingStrategyParam, FileChunkingStrategy, FileChunkingStrategyParam, OtherFileChunkingStrategyObject, StaticFileChunkingStrategy, StaticFileChunkingStrategyObject, StaticFileChunkingStrategyObjectParam, VectorStore, VectorStoreCreateParams, VectorStoreDeleted, VectorStoreListParams, VectorStoreSearchParams, VectorStoreSearchResponse, VectorStoreSearchResponsesPage, VectorStoreUpdateParams, VectorStores, VectorStoresPage } from "./resources/vector-stores/vector-stores.mjs";29import { ChatCompletion, ChatCompletionAssistantMessageParam, ChatCompletionAudio, ChatCompletionAudioParam, ChatCompletionChunk, ChatCompletionContentPart, ChatCompletionContentPartImage, ChatCompletionContentPartInputAudio, ChatCompletionContentPartRefusal, ChatCompletionContentPartText, ChatCompletionCreateParams, ChatCompletionCreateParamsNonStreaming, ChatCompletionCreateParamsStreaming, ChatCompletionDeleted, ChatCompletionDeveloperMessageParam, ChatCompletionFunctionCallOption, ChatCompletionFunctionMessageParam, ChatCompletionListParams, ChatCompletionMessage, ChatCompletionMessageParam, ChatCompletionMessageToolCall, ChatCompletionModality, ChatCompletionNamedToolChoice, ChatCompletionPredictionContent, ChatCompletionReasoningEffort, ChatCompletionRole, ChatCompletionStoreMessage, ChatCompletionStreamOptions, ChatCompletionSystemMessageParam, ChatCompletionTokenLogprob, ChatCompletionTool, ChatCompletionToolChoiceOption, ChatCompletionToolMessageParam, ChatCompletionUpdateParams, ChatCompletionUserMessageParam, ChatCompletionsPage } from "./resources/chat/completions/completions.mjs";30import { type Fetch } from "./internal/builtin-types.mjs";31import { HeadersLike, NullableHeaders } from "./internal/headers.mjs";32import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs";33import { type LogLevel, type Logger } from "./internal/utils/log.mjs";34export interface ClientOptions {35    /**36     * Defaults to process.env['OPENAI_API_KEY'].37     */38    apiKey?: string | undefined;39    /**40     * Defaults to process.env['OPENAI_ORG_ID'].41     */42    organization?: string | null | undefined;43    /**44     * Defaults to process.env['OPENAI_PROJECT_ID'].45     */46    project?: string | null | undefined;47    /**48     * Defaults to process.env['OPENAI_WEBHOOK_SECRET'].49     */50    webhookSecret?: string | null | undefined;51    /**52     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"53     *54     * Defaults to process.env['OPENAI_BASE_URL'].55     */56    baseURL?: string | null | undefined;57    /**58     * The maximum amount of time (in milliseconds) that the client should wait for a response59     * from the server before timing out a single request.60     *61     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait62     * much longer than this timeout before the promise succeeds or fails.63     *64     * @unit milliseconds65     */66    timeout?: number | undefined;67    /**68     * Additional `RequestInit` options to be passed to `fetch` calls.69     * Properties will be overridden by per-request `fetchOptions`.70     */71    fetchOptions?: MergedRequestInit | undefined;72    /**73     * Specify a custom `fetch` function implementation.74     *75     * If not provided, we expect that `fetch` is defined globally.76     */77    fetch?: Fetch | undefined;78    /**79     * The maximum number of times that the client will retry a request in case of a80     * temporary failure, like a network error or a 5XX error from the server.81     *82     * @default 283     */84    maxRetries?: number | undefined;85    /**86     * Default headers to include with every request to the API.87     *88     * These can be removed in individual requests by explicitly setting the89     * header to `null` in request options.90     */91    defaultHeaders?: HeadersLike | undefined;92    /**93     * Default query parameters to include with every request to the API.94     *95     * These can be removed in individual requests by explicitly setting the96     * param to `undefined` in request options.97     */98    defaultQuery?: Record<string, string | undefined> | undefined;99    /**100     * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.101     * Only set this option to `true` if you understand the risks and have appropriate mitigations in place.102     */103    dangerouslyAllowBrowser?: boolean | undefined;104    /**105     * Set the log level.106     *107     * Defaults to process.env['OPENAI_LOG'] or 'warn' if it isn't set.108     */109    logLevel?: LogLevel | undefined;110    /**111     * Set the logger.112     *113     * Defaults to globalThis.console.114     */115    logger?: Logger | undefined;116}117/**118 * API Client for interfacing with the OpenAI API.119 */120export declare class OpenAI {121    #private;122    apiKey: string;123    organization: string | null;124    project: string | null;125    webhookSecret: string | null;126    baseURL: string;127    maxRetries: number;128    timeout: number;129    logger: Logger | undefined;130    logLevel: LogLevel | undefined;131    fetchOptions: MergedRequestInit | undefined;132    private fetch;133    protected idempotencyHeader?: string;134    private _options;135    /**136     * API Client for interfacing with the OpenAI API.137     *138     * @param {string | undefined} [opts.apiKey=process.env['OPENAI_API_KEY'] ?? undefined]139     * @param {string | null | undefined} [opts.organization=process.env['OPENAI_ORG_ID'] ?? null]140     * @param {string | null | undefined} [opts.project=process.env['OPENAI_PROJECT_ID'] ?? null]141     * @param {string | null | undefined} [opts.webhookSecret=process.env['OPENAI_WEBHOOK_SECRET'] ?? null]142     * @param {string} [opts.baseURL=process.env['OPENAI_BASE_URL'] ?? https://api.openai.com/v1] - Override the default base URL for the API.143     * @param {number} [opts.timeout=10 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.144     * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.145     * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.146     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.147     * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.148     * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.149     * @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.150     */151    constructor({ baseURL, apiKey, organization, project, webhookSecret, ...opts }?: ClientOptions);152    /**153     * Create a new client instance re-using the same options given to the current client with optional overriding.154     */155    withOptions(options: Partial<ClientOptions>): this;156    protected defaultQuery(): Record<string, string | undefined> | undefined;157    protected validateHeaders({ values, nulls }: NullableHeaders): void;158    protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;159    protected stringifyQuery(query: Record<string, unknown>): string;160    private getUserAgent;161    protected defaultIdempotencyKey(): string;162    protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;163    buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;164    /**165     * Used as a callback for mutating the given `FinalRequestOptions` object.166     */167    protected prepareOptions(options: FinalRequestOptions): Promise<void>;168    /**169     * Used as a callback for mutating the given `RequestInit` object.170     *171     * This is useful for cases where you want to add certain headers based off of172     * the request properties, e.g. `method` or `url`.173     */174    protected prepareRequest(request: RequestInit, { url, options }: {175        url: string;176        options: FinalRequestOptions;177    }): Promise<void>;178    get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;179    post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;180    patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;181    put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;182    delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;183    private methodRequest;184    request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;185    private makeRequest;186    getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(path: string, Page: new (...args: any[]) => PageClass, opts?: RequestOptions): Pagination.PagePromise<PageClass, Item>;187    requestAPIList<Item = unknown, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass, options: FinalRequestOptions): Pagination.PagePromise<PageClass, Item>;188    fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;189    private shouldRetry;190    private retryRequest;191    private calculateDefaultRetryTimeoutMillis;192    buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {193        retryCount?: number;194    }): Promise<{195        req: FinalizedRequestInit;196        url: string;197        timeout: number;198    }>;199    private buildHeaders;200    private buildBody;201    static OpenAI: typeof OpenAI;202    static DEFAULT_TIMEOUT: number;203    static OpenAIError: typeof Errors.OpenAIError;204    static APIError: typeof Errors.APIError;205    static APIConnectionError: typeof Errors.APIConnectionError;206    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;207    static APIUserAbortError: typeof Errors.APIUserAbortError;208    static NotFoundError: typeof Errors.NotFoundError;209    static ConflictError: typeof Errors.ConflictError;210    static RateLimitError: typeof Errors.RateLimitError;211    static BadRequestError: typeof Errors.BadRequestError;212    static AuthenticationError: typeof Errors.AuthenticationError;213    static InternalServerError: typeof Errors.InternalServerError;214    static PermissionDeniedError: typeof Errors.PermissionDeniedError;215    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;216    static InvalidWebhookSignatureError: typeof Errors.InvalidWebhookSignatureError;217    static toFile: typeof Uploads.toFile;218    completions: API.Completions;219    chat: API.Chat;220    embeddings: API.Embeddings;221    files: API.Files;222    images: API.Images;223    audio: API.Audio;224    moderations: API.Moderations;225    models: API.Models;226    fineTuning: API.FineTuning;227    graders: API.Graders;228    vectorStores: API.VectorStores;229    webhooks: API.Webhooks;230    beta: API.Beta;231    batches: API.Batches;232    uploads: API.Uploads;233    responses: API.Responses;234    evals: API.Evals;235    containers: API.Containers;236}237export declare namespace OpenAI {238    export type RequestOptions = Opts.RequestOptions;239    export import Page = Pagination.Page;240    export { type PageResponse as PageResponse };241    export import CursorPage = Pagination.CursorPage;242    export { type CursorPageParams as CursorPageParams, type CursorPageResponse as CursorPageResponse };243    export { Completions as Completions, type Completion as Completion, type CompletionChoice as CompletionChoice, type CompletionUsage as CompletionUsage, type CompletionCreateParams as CompletionCreateParams, type CompletionCreateParamsNonStreaming as CompletionCreateParamsNonStreaming, type CompletionCreateParamsStreaming as CompletionCreateParamsStreaming, };244    export { Chat as Chat, type ChatCompletion as ChatCompletion, type ChatCompletionAssistantMessageParam as ChatCompletionAssistantMessageParam, type ChatCompletionAudio as ChatCompletionAudio, type ChatCompletionAudioParam as ChatCompletionAudioParam, type ChatCompletionChunk as ChatCompletionChunk, type ChatCompletionContentPart as ChatCompletionContentPart, type ChatCompletionContentPartImage as ChatCompletionContentPartImage, type ChatCompletionContentPartInputAudio as ChatCompletionContentPartInputAudio, type ChatCompletionContentPartRefusal as ChatCompletionContentPartRefusal, type ChatCompletionContentPartText as ChatCompletionContentPartText, type ChatCompletionDeleted as ChatCompletionDeleted, type ChatCompletionDeveloperMessageParam as ChatCompletionDeveloperMessageParam, type ChatCompletionFunctionCallOption as ChatCompletionFunctionCallOption, type ChatCompletionFunctionMessageParam as ChatCompletionFunctionMessageParam, type ChatCompletionMessage as ChatCompletionMessage, type ChatCompletionMessageParam as ChatCompletionMessageParam, type ChatCompletionMessageToolCall as ChatCompletionMessageToolCall, type ChatCompletionModality as ChatCompletionModality, type ChatCompletionNamedToolChoice as ChatCompletionNamedToolChoice, type ChatCompletionPredictionContent as ChatCompletionPredictionContent, type ChatCompletionRole as ChatCompletionRole, type ChatCompletionStoreMessage as ChatCompletionStoreMessage, type ChatCompletionStreamOptions as ChatCompletionStreamOptions, type ChatCompletionSystemMessageParam as ChatCompletionSystemMessageParam, type ChatCompletionTokenLogprob as ChatCompletionTokenLogprob, type ChatCompletionTool as ChatCompletionTool, type ChatCompletionToolChoiceOption as ChatCompletionToolChoiceOption, type ChatCompletionToolMessageParam as ChatCompletionToolMessageParam, type ChatCompletionUserMessageParam as ChatCompletionUserMessageParam, type ChatCompletionReasoningEffort as ChatCompletionReasoningEffort, type ChatCompletionsPage as ChatCompletionsPage, type ChatCompletionCreateParams as ChatCompletionCreateParams, type ChatCompletionCreateParamsNonStreaming as ChatCompletionCreateParamsNonStreaming, type ChatCompletionCreateParamsStreaming as ChatCompletionCreateParamsStreaming, type ChatCompletionUpdateParams as ChatCompletionUpdateParams, type ChatCompletionListParams as ChatCompletionListParams, };245    export { Embeddings as Embeddings, type CreateEmbeddingResponse as CreateEmbeddingResponse, type Embedding as Embedding, type EmbeddingModel as EmbeddingModel, type EmbeddingCreateParams as EmbeddingCreateParams, };246    export { Files as Files, type FileContent as FileContent, type FileDeleted as FileDeleted, type FileObject as FileObject, type FilePurpose as FilePurpose, type FileObjectsPage as FileObjectsPage, type FileCreateParams as FileCreateParams, type FileListParams as FileListParams, };247    export { Images as Images, type Image as Image, type ImageEditCompletedEvent as ImageEditCompletedEvent, type ImageEditPartialImageEvent as ImageEditPartialImageEvent, type ImageEditStreamEvent as ImageEditStreamEvent, type ImageGenCompletedEvent as ImageGenCompletedEvent, type ImageGenPartialImageEvent as ImageGenPartialImageEvent, type ImageGenStreamEvent as ImageGenStreamEvent, type ImageModel as ImageModel, type ImagesResponse as ImagesResponse, type ImageCreateVariationParams as ImageCreateVariationParams, type ImageEditParams as ImageEditParams, type ImageEditParamsNonStreaming as ImageEditParamsNonStreaming, type ImageEditParamsStreaming as ImageEditParamsStreaming, type ImageGenerateParams as ImageGenerateParams, type ImageGenerateParamsNonStreaming as ImageGenerateParamsNonStreaming, type ImageGenerateParamsStreaming as ImageGenerateParamsStreaming, };248    export { Audio as Audio, type AudioModel as AudioModel, type AudioResponseFormat as AudioResponseFormat };249    export { Moderations as Moderations, type Moderation as Moderation, type ModerationImageURLInput as ModerationImageURLInput, type ModerationModel as ModerationModel, type ModerationMultiModalInput as ModerationMultiModalInput, type ModerationTextInput as ModerationTextInput, type ModerationCreateResponse as ModerationCreateResponse, type ModerationCreateParams as ModerationCreateParams, };250    export { Models as Models, type Model as Model, type ModelDeleted as ModelDeleted, type ModelsPage as ModelsPage, };251    export { FineTuning as FineTuning };252    export { Graders as Graders };253    export { VectorStores as VectorStores, type AutoFileChunkingStrategyParam as AutoFileChunkingStrategyParam, type FileChunkingStrategy as FileChunkingStrategy, type FileChunkingStrategyParam as FileChunkingStrategyParam, type OtherFileChunkingStrategyObject as OtherFileChunkingStrategyObject, type StaticFileChunkingStrategy as StaticFileChunkingStrategy, type StaticFileChunkingStrategyObject as StaticFileChunkingStrategyObject, type StaticFileChunkingStrategyObjectParam as StaticFileChunkingStrategyObjectParam, type VectorStore as VectorStore, type VectorStoreDeleted as VectorStoreDeleted, type VectorStoreSearchResponse as VectorStoreSearchResponse, type VectorStoresPage as VectorStoresPage, type VectorStoreSearchResponsesPage as VectorStoreSearchResponsesPage, type VectorStoreCreateParams as VectorStoreCreateParams, type VectorStoreUpdateParams as VectorStoreUpdateParams, type VectorStoreListParams as VectorStoreListParams, type VectorStoreSearchParams as VectorStoreSearchParams, };254    export { Webhooks as Webhooks };255    export { Beta as Beta };256    export { Batches as Batches, type Batch as Batch, type BatchError as BatchError, type BatchRequestCounts as BatchRequestCounts, type BatchesPage as BatchesPage, type BatchCreateParams as BatchCreateParams, type BatchListParams as BatchListParams, };257    export { UploadsAPIUploads as Uploads, type Upload as Upload, type UploadCreateParams as UploadCreateParams, type UploadCompleteParams as UploadCompleteParams, };258    export { Responses as Responses };259    export { Evals as Evals, type EvalCustomDataSourceConfig as EvalCustomDataSourceConfig, type EvalStoredCompletionsDataSourceConfig as EvalStoredCompletionsDataSourceConfig, type EvalCreateResponse as EvalCreateResponse, type EvalRetrieveResponse as EvalRetrieveResponse, type EvalUpdateResponse as EvalUpdateResponse, type EvalListResponse as EvalListResponse, type EvalDeleteResponse as EvalDeleteResponse, type EvalListResponsesPage as EvalListResponsesPage, type EvalCreateParams as EvalCreateParams, type EvalUpdateParams as EvalUpdateParams, type EvalListParams as EvalListParams, };260    export { Containers as Containers, type ContainerCreateResponse as ContainerCreateResponse, type ContainerRetrieveResponse as ContainerRetrieveResponse, type ContainerListResponse as ContainerListResponse, type ContainerListResponsesPage as ContainerListResponsesPage, type ContainerCreateParams as ContainerCreateParams, type ContainerListParams as ContainerListParams, };261    export type AllModels = API.AllModels;262    export type ChatModel = API.ChatModel;263    export type ComparisonFilter = API.ComparisonFilter;264    export type CompoundFilter = API.CompoundFilter;265    export type ErrorObject = API.ErrorObject;266    export type FunctionDefinition = API.FunctionDefinition;267    export type FunctionParameters = API.FunctionParameters;268    export type Metadata = API.Metadata;269    export type Reasoning = API.Reasoning;270    export type ReasoningEffort = API.ReasoningEffort;271    export type ResponseFormatJSONObject = API.ResponseFormatJSONObject;272    export type ResponseFormatJSONSchema = API.ResponseFormatJSONSchema;273    export type ResponseFormatText = API.ResponseFormatText;274    export type ResponsesModel = API.ResponsesModel;275}276//# sourceMappingURL=client.d.mts.map