openai-mcp-test 0.0.1

package/resources/completions.d.mts

@@ -0,0 +1,332 @@
+import { APIResource } from "../core/resource.mjs";
+import * as CompletionsAPI from "./completions.mjs";
+import * as CompletionsCompletionsAPI from "./chat/completions/completions.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { Stream } from "../core/streaming.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Completions extends APIResource {
+    /**
+     * Creates a completion for the provided prompt and parameters.
+     *
+     * Returns a completion object, or a sequence of completion objects if the request
+     * is streamed.
+     *
+     * @example
+     * ```ts
+     * const completion = await client.completions.create({
+     *   model: 'string',
+     *   prompt: 'This is a test.',
+     * });
+     * ```
+     */
+    create(body: CompletionCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Completion>;
+    create(body: CompletionCreateParamsStreaming, options?: RequestOptions): APIPromise<Stream<Completion>>;
+    create(body: CompletionCreateParamsBase, options?: RequestOptions): APIPromise<Stream<Completion> | Completion>;
+}
+/**
+ * Represents a completion response from the API. Note: both the streamed and
+ * non-streamed response objects share the same shape (unlike the chat endpoint).
+ */
+export interface Completion {
+    /**
+     * A unique identifier for the completion.
+     */
+    id: string;
+    /**
+     * The list of completion choices the model generated for the input prompt.
+     */
+    choices: Array<CompletionChoice>;
+    /**
+     * The Unix timestamp (in seconds) of when the completion was created.
+     */
+    created: number;
+    /**
+     * The model used for completion.
+     */
+    model: string;
+    /**
+     * The object type, which is always "text_completion"
+     */
+    object: 'text_completion';
+    /**
+     * This fingerprint represents the backend configuration that the model runs with.
+     *
+     * Can be used in conjunction with the `seed` request parameter to understand when
+     * backend changes have been made that might impact determinism.
+     */
+    system_fingerprint?: string;
+    /**
+     * Usage statistics for the completion request.
+     */
+    usage?: CompletionUsage;
+}
+export interface CompletionChoice {
+    /**
+     * The reason the model stopped generating tokens. This will be `stop` if the model
+     * hit a natural stop point or a provided stop sequence, `length` if the maximum
+     * number of tokens specified in the request was reached, or `content_filter` if
+     * content was omitted due to a flag from our content filters.
+     */
+    finish_reason: 'stop' | 'length' | 'content_filter';
+    index: number;
+    logprobs: CompletionChoice.Logprobs | null;
+    text: string;
+}
+export declare namespace CompletionChoice {
+    interface Logprobs {
+        text_offset?: Array<number>;
+        token_logprobs?: Array<number>;
+        tokens?: Array<string>;
+        top_logprobs?: Array<{
+            [key: string]: number;
+        }>;
+    }
+}
+/**
+ * Usage statistics for the completion request.
+ */
+export interface CompletionUsage {
+    /**
+     * Number of tokens in the generated completion.
+     */
+    completion_tokens: number;
+    /**
+     * Number of tokens in the prompt.
+     */
+    prompt_tokens: number;
+    /**
+     * Total number of tokens used in the request (prompt + completion).
+     */
+    total_tokens: number;
+    /**
+     * Breakdown of tokens used in a completion.
+     */
+    completion_tokens_details?: CompletionUsage.CompletionTokensDetails;
+    /**
+     * Breakdown of tokens used in the prompt.
+     */
+    prompt_tokens_details?: CompletionUsage.PromptTokensDetails;
+}
+export declare namespace CompletionUsage {
+    /**
+     * Breakdown of tokens used in a completion.
+     */
+    interface CompletionTokensDetails {
+        /**
+         * When using Predicted Outputs, the number of tokens in the prediction that
+         * appeared in the completion.
+         */
+        accepted_prediction_tokens?: number;
+        /**
+         * Audio input tokens generated by the model.
+         */
+        audio_tokens?: number;
+        /**
+         * Tokens generated by the model for reasoning.
+         */
+        reasoning_tokens?: number;
+        /**
+         * When using Predicted Outputs, the number of tokens in the prediction that did
+         * not appear in the completion. However, like reasoning tokens, these tokens are
+         * still counted in the total completion tokens for purposes of billing, output,
+         * and context window limits.
+         */
+        rejected_prediction_tokens?: number;
+    }
+    /**
+     * Breakdown of tokens used in the prompt.
+     */
+    interface PromptTokensDetails {
+        /**
+         * Audio input tokens present in the prompt.
+         */
+        audio_tokens?: number;
+        /**
+         * Cached tokens present in the prompt.
+         */
+        cached_tokens?: number;
+    }
+}
+export type CompletionCreateParams = CompletionCreateParamsNonStreaming | CompletionCreateParamsStreaming;
+export interface CompletionCreateParamsBase {
+    /**
+     * ID of the model to use. You can use the
+     * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
+     * see all of your available models, or see our
+     * [Model overview](https://platform.openai.com/docs/models) for descriptions of
+     * them.
+     */
+    model: (string & {}) | 'gpt-3.5-turbo-instruct' | 'davinci-002' | 'babbage-002';
+    /**
+     * The prompt(s) to generate completions for, encoded as a string, array of
+     * strings, array of tokens, or array of token arrays.
+     *
+     * Note that <|endoftext|> is the document separator that the model sees during
+     * training, so if a prompt is not specified the model will generate as if from the
+     * beginning of a new document.
+     */
+    prompt: string | Array<string> | Array<number> | Array<Array<number>> | null;
+    /**
+     * Generates `best_of` completions server-side and returns the "best" (the one with
+     * the highest log probability per token). Results cannot be streamed.
+     *
+     * When used with `n`, `best_of` controls the number of candidate completions and
+     * `n` specifies how many to return – `best_of` must be greater than `n`.
+     *
+     * **Note:** Because this parameter generates many completions, it can quickly
+     * consume your token quota. Use carefully and ensure that you have reasonable
+     * settings for `max_tokens` and `stop`.
+     */
+    best_of?: number | null;
+    /**
+     * Echo back the prompt in addition to the completion
+     */
+    echo?: boolean | null;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+     * existing frequency in the text so far, decreasing the model's likelihood to
+     * repeat the same line verbatim.
+     *
+     * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
+     */
+    frequency_penalty?: number | null;
+    /**
+     * Modify the likelihood of specified tokens appearing in the completion.
+     *
+     * Accepts a JSON object that maps tokens (specified by their token ID in the GPT
+     * tokenizer) to an associated bias value from -100 to 100. You can use this
+     * [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs.
+     * Mathematically, the bias is added to the logits generated by the model prior to
+     * sampling. The exact effect will vary per model, but values between -1 and 1
+     * should decrease or increase likelihood of selection; values like -100 or 100
+     * should result in a ban or exclusive selection of the relevant token.
+     *
+     * As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
+     * from being generated.
+     */
+    logit_bias?: {
+        [key: string]: number;
+    } | null;
+    /**
+     * Include the log probabilities on the `logprobs` most likely output tokens, as
+     * well the chosen tokens. For example, if `logprobs` is 5, the API will return a
+     * list of the 5 most likely tokens. The API will always return the `logprob` of
+     * the sampled token, so there may be up to `logprobs+1` elements in the response.
+     *
+     * The maximum value for `logprobs` is 5.
+     */
+    logprobs?: number | null;
+    /**
+     * The maximum number of [tokens](/tokenizer) that can be generated in the
+     * completion.
+     *
+     * The token count of your prompt plus `max_tokens` cannot exceed the model's
+     * context length.
+     * [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
+     * for counting tokens.
+     */
+    max_tokens?: number | null;
+    /**
+     * How many completions to generate for each prompt.
+     *
+     * **Note:** Because this parameter generates many completions, it can quickly
+     * consume your token quota. Use carefully and ensure that you have reasonable
+     * settings for `max_tokens` and `stop`.
+     */
+    n?: number | null;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+     * whether they appear in the text so far, increasing the model's likelihood to
+     * talk about new topics.
+     *
+     * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
+     */
+    presence_penalty?: number | null;
+    /**
+     * If specified, our system will make a best effort to sample deterministically,
+     * such that repeated requests with the same `seed` and parameters should return
+     * the same result.
+     *
+     * Determinism is not guaranteed, and you should refer to the `system_fingerprint`
+     * response parameter to monitor changes in the backend.
+     */
+    seed?: number | null;
+    /**
+     * Not supported with latest reasoning models `o3` and `o4-mini`.
+     *
+     * Up to 4 sequences where the API will stop generating further tokens. The
+     * returned text will not contain the stop sequence.
+     */
+    stop?: string | null | Array<string>;
+    /**
+     * Whether to stream back partial progress. If set, tokens will be sent as
+     * data-only
+     * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+     * as they become available, with the stream terminated by a `data: [DONE]`
+     * message.
+     * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+     */
+    stream?: boolean | null;
+    /**
+     * Options for streaming response. Only set this when you set `stream: true`.
+     */
+    stream_options?: CompletionsCompletionsAPI.ChatCompletionStreamOptions | null;
+    /**
+     * The suffix that comes after a completion of inserted text.
+     *
+     * This parameter is only supported for `gpt-3.5-turbo-instruct`.
+     */
+    suffix?: string | null;
+    /**
+     * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+     * make the output more random, while lower values like 0.2 will make it more
+     * focused and deterministic.
+     *
+     * We generally recommend altering this or `top_p` but not both.
+     */
+    temperature?: number | null;
+    /**
+     * An alternative to sampling with temperature, called nucleus sampling, where the
+     * model considers the results of the tokens with top_p probability mass. So 0.1
+     * means only the tokens comprising the top 10% probability mass are considered.
+     *
+     * We generally recommend altering this or `temperature` but not both.
+     */
+    top_p?: number | null;
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor
+     * and detect abuse.
+     * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+     */
+    user?: string;
+}
+export declare namespace CompletionCreateParams {
+    type CompletionCreateParamsNonStreaming = CompletionsAPI.CompletionCreateParamsNonStreaming;
+    type CompletionCreateParamsStreaming = CompletionsAPI.CompletionCreateParamsStreaming;
+}
+export interface CompletionCreateParamsNonStreaming extends CompletionCreateParamsBase {
+    /**
+     * Whether to stream back partial progress. If set, tokens will be sent as
+     * data-only
+     * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+     * as they become available, with the stream terminated by a `data: [DONE]`
+     * message.
+     * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+     */
+    stream?: false | null;
+}
+export interface CompletionCreateParamsStreaming extends CompletionCreateParamsBase {
+    /**
+     * Whether to stream back partial progress. If set, tokens will be sent as
+     * data-only
+     * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+     * as they become available, with the stream terminated by a `data: [DONE]`
+     * message.
+     * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+     */
+    stream: true;
+}
+export declare namespace Completions {
+    export { type Completion as Completion, type CompletionChoice as CompletionChoice, type CompletionUsage as CompletionUsage, type CompletionCreateParams as CompletionCreateParams, type CompletionCreateParamsNonStreaming as CompletionCreateParamsNonStreaming, type CompletionCreateParamsStreaming as CompletionCreateParamsStreaming, };
+}
+//# sourceMappingURL=completions.d.mts.map

package/resources/completions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completions.d.mts","sourceRoot":"","sources":["../src/resources/completions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,yBAAyB;OAC9B,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE;OACV,EAAE,cAAc,EAAE;AAEzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,kCAAkC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAClG,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACvG,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC;CAS/C;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,aAAa,EAAE,MAAM,GAAG,QAAQ,GAAG,gBAAgB,CAAC;IAEpD,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE3C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,QAAQ;QACvB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB,YAAY,CAAC,EAAE,KAAK,CAAC;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC,CAAC;KACjD;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,eAAe,CAAC,uBAAuB,CAAC;IAEpE;;OAEG;IACH,qBAAqB,CAAC,EAAE,eAAe,CAAC,mBAAmB,CAAC;CAC7D;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;QAEpC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;;;;WAKG;QACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,MAAM,sBAAsB,GAAG,kCAAkC,GAAG,+BAA+B,CAAC;AAE1G,MAAM,WAAW,0BAA0B;IACzC;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,wBAAwB,GAAG,aAAa,GAAG,aAAa,CAAC;IAEhF;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC;IAE7E;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE9C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;;OAMG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAErC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,yBAAyB,CAAC,2BAA2B,GAAG,IAAI,CAAC;IAE9E;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,sBAAsB,CAAC;IACtC,KAAY,kCAAkC,GAAG,cAAc,CAAC,kCAAkC,CAAC;IACnG,KAAY,+BAA+B,GAAG,cAAc,CAAC,+BAA+B,CAAC;CAC9F;AAED,MAAM,WAAW,kCAAmC,SAAQ,0BAA0B;IACpF;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,+BAAgC,SAAQ,0BAA0B;IACjF;;;;;;;OAOG;IACH,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}

