feat(api): add support for filtering messages by run_id (#1288)

openai · Apr 1, 2024 · 58d6b77 · 58d6b77
1 parent aa5920a
commit 58d6b77
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/src/openai/resources/beta/threads/messages/messages.py b/src/openai/resources/beta/threads/messages/messages.py
@@ -203,6 +203,7 @@ def list(
         before: str | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         order: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
+        run_id: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -230,6 +231,8 @@ def list(
           order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
               order and `desc` for descending order.
 
+          run_id: Filter messages by the run ID that generated them.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -255,6 +258,7 @@ def list(
                         "before": before,
                         "limit": limit,
                         "order": order,
+                        "run_id": run_id,
                     },
                     message_list_params.MessageListParams,
                 ),
@@ -432,6 +436,7 @@ def list(
         before: str | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         order: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
+        run_id: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -459,6 +464,8 @@ def list(
           order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
               order and `desc` for descending order.
 
+          run_id: Filter messages by the run ID that generated them.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -484,6 +491,7 @@ def list(
                         "before": before,
                         "limit": limit,
                         "order": order,
+                        "run_id": run_id,
                     },
                     message_list_params.MessageListParams,
                 ),

diff --git a/src/openai/types/beta/threads/message_list_params.py b/src/openai/types/beta/threads/message_list_params.py
@@ -37,3 +37,6 @@ class MessageListParams(TypedDict, total=False):
 
     `asc` for ascending order and `desc` for descending order.
     """
+
+    run_id: str
+    """Filter messages by the run ID that generated them."""
diff --git a/tests/api_resources/beta/threads/test_messages.py b/tests/api_resources/beta/threads/test_messages.py
@@ -195,6 +195,7 @@ def test_method_list_with_all_params(self, client: OpenAI) -> None:
             before="string",
             limit=0,
             order="asc",
+            run_id="string",
         )
         assert_matches_type(SyncCursorPage[Message], message, path=["response"])
 
@@ -410,6 +411,7 @@ async def test_method_list_with_all_params(self, async_client: AsyncOpenAI) -> N
             before="string",
             limit=0,
             order="asc",
+            run_id="string",
         )
         assert_matches_type(AsyncCursorPage[Message], message, path=["response"])