feat(api): updates (#1146)

openai · Feb 20, 2024 · fc4dafc · fc4dafc
1 parent 7f9e850
commit fc4dafc
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 0 deletions.
diff --git a/src/openai/resources/chat/completions.py b/src/openai/resources/chat/completions.py
@@ -68,6 +68,7 @@ def create(
         frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
         function_call: completion_create_params.FunctionCall | NotGiven = NOT_GIVEN,
         functions: Iterable[completion_create_params.Function] | NotGiven = NOT_GIVEN,
+        instance_id: Optional[str] | NotGiven = NOT_GIVEN,
         logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
         logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
         max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
@@ -122,6 +123,9 @@ def create(
 
               A list of functions the model may generate JSON inputs for.
 
+          instance_id: An unique identifier to a custom instance to execute the request. The requesting
+              organization is required to have access to the instance.
+
           logit_bias: Modify the likelihood of specified tokens appearing in the completion.
 
               Accepts a JSON object that maps tokens (specified by their token ID in the
@@ -259,6 +263,7 @@ def create(
         frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
         function_call: completion_create_params.FunctionCall | NotGiven = NOT_GIVEN,
         functions: Iterable[completion_create_params.Function] | NotGiven = NOT_GIVEN,
+        instance_id: Optional[str] | NotGiven = NOT_GIVEN,
         logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
         logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
         max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
@@ -319,6 +324,9 @@ def create(
 
               A list of functions the model may generate JSON inputs for.
 
+          instance_id: An unique identifier to a custom instance to execute the request. The requesting
+              organization is required to have access to the instance.
+
           logit_bias: Modify the likelihood of specified tokens appearing in the completion.
 
               Accepts a JSON object that maps tokens (specified by their token ID in the
@@ -449,6 +457,7 @@ def create(
         frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
         function_call: completion_create_params.FunctionCall | NotGiven = NOT_GIVEN,
         functions: Iterable[completion_create_params.Function] | NotGiven = NOT_GIVEN,
+        instance_id: Optional[str] | NotGiven = NOT_GIVEN,
         logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
         logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
         max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
@@ -509,6 +518,9 @@ def create(
 
               A list of functions the model may generate JSON inputs for.
 
+          instance_id: An unique identifier to a custom instance to execute the request. The requesting
+              organization is required to have access to the instance.
+
           logit_bias: Modify the likelihood of specified tokens appearing in the completion.
 
               Accepts a JSON object that maps tokens (specified by their token ID in the
@@ -638,6 +650,7 @@ def create(
         frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
         function_call: completion_create_params.FunctionCall | NotGiven = NOT_GIVEN,
         functions: Iterable[completion_create_params.Function] | NotGiven = NOT_GIVEN,
+        instance_id: Optional[str] | NotGiven = NOT_GIVEN,
         logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
         logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
         max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
@@ -669,6 +682,7 @@ def create(
                     "frequency_penalty": frequency_penalty,
                     "function_call": function_call,
                     "functions": functions,
+                    "instance_id": instance_id,
                     "logit_bias": logit_bias,
                     "logprobs": logprobs,
                     "max_tokens": max_tokens,
@@ -735,6 +749,7 @@ async def create(
         frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
         function_call: completion_create_params.FunctionCall | NotGiven = NOT_GIVEN,
         functions: Iterable[completion_create_params.Function] | NotGiven = NOT_GIVEN,
+        instance_id: Optional[str] | NotGiven = NOT_GIVEN,
         logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
         logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
         max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
@@ -789,6 +804,9 @@ async def create(
 
               A list of functions the model may generate JSON inputs for.
 
+          instance_id: An unique identifier to a custom instance to execute the request. The requesting
+              organization is required to have access to the instance.
+
           logit_bias: Modify the likelihood of specified tokens appearing in the completion.
 
               Accepts a JSON object that maps tokens (specified by their token ID in the
@@ -926,6 +944,7 @@ async def create(
         frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
         function_call: completion_create_params.FunctionCall | NotGiven = NOT_GIVEN,
         functions: Iterable[completion_create_params.Function] | NotGiven = NOT_GIVEN,
+        instance_id: Optional[str] | NotGiven = NOT_GIVEN,
         logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
         logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
         max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
@@ -986,6 +1005,9 @@ async def create(
 
               A list of functions the model may generate JSON inputs for.
 
+          instance_id: An unique identifier to a custom instance to execute the request. The requesting
+              organization is required to have access to the instance.
+
           logit_bias: Modify the likelihood of specified tokens appearing in the completion.
 
               Accepts a JSON object that maps tokens (specified by their token ID in the
@@ -1116,6 +1138,7 @@ async def create(
         frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
         function_call: completion_create_params.FunctionCall | NotGiven = NOT_GIVEN,
         functions: Iterable[completion_create_params.Function] | NotGiven = NOT_GIVEN,
+        instance_id: Optional[str] | NotGiven = NOT_GIVEN,
         logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
         logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
         max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
@@ -1176,6 +1199,9 @@ async def create(
 
               A list of functions the model may generate JSON inputs for.
 
+          instance_id: An unique identifier to a custom instance to execute the request. The requesting
+              organization is required to have access to the instance.
+
           logit_bias: Modify the likelihood of specified tokens appearing in the completion.
 
               Accepts a JSON object that maps tokens (specified by their token ID in the
@@ -1305,6 +1331,7 @@ async def create(
         frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
         function_call: completion_create_params.FunctionCall | NotGiven = NOT_GIVEN,
         functions: Iterable[completion_create_params.Function] | NotGiven = NOT_GIVEN,
+        instance_id: Optional[str] | NotGiven = NOT_GIVEN,
         logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
         logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
         max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
@@ -1336,6 +1363,7 @@ async def create(
                     "frequency_penalty": frequency_penalty,
                     "function_call": function_call,
                     "functions": functions,
+                    "instance_id": instance_id,
                     "logit_bias": logit_bias,
                     "logprobs": logprobs,
                     "max_tokens": max_tokens,

diff --git a/src/openai/types/chat/completion_create_params.py b/src/openai/types/chat/completion_create_params.py
@@ -87,6 +87,12 @@ class CompletionCreateParamsBase(TypedDict, total=False):
     A list of functions the model may generate JSON inputs for.
     """
 
+    instance_id: Optional[str]
+    """An unique identifier to a custom instance to execute the request.
+
+    The requesting organization is required to have access to the instance.
+    """
+
     logit_bias: Optional[Dict[str, int]]
     """Modify the likelihood of specified tokens appearing in the completion.
 

diff --git a/tests/api_resources/chat/test_completions.py b/tests/api_resources/chat/test_completions.py
@@ -50,6 +50,7 @@ def test_method_create_with_all_params_overload_1(self, client: OpenAI) -> None:
                     "parameters": {"foo": "bar"},
                 }
             ],
+            instance_id="string",
             logit_bias={"foo": 0},
             logprobs=True,
             max_tokens=0,
@@ -164,6 +165,7 @@ def test_method_create_with_all_params_overload_2(self, client: OpenAI) -> None:
                     "parameters": {"foo": "bar"},
                 }
             ],
+            instance_id="string",
             logit_bias={"foo": 0},
             logprobs=True,
             max_tokens=0,
@@ -280,6 +282,7 @@ async def test_method_create_with_all_params_overload_1(self, async_client: Asyn
                     "parameters": {"foo": "bar"},
                 }
             ],
+            instance_id="string",
             logit_bias={"foo": 0},
             logprobs=True,
             max_tokens=0,
@@ -394,6 +397,7 @@ async def test_method_create_with_all_params_overload_2(self, async_client: Asyn
                     "parameters": {"foo": "bar"},
                 }
             ],
+            instance_id="string",
             logit_bias={"foo": 0},
             logprobs=True,
             max_tokens=0,