package/resources/completions.d.ts

@@ -0,0 +1,332 @@
+import { APIResource } from "../core/resource.js";
+import * as CompletionsAPI from "./completions.js";
+import * as CompletionsCompletionsAPI from "./chat/completions/completions.js";
+import { APIPromise } from "../core/api-promise.js";
+import { Stream } from "../core/streaming.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Completions extends APIResource {
+    /**
+     * Creates a completion for the provided prompt and parameters.
+     *
+     * Returns a completion object, or a sequence of completion objects if the request
+     * is streamed.
+     *
+     * @example
+     * ```ts
+     * const completion = await client.completions.create({
+     *   model: 'string',
+     *   prompt: 'This is a test.',
+     * });
+     * ```
+     */
+    create(body: CompletionCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Completion>;
+    create(body: CompletionCreateParamsStreaming, options?: RequestOptions): APIPromise<Stream<Completion>>;
+    create(body: CompletionCreateParamsBase, options?: RequestOptions): APIPromise<Stream<Completion> | Completion>;
+}
+/**
+ * Represents a completion response from the API. Note: both the streamed and
+ * non-streamed response objects share the same shape (unlike the chat endpoint).
+ */
+export interface Completion {
+    /**
+     * A unique identifier for the completion.
+     */
+    id: string;
+    /**
+     * The list of completion choices the model generated for the input prompt.
+     */
+    choices: Array<CompletionChoice>;
+    /**
+     * The Unix timestamp (in seconds) of when the completion was created.
+     */
+    created: number;
+    /**
+     * The model used for completion.
+     */
+    model: string;
+    /**
+     * The object type, which is always "text_completion"
+     */
+    object: 'text_completion';
+    /**
+     * This fingerprint represents the backend configuration that the model runs with.
+     *
+     * Can be used in conjunction with the `seed` request parameter to understand when
+     * backend changes have been made that might impact determinism.
+     */
+    system_fingerprint?: string;
+    /**
+     * Usage statistics for the completion request.
+     */
+    usage?: CompletionUsage;
+}
+export interface CompletionChoice {
+    /**
+     * The reason the model stopped generating tokens. This will be `stop` if the model
+     * hit a natural stop point or a provided stop sequence, `length` if the maximum
+     * number of tokens specified in the request was reached, or `content_filter` if
+     * content was omitted due to a flag from our content filters.
+     */
+    finish_reason: 'stop' | 'length' | 'content_filter';
+    index: number;
+    logprobs: CompletionChoice.Logprobs | null;
+    text: string;
+}
+export declare namespace CompletionChoice {
+    interface Logprobs {
+        text_offset?: Array<number>;
+        token_logprobs?: Array<number>;
+        tokens?: Array<string>;
+        top_logprobs?: Array<{
+            [key: string]: number;
+        }>;
+    }
+}
+/**
+ * Usage statistics for the completion request.
+ */
+export interface CompletionUsage {
+    /**
+     * Number of tokens in the generated completion.
+     */
+    completion_tokens: number;
+    /**
+     * Number of tokens in the prompt.
+     */
+    prompt_tokens: number;
+    /**
+     * Total number of tokens used in the request (prompt + completion).
+     */
+    total_tokens: number;
+    /**
+     * Breakdown of tokens used in a completion.
+     */
+    completion_tokens_details?: CompletionUsage.CompletionTokensDetails;
+    /**
+     * Breakdown of tokens used in the prompt.
+     */
+    prompt_tokens_details?: CompletionUsage.PromptTokensDetails;
+}
+export declare namespace CompletionUsage {
+    /**
+     * Breakdown of tokens used in a completion.
+     */
+    interface CompletionTokensDetails {
+        /**
+         * When using Predicted Outputs, the number of tokens in the prediction that
+         * appeared in the completion.
+         */
+        accepted_prediction_tokens?: number;
+        /**
+         * Audio input tokens generated by the model.
+         */
+        audio_tokens?: number;
+        /**
+         * Tokens generated by the model for reasoning.
+         */
+        reasoning_tokens?: number;
+        /**
+         * When using Predicted Outputs, the number of tokens in the prediction that did
+         * not appear in the completion. However, like reasoning tokens, these tokens are
+         * still counted in the total completion tokens for purposes of billing, output,
+         * and context window limits.
+         */
+        rejected_prediction_tokens?: number;
+    }
+    /**
+     * Breakdown of tokens used in the prompt.
+     */
+    interface PromptTokensDetails {
+        /**
+         * Audio input tokens present in the prompt.
+         */
+        audio_tokens?: number;
+        /**
+         * Cached tokens present in the prompt.
+         */
+        cached_tokens?: number;
+    }
+}
+export type CompletionCreateParams = CompletionCreateParamsNonStreaming | CompletionCreateParamsStreaming;
+export interface CompletionCreateParamsBase {
+    /**
+     * ID of the model to use. You can use the
+     * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
+     * see all of your available models, or see our
+     * [Model overview](https://platform.openai.com/docs/models) for descriptions of
+     * them.
+     */
+    model: (string & {}) | 'gpt-3.5-turbo-instruct' | 'davinci-002' | 'babbage-002';
+    /**
+     * The prompt(s) to generate completions for, encoded as a string, array of
+     * strings, array of tokens, or array of token arrays.
+     *
+     * Note that <|endoftext|> is the document separator that the model sees during
+     * training, so if a prompt is not specified the model will generate as if from the
+     * beginning of a new document.
+     */
+    prompt: string | Array<string> | Array<number> | Array<Array<number>> | null;
+    /**
+     * Generates `best_of` completions server-side and returns the "best" (the one with
+     * the highest log probability per token). Results cannot be streamed.
+     *
+     * When used with `n`, `best_of` controls the number of candidate completions and
+     * `n` specifies how many to return – `best_of` must be greater than `n`.
+     *
+     * **Note:** Because this parameter generates many completions, it can quickly
+     * consume your token quota. Use carefully and ensure that you have reasonable
+     * settings for `max_tokens` and `stop`.
+     */
+    best_of?: number | null;
+    /**
+     * Echo back the prompt in addition to the completion
+     */
+    echo?: boolean | null;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+     * existing frequency in the text so far, decreasing the model's likelihood to
+     * repeat the same line verbatim.
+     *
+     * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
+     */
+    frequency_penalty?: number | null;
+    /**
+     * Modify the likelihood of specified tokens appearing in the completion.
+     *
+     * Accepts a JSON object that maps tokens (specified by their token ID in the GPT
+     * tokenizer) to an associated bias value from -100 to 100. You can use this
+     * [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs.
+     * Mathematically, the bias is added to the logits generated by the model prior to
+     * sampling. The exact effect will vary per model, but values between -1 and 1
+     * should decrease or increase likelihood of selection; values like -100 or 100
+     * should result in a ban or exclusive selection of the relevant token.
+     *
+     * As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
+     * from being generated.
+     */
+    logit_bias?: {
+        [key: string]: number;
+    } | null;
+    /**
+     * Include the log probabilities on the `logprobs` most likely output tokens, as
+     * well the chosen tokens. For example, if `logprobs` is 5, the API will return a
+     * list of the 5 most likely tokens. The API will always return the `logprob` of
+     * the sampled token, so there may be up to `logprobs+1` elements in the response.
+     *
+     * The maximum value for `logprobs` is 5.
+     */
+    logprobs?: number | null;
+    /**
+     * The maximum number of [tokens](/tokenizer) that can be generated in the
+     * completion.
+     *
+     * The token count of your prompt plus `max_tokens` cannot exceed the model's
+     * context length.
+     * [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
+     * for counting tokens.
+     */
+    max_tokens?: number | null;
+    /**
+     * How many completions to generate for each prompt.
+     *
+     * **Note:** Because this parameter generates many completions, it can quickly
+     * consume your token quota. Use carefully and ensure that you have reasonable
+     * settings for `max_tokens` and `stop`.
+     */
+    n?: number | null;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+     * whether they appear in the text so far, increasing the model's likelihood to
+     * talk about new topics.
+     *
+     * [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
+     */
+    presence_penalty?: number | null;
+    /**
+     * If specified, our system will make a best effort to sample deterministically,
+     * such that repeated requests with the same `seed` and parameters should return
+     * the same result.
+     *
+     * Determinism is not guaranteed, and you should refer to the `system_fingerprint`
+     * response parameter to monitor changes in the backend.
+     */
+    seed?: number | null;
+    /**
+     * Not supported with latest reasoning models `o3` and `o4-mini`.
+     *
+     * Up to 4 sequences where the API will stop generating further tokens. The
+     * returned text will not contain the stop sequence.
+     */
+    stop?: string | null | Array<string>;
+    /**
+     * Whether to stream back partial progress. If set, tokens will be sent as
+     * data-only
+     * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+     * as they become available, with the stream terminated by a `data: [DONE]`
+     * message.
+     * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+     */
+    stream?: boolean | null;
+    /**
+     * Options for streaming response. Only set this when you set `stream: true`.
+     */
+    stream_options?: CompletionsCompletionsAPI.ChatCompletionStreamOptions | null;
+    /**
+     * The suffix that comes after a completion of inserted text.
+     *
+     * This parameter is only supported for `gpt-3.5-turbo-instruct`.
+     */
+    suffix?: string | null;
+    /**
+     * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+     * make the output more random, while lower values like 0.2 will make it more
+     * focused and deterministic.
+     *
+     * We generally recommend altering this or `top_p` but not both.
+     */
+    temperature?: number | null;
+    /**
+     * An alternative to sampling with temperature, called nucleus sampling, where the
+     * model considers the results of the tokens with top_p probability mass. So 0.1
+     * means only the tokens comprising the top 10% probability mass are considered.
+     *
+     * We generally recommend altering this or `temperature` but not both.
+     */
+    top_p?: number | null;
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor
+     * and detect abuse.
+     * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+     */
+    user?: string;
+}
+export declare namespace CompletionCreateParams {
+    type CompletionCreateParamsNonStreaming = CompletionsAPI.CompletionCreateParamsNonStreaming;
+    type CompletionCreateParamsStreaming = CompletionsAPI.CompletionCreateParamsStreaming;
+}
+export interface CompletionCreateParamsNonStreaming extends CompletionCreateParamsBase {
+    /**
+     * Whether to stream back partial progress. If set, tokens will be sent as
+     * data-only
+     * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+     * as they become available, with the stream terminated by a `data: [DONE]`
+     * message.
+     * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+     */
+    stream?: false | null;
+}
+export interface CompletionCreateParamsStreaming extends CompletionCreateParamsBase {
+    /**
+     * Whether to stream back partial progress. If set, tokens will be sent as
+     * data-only
+     * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+     * as they become available, with the stream terminated by a `data: [DONE]`
+     * message.
+     * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+     */
+    stream: true;
+}
+export declare namespace Completions {
+    export { type Completion as Completion, type CompletionChoice as CompletionChoice, type CompletionUsage as CompletionUsage, type CompletionCreateParams as CompletionCreateParams, type CompletionCreateParamsNonStreaming as CompletionCreateParamsNonStreaming, type CompletionCreateParamsStreaming as CompletionCreateParamsStreaming, };
+}
+//# sourceMappingURL=completions.d.ts.map

package/resources/completions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completions.d.ts","sourceRoot":"","sources":["../src/resources/completions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,yBAAyB;OAC9B,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE;OACV,EAAE,cAAc,EAAE;AAEzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,kCAAkC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAClG,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACvG,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC;CAS/C;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,aAAa,EAAE,MAAM,GAAG,QAAQ,GAAG,gBAAgB,CAAC;IAEpD,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE3C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,QAAQ;QACvB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB,YAAY,CAAC,EAAE,KAAK,CAAC;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC,CAAC;KACjD;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,eAAe,CAAC,uBAAuB,CAAC;IAEpE;;OAEG;IACH,qBAAqB,CAAC,EAAE,eAAe,CAAC,mBAAmB,CAAC;CAC7D;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;QAEpC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;;;;WAKG;QACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,MAAM,sBAAsB,GAAG,kCAAkC,GAAG,+BAA+B,CAAC;AAE1G,MAAM,WAAW,0BAA0B;IACzC;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,wBAAwB,GAAG,aAAa,GAAG,aAAa,CAAC;IAEhF;;;;;;;OAOG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC;IAE7E;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE9C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;;OAMG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAErC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,yBAAyB,CAAC,2BAA2B,GAAG,IAAI,CAAC;IAE9E;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,sBAAsB,CAAC;IACtC,KAAY,kCAAkC,GAAG,cAAc,CAAC,kCAAkC,CAAC;IACnG,KAAY,+BAA+B,GAAG,cAAc,CAAC,+BAA+B,CAAC;CAC9F;AAED,MAAM,WAAW,kCAAmC,SAAQ,0BAA0B;IACpF;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,+BAAgC,SAAQ,0BAA0B;IACjF;;;;;;;OAOG;IACH,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}