openai 4.28.4 → 4.29.0

package/src/resources/beta/threads/messages/messages.ts

@@ -17,7 +17,7 @@ export class Messages extends APIResource {
     threadId: string,
     body: MessageCreateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ThreadMessage> {
+  ): Core.APIPromise<Message> {
     return this._client.post(`/threads/${threadId}/messages`, {
       body,
       ...options,
@@ -28,11 +28,7 @@ export class Messages extends APIResource {
   /**
    * Retrieve a message.
    */
-  retrieve(
-    threadId: string,
-    messageId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ThreadMessage> {
+  retrieve(threadId: string, messageId: string, options?: Core.RequestOptions): Core.APIPromise<Message> {
     return this._client.get(`/threads/${threadId}/messages/${messageId}`, {
       ...options,
       headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
@@ -47,7 +43,7 @@ export class Messages extends APIResource {
     messageId: string,
     body: MessageUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ThreadMessage> {
+  ): Core.APIPromise<Message> {
     return this._client.post(`/threads/${threadId}/messages/${messageId}`, {
       body,
       ...options,
@@ -62,17 +58,17 @@ export class Messages extends APIResource {
     threadId: string,
     query?: MessageListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ThreadMessagesPage, ThreadMessage>;
-  list(threadId: string, options?: Core.RequestOptions): Core.PagePromise<ThreadMessagesPage, ThreadMessage>;
+  ): Core.PagePromise<MessagesPage, Message>;
+  list(threadId: string, options?: Core.RequestOptions): Core.PagePromise<MessagesPage, Message>;
   list(
     threadId: string,
     query: MessageListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ThreadMessagesPage, ThreadMessage> {
+  ): Core.PagePromise<MessagesPage, Message> {
     if (isRequestOptions(query)) {
       return this.list(threadId, {}, query);
     }
-    return this._client.getAPIList(`/threads/${threadId}/messages`, ThreadMessagesPage, {
+    return this._client.getAPIList(`/threads/${threadId}/messages`, MessagesPage, {
       query,
       ...options,
       headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
@@ -80,129 +76,220 @@ export class Messages extends APIResource {
   }
 }
 
-export class ThreadMessagesPage extends CursorPage<ThreadMessage> {}
+export class MessagesPage extends CursorPage<Message> {}
 
 /**
- * References an image [File](https://platform.openai.com/docs/api-reference/files)
- * in the content of a message.
+ * A citation within the message that points to a specific quote from a specific
+ * File associated with the assistant or the message. Generated when the assistant
+ * uses the "retrieval" tool to search files.
+ */
+export type Annotation = FileCitationAnnotation | FilePathAnnotation;
+
+/**
+ * A citation within the message that points to a specific quote from a specific
+ * File associated with the assistant or the message. Generated when the assistant
+ * uses the "retrieval" tool to search files.
+ */
+export type AnnotationDelta = FileCitationDeltaAnnotation | FilePathDeltaAnnotation;
+
+/**
+ * A citation within the message that points to a specific quote from a specific
+ * File associated with the assistant or the message. Generated when the assistant
+ * uses the "retrieval" tool to search files.
  */
-export interface MessageContentImageFile {
-  image_file: MessageContentImageFile.ImageFile;
+export interface FileCitationAnnotation {
+  end_index: number;
+
+  file_citation: FileCitationAnnotation.FileCitation;
+
+  start_index: number;
 
   /**
-   * Always `image_file`.
+   * The text in the message content that needs to be replaced.
    */
-  type: 'image_file';
+  text: string;
+
+  /**
+   * Always `file_citation`.
+   */
+  type: 'file_citation';
 }
 
-export namespace MessageContentImageFile {
-  export interface ImageFile {
+export namespace FileCitationAnnotation {
+  export interface FileCitation {
     /**
-     * The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
-     * in the message content.
+     * The ID of the specific File the citation is from.
      */
     file_id: string;
+
+    /**
+     * The specific quote in the file.
+     */
+    quote: string;
   }
 }
 
 /**
- * The text content that is part of a message.
+ * A citation within the message that points to a specific quote from a specific
+ * File associated with the assistant or the message. Generated when the assistant
+ * uses the "retrieval" tool to search files.
  */
-export interface MessageContentText {
-  text: MessageContentText.Text;
+export interface FileCitationDeltaAnnotation {
+  /**
+   * The index of the annotation in the text content part.
+   */
+  index: number;
 
   /**
-   * Always `text`.
+   * Always `file_citation`.
    */
-  type: 'text';
+  type: 'file_citation';
+
+  end_index?: number;
+
+  file_citation?: FileCitationDeltaAnnotation.FileCitation;
+
+  start_index?: number;
+
+  /**
+   * The text in the message content that needs to be replaced.
+   */
+  text?: string;
 }
 
-export namespace MessageContentText {
-  export interface Text {
-    annotations: Array<Text.FileCitation | Text.FilePath>;
+export namespace FileCitationDeltaAnnotation {
+  export interface FileCitation {
+    /**
+     * The ID of the specific File the citation is from.
+     */
+    file_id?: string;
 
     /**
-     * The data that makes up the text.
+     * The specific quote in the file.
      */
-    value: string;
+    quote?: string;
   }
+}
+
+/**
+ * A URL for the file that's generated when the assistant used the
+ * `code_interpreter` tool to generate a file.
+ */
+export interface FilePathAnnotation {
+  end_index: number;
+
+  file_path: FilePathAnnotation.FilePath;
+
+  start_index: number;
+
+  /**
+   * The text in the message content that needs to be replaced.
+   */
+  text: string;
+
+  /**
+   * Always `file_path`.
+   */
+  type: 'file_path';
+}
 
-  export namespace Text {
+export namespace FilePathAnnotation {
+  export interface FilePath {
     /**
-     * A citation within the message that points to a specific quote from a specific
-     * File associated with the assistant or the message. Generated when the assistant
-     * uses the "retrieval" tool to search files.
+     * The ID of the file that was generated.
      */
-    export interface FileCitation {
-      end_index: number;
+    file_id: string;
+  }
+}
+
+/**
+ * A URL for the file that's generated when the assistant used the
+ * `code_interpreter` tool to generate a file.
+ */
+export interface FilePathDeltaAnnotation {
+  /**
+   * The index of the annotation in the text content part.
+   */
+  index: number;
 
-      file_citation: FileCitation.FileCitation;
+  /**
+   * Always `file_path`.
+   */
+  type: 'file_path';
 
-      start_index: number;
+  end_index?: number;
 
-      /**
-       * The text in the message content that needs to be replaced.
-       */
-      text: string;
+  file_path?: FilePathDeltaAnnotation.FilePath;
 
-      /**
-       * Always `file_citation`.
-       */
-      type: 'file_citation';
-    }
+  start_index?: number;
 
-    export namespace FileCitation {
-      export interface FileCitation {
-        /**
-         * The ID of the specific File the citation is from.
-         */
-        file_id: string;
-
-        /**
-         * The specific quote in the file.
-         */
-        quote: string;
-      }
-    }
+  /**
+   * The text in the message content that needs to be replaced.
+   */
+  text?: string;
+}
 
+export namespace FilePathDeltaAnnotation {
+  export interface FilePath {
     /**
-     * A URL for the file that's generated when the assistant used the
-     * `code_interpreter` tool to generate a file.
+     * The ID of the file that was generated.
      */
-    export interface FilePath {
-      end_index: number;
+    file_id?: string;
+  }
+}
 
-      file_path: FilePath.FilePath;
+export interface ImageFile {
+  /**
+   * The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
+   * in the message content.
+   */
+  file_id: string;
+}
 
-      start_index: number;
+/**
+ * References an image [File](https://platform.openai.com/docs/api-reference/files)
+ * in the content of a message.
+ */
+export interface ImageFileContentBlock {
+  image_file: ImageFile;
 
-      /**
-       * The text in the message content that needs to be replaced.
-       */
-      text: string;
+  /**
+   * Always `image_file`.
+   */
+  type: 'image_file';
+}
 
-      /**
-       * Always `file_path`.
-       */
-      type: 'file_path';
-    }
+export interface ImageFileDelta {
+  /**
+   * The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
+   * in the message content.
+   */
+  file_id?: string;
+}
 
-    export namespace FilePath {
-      export interface FilePath {
-        /**
-         * The ID of the file that was generated.
-         */
-        file_id: string;
-      }
-    }
-  }
+/**
+ * References an image [File](https://platform.openai.com/docs/api-reference/files)
+ * in the content of a message.
+ */
+export interface ImageFileDeltaBlock {
+  /**
+   * The index of the content part in the message.
+   */
+  index: number;
+
+  /**
+   * Always `image_file`.
+   */
+  type: 'image_file';
+
+  image_file?: ImageFileDelta;
 }
 
 /**
  * Represents a message within a
  * [thread](https://platform.openai.com/docs/api-reference/threads).
  */
-export interface ThreadMessage {
+export interface Message {
   /**
    * The identifier, which can be referenced in API endpoints.
    */
@@ -215,10 +302,15 @@ export interface ThreadMessage {
    */
   assistant_id: string | null;
 
+  /**
+   * The Unix timestamp (in seconds) for when the message was completed.
+   */
+  completed_at: number | null;
+
   /**
    * The content of the message in array of text and/or images.
    */
-  content: Array<MessageContentImageFile | MessageContentText>;
+  content: Array<MessageContent>;
 
   /**
    * The Unix timestamp (in seconds) for when the message was created.
@@ -232,6 +324,16 @@ export interface ThreadMessage {
    */
   file_ids: Array<string>;
 
+  /**
+   * The Unix timestamp (in seconds) for when the message was marked as incomplete.
+   */
+  incomplete_at: number | null;
+
+  /**
+   * On an incomplete message, details about why the message is incomplete.
+   */
+  incomplete_details: Message.IncompleteDetails | null;
+
   /**
    * Set of 16 key-value pairs that can be attached to an object. This can be useful
    * for storing additional information about the object in a structured format. Keys
@@ -257,6 +359,12 @@ export interface ThreadMessage {
    */
   run_id: string | null;
 
+  /**
+   * The status of the message, which can be either `in_progress`, `incomplete`, or
+   * `completed`.
+   */
+  status: 'in_progress' | 'incomplete' | 'completed';
+
   /**
    * The [thread](https://platform.openai.com/docs/api-reference/threads) ID that
    * this message belongs to.
@@ -264,7 +372,31 @@ export interface ThreadMessage {
   thread_id: string;
 }
 
-export interface ThreadMessageDeleted {
+export namespace Message {
+  /**
+   * On an incomplete message, details about why the message is incomplete.
+   */
+  export interface IncompleteDetails {
+    /**
+     * The reason the message is incomplete.
+     */
+    reason: 'content_filter' | 'max_tokens' | 'run_cancelled' | 'run_expired' | 'run_failed';
+  }
+}
+
+/**
+ * References an image [File](https://platform.openai.com/docs/api-reference/files)
+ * in the content of a message.
+ */
+export type MessageContent = ImageFileContentBlock | TextContentBlock;
+
+/**
+ * References an image [File](https://platform.openai.com/docs/api-reference/files)
+ * in the content of a message.
+ */
+export type MessageContentDelta = ImageFileDeltaBlock | TextDeltaBlock;
+
+export interface MessageDeleted {
   id: string;
 
   deleted: boolean;
@@ -272,6 +404,96 @@ export interface ThreadMessageDeleted {
   object: 'thread.message.deleted';
 }
 
+/**
+ * The delta containing the fields that have changed on the Message.
+ */
+export interface MessageDelta {
+  /**
+   * The content of the message in array of text and/or images.
+   */
+  content?: Array<MessageContentDelta>;
+
+  /**
+   * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs that
+   * the assistant should use. Useful for tools like retrieval and code_interpreter
+   * that can access files. A maximum of 10 files can be attached to a message.
+   */
+  file_ids?: Array<string>;
+
+  /**
+   * The entity that produced the message. One of `user` or `assistant`.
+   */
+  role?: 'user' | 'assistant';
+}
+
+/**
+ * Represents a message delta i.e. any changed fields on a message during
+ * streaming.
+ */
+export interface MessageDeltaEvent {
+  /**
+   * The identifier of the message, which can be referenced in API endpoints.
+   */
+  id: string;
+
+  /**
+   * The delta containing the fields that have changed on the Message.
+   */
+  delta: MessageDelta;
+
+  /**
+   * The object type, which is always `thread.message.delta`.
+   */
+  object: 'thread.message.delta';
+}
+
+export interface Text {
+  annotations: Array<Annotation>;
+
+  /**
+   * The data that makes up the text.
+   */
+  value: string;
+}
+
+/**
+ * The text content that is part of a message.
+ */
+export interface TextContentBlock {
+  text: Text;
+
+  /**
+   * Always `text`.
+   */
+  type: 'text';
+}
+
+export interface TextDelta {
+  annotations?: Array<AnnotationDelta>;
+
+  /**
+   * The data that makes up the text.
+   */
+  value?: string;
+}
+
+/**
+ * The text content that is part of a message.
+ */
+export interface TextDeltaBlock {
+  /**
+   * The index of the content part in the message.
+   */
+  index: number;
+
+  /**
+   * Always `text`.
+   */
+  type: 'text';
+
+  text?: TextDelta;
+}
+
 export interface MessageCreateParams {
   /**
    * The content of the message.
@@ -328,11 +550,27 @@ export interface MessageListParams extends CursorPageParams {
 }
 
 export namespace Messages {
-  export import MessageContentImageFile = MessagesAPI.MessageContentImageFile;
-  export import MessageContentText = MessagesAPI.MessageContentText;
-  export import ThreadMessage = MessagesAPI.ThreadMessage;
-  export import ThreadMessageDeleted = MessagesAPI.ThreadMessageDeleted;
-  export import ThreadMessagesPage = MessagesAPI.ThreadMessagesPage;
+  export import Annotation = MessagesAPI.Annotation;
+  export import AnnotationDelta = MessagesAPI.AnnotationDelta;
+  export import FileCitationAnnotation = MessagesAPI.FileCitationAnnotation;
+  export import FileCitationDeltaAnnotation = MessagesAPI.FileCitationDeltaAnnotation;
+  export import FilePathAnnotation = MessagesAPI.FilePathAnnotation;
+  export import FilePathDeltaAnnotation = MessagesAPI.FilePathDeltaAnnotation;
+  export import ImageFile = MessagesAPI.ImageFile;
+  export import ImageFileContentBlock = MessagesAPI.ImageFileContentBlock;
+  export import ImageFileDelta = MessagesAPI.ImageFileDelta;
+  export import ImageFileDeltaBlock = MessagesAPI.ImageFileDeltaBlock;
+  export import Message = MessagesAPI.Message;
+  export import MessageContent = MessagesAPI.MessageContent;
+  export import MessageContentDelta = MessagesAPI.MessageContentDelta;
+  export import MessageDeleted = MessagesAPI.MessageDeleted;
+  export import MessageDelta = MessagesAPI.MessageDelta;
+  export import MessageDeltaEvent = MessagesAPI.MessageDeltaEvent;
+  export import Text = MessagesAPI.Text;
+  export import TextContentBlock = MessagesAPI.TextContentBlock;
+  export import TextDelta = MessagesAPI.TextDelta;
+  export import TextDeltaBlock = MessagesAPI.TextDeltaBlock;
+  export import MessagesPage = MessagesAPI.MessagesPage;
   export import MessageCreateParams = MessagesAPI.MessageCreateParams;
   export import MessageUpdateParams = MessagesAPI.MessageUpdateParams;
   export import MessageListParams = MessagesAPI.MessageListParams;

package/src/resources/beta/threads/runs/index.ts

@@ -1,11 +1,22 @@
 // File generated from our OpenAPI spec by Stainless.
 
 export {
-  CodeToolCall,
+  CodeInterpreterLogs,
+  CodeInterpreterOutputImage,
+  CodeInterpreterToolCall,
+  CodeInterpreterToolCallDelta,
   FunctionToolCall,
+  FunctionToolCallDelta,
   MessageCreationStepDetails,
   RetrievalToolCall,
+  RetrievalToolCallDelta,
   RunStep,
+  RunStepDelta,
+  RunStepDeltaEvent,
+  RunStepDeltaMessageDelta,
+  ToolCall,
+  ToolCallDelta,
+  ToolCallDeltaObject,
   ToolCallsStepDetails,
   StepListParams,
   RunStepsPage,
@@ -16,9 +27,15 @@ export {
   Run,
   RunStatus,
   RunCreateParams,
+  RunCreateParamsNonStreaming,
+  RunCreateParamsStreaming,
   RunUpdateParams,
   RunListParams,
+  RunCreateAndStreamParams,
   RunSubmitToolOutputsParams,
+  RunSubmitToolOutputsParamsNonStreaming,
+  RunSubmitToolOutputsParamsStreaming,
+  RunSubmitToolOutputsStreamParams,
   RunsPage,
   Runs,
 } from './runs';