feat: add logprobs and top_logprobs parameters to Responses API

examples/responses/logprobs.ts

@@ -0,0 +1,38 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import OpenAI from 'openai';
+
+const openai = new OpenAI();
+
+async function main() {
+  const result = await openai.responses
+    .create({
+      model: 'gpt-4o-2024-08-06',
+      input: 'solve 8x + 31 = 2',
+      include: ['message.output_text.logprobs'],
+      top_logprobs: 20,
+    });
+
+    for(const output of result.output) {
+        if(output.type === 'message') {
+            const logprobs = output.content.filter(content => content.type === 'output_text')
+            for(const logprob of logprobs) {
+                if(logprob.type === 'output_text') {
+
+                    // Top Logprobs
+                    console.log(logprob.logprobs?.[0]?.top_logprobs);
+
+                    // Token
+                    console.log(logprob.logprobs?.[0]?.token);
+
+                    // Token Logprobs
+                    console.log(logprob.logprobs?.[0]?.logprob);
+
+                    // Bytes
+                    console.log(logprob.logprobs?.[0]?.bytes);
+                }
+            }
+        }
+    }
+}
+main();

examples/responses/non-stream.ts

@@ -0,0 +1,16 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import OpenAI from 'openai';
+
+const openai = new OpenAI();
+
+async function main() {
+  const result = await openai.responses
+    .create({
+      model: 'gpt-4o-2024-08-06',
+      input: 'solve 8x + 31 = 2',
+    });
+
+    console.log(result.output_text);
+}
+main();

src/resources/responses/responses.ts

@@ -1946,7 +1946,8 @@ export type ResponseIncludable =
   | 'message.input_image.image_url'
   | 'computer_call_output.output.image_url'
   | 'reasoning.encrypted_content'
-  | 'code_interpreter_call.outputs';
+  | 'code_interpreter_call.outputs'
+  | 'message.output_text.logprobs';
 
 /**
  * An event that is emitted when a response finishes as incomplete.
@@ -4770,6 +4771,11 @@ export interface ResponseCreateParamsBase {
    */
   include?: Array<ResponseIncludable> | null;
 
+  /**
+   * The number of top logprobs to include in the response.
+   */
+  top_logprobs?: number | null;
+
   /**
    * Text, image, or file inputs to the model, used to generate a response.
    *