@ai-sdk/openai 2.0.0-canary.14 → 2.0.0-canary.16

package/dist/internal/index.d.mts

@@ -11,6 +11,16 @@ declare const openaiProviderOptions: z.ZodObject<{
      * the GPT tokenizer) to an associated bias value from -100 to 100.
      */
     logitBias: z.ZodOptional<z.ZodRecord<z.ZodNumber, z.ZodNumber>>;
+    /**
+     * Return the log probabilities of the tokens.
+     *
+     * Setting to true will return the log probabilities of the tokens that
+     * were generated.
+     *
+     * Setting to a number will return the log probabilities of the top n
+     * tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
     /**
      * Whether to enable parallel function calling during tool use. Default to true.
      */
@@ -49,6 +59,7 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -59,6 +70,7 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -123,14 +135,26 @@ declare const openaiCompletionProviderOptions: z.ZodObject<{
   monitor and detect abuse. Learn more.
    */
     user: z.ZodOptional<z.ZodString>;
+    /**
+  Return the log probabilities of the tokens. Including logprobs will increase
+  the response size and can slow down response times. However, it can
+  be useful to better understand how the model is behaving.
+  Setting to true will return the log probabilities of the tokens that
+  were generated.
+  Setting to a number will return the log probabilities of the top n
+  tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<string, number> | undefined;
+    logprobs?: number | boolean | undefined;
     echo?: boolean | undefined;
     suffix?: string | undefined;
 }, {
     user?: string | undefined;
     logitBias?: Record<string, number> | undefined;
+    logprobs?: number | boolean | undefined;
     echo?: boolean | undefined;
     suffix?: string | undefined;
 }>;
@@ -234,37 +258,37 @@ declare const openAITranscriptionProviderOptions: z.ZodObject<{
     /**
      * Additional information to include in the transcription response.
      */
-    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
+    include: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     /**
      * The language of the input audio in ISO-639-1 format.
      */
-    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    language: z.ZodOptional<z.ZodString>;
     /**
      * An optional text to guide the model's style or continue a previous audio segment.
      */
-    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    prompt: z.ZodOptional<z.ZodString>;
     /**
      * The sampling temperature, between 0 and 1.
      * @default 0
      */
-    temperature: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
+    temperature: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     /**
      * The timestamp granularities to populate for this transcription.
      * @default ['segment']
      */
-    timestampGranularities: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodArray<z.ZodEnum<["word", "segment"]>, "many">>>>;
+    timestampGranularities: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodEnum<["word", "segment"]>, "many">>>;
 }, "strip", z.ZodTypeAny, {
-    prompt?: string | null | undefined;
-    temperature?: number | null | undefined;
-    include?: string[] | null | undefined;
-    language?: string | null | undefined;
-    timestampGranularities?: ("word" | "segment")[] | null | undefined;
+    prompt?: string | undefined;
+    temperature?: number | undefined;
+    include?: string[] | undefined;
+    language?: string | undefined;
+    timestampGranularities?: ("word" | "segment")[] | undefined;
 }, {
-    prompt?: string | null | undefined;
-    temperature?: number | null | undefined;
-    include?: string[] | null | undefined;
-    language?: string | null | undefined;
-    timestampGranularities?: ("word" | "segment")[] | null | undefined;
+    prompt?: string | undefined;
+    temperature?: number | undefined;
+    include?: string[] | undefined;
+    language?: string | undefined;
+    timestampGranularities?: ("word" | "segment")[] | undefined;
 }>;
 type OpenAITranscriptionProviderOptions = z.infer<typeof openAITranscriptionProviderOptions>;
 

package/dist/internal/index.d.ts

@@ -11,6 +11,16 @@ declare const openaiProviderOptions: z.ZodObject<{
      * the GPT tokenizer) to an associated bias value from -100 to 100.
      */
     logitBias: z.ZodOptional<z.ZodRecord<z.ZodNumber, z.ZodNumber>>;
+    /**
+     * Return the log probabilities of the tokens.
+     *
+     * Setting to true will return the log probabilities of the tokens that
+     * were generated.
+     *
+     * Setting to a number will return the log probabilities of the top n
+     * tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
     /**
      * Whether to enable parallel function calling during tool use. Default to true.
      */
@@ -49,6 +59,7 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -59,6 +70,7 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -123,14 +135,26 @@ declare const openaiCompletionProviderOptions: z.ZodObject<{
   monitor and detect abuse. Learn more.
    */
     user: z.ZodOptional<z.ZodString>;
+    /**
+  Return the log probabilities of the tokens. Including logprobs will increase
+  the response size and can slow down response times. However, it can
+  be useful to better understand how the model is behaving.
+  Setting to true will return the log probabilities of the tokens that
+  were generated.
+  Setting to a number will return the log probabilities of the top n
+  tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<string, number> | undefined;
+    logprobs?: number | boolean | undefined;
     echo?: boolean | undefined;
     suffix?: string | undefined;
 }, {
     user?: string | undefined;
     logitBias?: Record<string, number> | undefined;
+    logprobs?: number | boolean | undefined;
     echo?: boolean | undefined;
     suffix?: string | undefined;
 }>;
@@ -234,37 +258,37 @@ declare const openAITranscriptionProviderOptions: z.ZodObject<{
     /**
      * Additional information to include in the transcription response.
      */
-    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
+    include: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     /**
      * The language of the input audio in ISO-639-1 format.
      */
-    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    language: z.ZodOptional<z.ZodString>;
     /**
      * An optional text to guide the model's style or continue a previous audio segment.
      */
-    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    prompt: z.ZodOptional<z.ZodString>;
     /**
      * The sampling temperature, between 0 and 1.
      * @default 0
      */
-    temperature: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
+    temperature: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
     /**
      * The timestamp granularities to populate for this transcription.
      * @default ['segment']
      */
-    timestampGranularities: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodArray<z.ZodEnum<["word", "segment"]>, "many">>>>;
+    timestampGranularities: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodEnum<["word", "segment"]>, "many">>>;
 }, "strip", z.ZodTypeAny, {
-    prompt?: string | null | undefined;
-    temperature?: number | null | undefined;
-    include?: string[] | null | undefined;
-    language?: string | null | undefined;
-    timestampGranularities?: ("word" | "segment")[] | null | undefined;
+    prompt?: string | undefined;
+    temperature?: number | undefined;
+    include?: string[] | undefined;
+    language?: string | undefined;
+    timestampGranularities?: ("word" | "segment")[] | undefined;
 }, {
-    prompt?: string | null | undefined;
-    temperature?: number | null | undefined;
-    include?: string[] | null | undefined;
-    language?: string | null | undefined;
-    timestampGranularities?: ("word" | "segment")[] | null | undefined;
+    prompt?: string | undefined;
+    temperature?: number | undefined;
+    include?: string[] | undefined;
+    language?: string | undefined;
+    timestampGranularities?: ("word" | "segment")[] | undefined;
 }>;
 type OpenAITranscriptionProviderOptions = z.infer<typeof openAITranscriptionProviderOptions>;