Beta 8 release of azure-ai-inference Python SDK (#39454)

* Remove mentioning of length of API key. I can now be longer than 32-chars. (#39363)

* Changes to Support Audio Input in ChatCompletions (#39357)

* Add classes to support audio input for chat completions.
* Add corresponding tests and sample

* Update to version beta 8

* Do not filter out the usage updates. (#39381)

* Allow usage updates

* Add changelog entry

* Fix typo in CHANGELOG.md

* Update changelog for audio input (#39443)

* Update changelog for audio input

Signed-off-by: trangevi <[email protected]>

* Remove empty sections

Signed-off-by: trangevi <[email protected]>

---------

Signed-off-by: trangevi <[email protected]>

* Update product link in pacakge README.md

* Fix indentation. Add release date

Signed-off-by: trangevi <[email protected]>

---------

Signed-off-by: trangevi <[email protected]>
Co-authored-by: Travis Angevine <[email protected]>
Co-authored-by: nick863 <[email protected]>

Author: 3 people

.vscode/cspell.json

@@ -33,6 +33,8 @@
     "sdk/batch/azure-batch/**",
     "sdk/ai/**/index/**",
     "sdk/ai/azure-ai-generative/tests/**",
+    "sdk/ai/azure-ai-inference/samples/hello_how_are_you.mp3",
+    "sdk/ai/azure-ai-inference/tests/hello_how_are_you.mp3",
     "sdk/ai/azure-ai-projects/samples/agents/nifty_500_quarterly_results.csv",
     "/sdk/ai/azure-ai-projects/samples/evaluations/async_samples/data/**",
     "/sdk/ai/azure-ai-projects/samples/evaluations/data/**",
@@ -1363,7 +1365,10 @@
         "prompty",
         "rdel",
         "ubinary",
-        "wday"
+        "wday",
+        "Hola",
+        "cómo",
+        "estás"
       ]
     },
     {

sdk/ai/azure-ai-inference/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History
 
+## 1.0.0b8 (2025-01-29)
+
+### Features Added
+
+* Added support for Chat Completions with audio input. See new sample `sample_chat_completions_with_audio_data.py`.
+
+### Bugs Fixed
+
+* Fix a bug that caused filtering of a package with token usage from Azure OpenAI models in the streaming mode.
+
 ## 1.0.0b7 (2025-01-15)
 
 ### Features Added

sdk/ai/azure-ai-inference/README.md

@@ -16,7 +16,7 @@ The Inference client library supports AI models deployed to the following servic
 
 The Inference client library makes services calls using REST API version `2024-05-01-preview`, as documented in [Azure AI Model Inference API](https://aka.ms/azureai/modelinference).
 
-[Product documentation](https://aka.ms/azureai/modelinference)
+[Product documentation](https://aka.ms/aiservices/inference)
 | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ai/azure-ai-inference/samples)
 | [API reference documentation](https://aka.ms/azsdk/azure-ai-inference/python/reference)
 | [Package (Pypi)](https://aka.ms/azsdk/azure-ai-inference/python/package)
@@ -38,12 +38,12 @@ To report an issue with the client library, or request additional features, plea
   * An [Azure subscription](https://azure.microsoft.com/free).
   * An [AI Model from the catalog](https://ai.azure.com/explore/models) deployed through Azure AI Foundry.
   * The endpoint URL of your model, in of the form `https://<your-host-name>.<your-azure-region>.models.ai.azure.com`, where `your-host-name` is your unique model deployment host name and `your-azure-region` is the Azure region where the model is deployed (e.g. `eastus2`).
-  * Depending on your authentication preference, you either need an API key to authenticate against the service, or Entra ID credentials. The API key is a 32-character string.
+  * Depending on your authentication preference, you either need an API key to authenticate against the service, or Entra ID credentials.
 * For Azure OpenAI (AOAI) service
   * An [Azure subscription](https://azure.microsoft.com/free).
   * An [OpenAI Model from the catalog](https://oai.azure.com/resource/models) deployed through Azure AI Foundry.
   * The endpoint URL of your model, in the form `https://<your-resouce-name>.openai.azure.com/openai/deployments/<your-deployment-name>`, where `your-resource-name` is your globally unique AOAI resource name, and `your-deployment-name` is your AI Model deployment name.
-  * Depending on your authentication preference, you either need an API key to authenticate against the service, or Entra ID credentials. The API key is a 32-character string.
+  * Depending on your authentication preference, you either need an API key to authenticate against the service, or Entra ID credentials.
   * An api-version. Latest preview or GA version listed in the `Data plane - inference` row in [the API Specs table](https://aka.ms/azsdk/azure-ai-inference/azure-openai-api-versions). At the time of writing, latest GA version was "2024-06-01".
 
 ### Install the package
@@ -281,6 +281,7 @@ The following types of messages are supported: `SystemMessage`,`UserMessage`, `A
 includes sending an image URL.
 * [sample_chat_completions_with_image_data.py](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ai/azure-ai-inference/samples/sample_chat_completions_with_image_data.py) for usage of `UserMessage` that
 includes sending image data read from a local file.
+* [sample_chat_completions_with_audio_data.py](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ai/azure-ai-inference/samples/sample_chat_completions_with_image_data.py) for usage of `UserMessage` that includes sending audio data read from a local file.
 * [sample_chat_completions_with_structured_output.py](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ai/azure-ai-inference/samples/sample_chat_completions_with_structured_output.py) and [sample_chat_completions_with_structured_output_pydantic.py](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ai/azure-ai-inference/samples/sample_chat_completions_with_structured_output_pydantic.py) for configuring the service to respond with a JSON-formatted string, adhering to your schema.
 
 

sdk/ai/azure-ai-inference/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/ai/azure-ai-inference",
-  "Tag": "python/ai/azure-ai-inference_642ed25a8c"
+  "Tag": "python/ai/azure-ai-inference_bc7c5bd581"
 }

sdk/ai/azure-ai-inference/azure/ai/inference/_client.py

@@ -36,8 +36,8 @@ class ChatCompletionsClient(ChatCompletionsClientOperationsMixin):
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
     :keyword api_version: The API version to use for this operation. Default value is
@@ -114,8 +114,8 @@ class EmbeddingsClient(EmbeddingsClientOperationsMixin):
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
     :keyword api_version: The API version to use for this operation. Default value is
@@ -192,8 +192,8 @@ class ImageEmbeddingsClient(ImageEmbeddingsClientOperationsMixin):
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
     :keyword api_version: The API version to use for this operation. Default value is

sdk/ai/azure-ai-inference/azure/ai/inference/_configuration.py

@@ -25,8 +25,8 @@ class ChatCompletionsClientConfiguration:  # pylint: disable=too-many-instance-a
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
     :keyword api_version: The API version to use for this operation. Default value is
@@ -82,8 +82,8 @@ class EmbeddingsClientConfiguration:  # pylint: disable=too-many-instance-attrib
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
     :keyword api_version: The API version to use for this operation. Default value is
@@ -139,8 +139,8 @@ class ImageEmbeddingsClientConfiguration:  # pylint: disable=too-many-instance-a
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
     :keyword api_version: The API version to use for this operation. Default value is

sdk/ai/azure-ai-inference/azure/ai/inference/_patch.py

@@ -98,8 +98,10 @@ def _get_internal_response_format(
                 _models._models.ChatCompletionsResponseFormatJsonObject()  # pylint: disable=protected-access
             )
         elif isinstance(response_format, _models.JsonSchemaFormat):
-            internal_response_format = _models._models.ChatCompletionsResponseFormatJsonSchema(  # pylint: disable=protected-access
-                json_schema=response_format
+            internal_response_format = (
+                _models._models.ChatCompletionsResponseFormatJsonSchema(  # pylint: disable=protected-access
+                    json_schema=response_format
+                )
             )
         else:
             raise ValueError(f"Unsupported `response_format` {response_format}")
@@ -119,8 +121,10 @@ def load_client(
     `api_version`, `logging_enable`, `user_agent`, etc., you can do so here.
     This method will only work when using Serverless API or Managed Compute endpoint.
     It will not work for GitHub Models endpoint or Azure OpenAI endpoint.
+    Keyword arguments are passed through to the client constructor (you can set keywords such as
+    `api_version`, `user_agent`, `logging_enable` etc. on the client constructor).
 
-    :param endpoint: Service host. Required.
+    :param endpoint: Service endpoint URL for AI model inference. Required.
     :type endpoint: str
     :param credential: Credential used to authenticate requests to the service. Is either a
      AzureKeyCredential type or a TokenCredential type. Required.
@@ -192,7 +196,7 @@ def load_client(
 class ChatCompletionsClient(ChatCompletionsClientGenerated):  # pylint: disable=too-many-instance-attributes
     """ChatCompletionsClient.
 
-    :param endpoint: Service host. Required.
+    :param endpoint: Service endpoint URL for AI model inference. Required.
     :type endpoint: str
     :param credential: Credential used to authenticate requests to the service. Is either a
      AzureKeyCredential type or a TokenCredential type. Required.
@@ -755,7 +759,7 @@ def __str__(self) -> str:
 class EmbeddingsClient(EmbeddingsClientGenerated):
     """EmbeddingsClient.
 
-    :param endpoint: Service host. Required.
+    :param endpoint: Service endpoint URL for AI model inference. Required.
     :type endpoint: str
     :param credential: Credential used to authenticate requests to the service. Is either a
      AzureKeyCredential type or a TokenCredential type. Required.
@@ -1051,7 +1055,7 @@ def __str__(self) -> str:
 class ImageEmbeddingsClient(ImageEmbeddingsClientGenerated):
     """ImageEmbeddingsClient.
 
-    :param endpoint: Service host. Required.
+    :param endpoint: Service endpoint URL for AI model inference. Required.
     :type endpoint: str
     :param credential: Credential used to authenticate requests to the service. Is either a
      AzureKeyCredential type or a TokenCredential type. Required.

sdk/ai/azure-ai-inference/azure/ai/inference/_serialization.py

@@ -185,73 +185,7 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]],
 except NameError:
     _long_type = int
 
-
-class UTC(datetime.tzinfo):
-    """Time Zone info for handling UTC"""
-
-    def utcoffset(self, dt):
-        """UTF offset for UTC is 0.
-
-        :param datetime.datetime dt: The datetime
-        :returns: The offset
-        :rtype: datetime.timedelta
-        """
-        return datetime.timedelta(0)
-
-    def tzname(self, dt):
-        """Timestamp representation.
-
-        :param datetime.datetime dt: The datetime
-        :returns: The timestamp representation
-        :rtype: str
-        """
-        return "Z"
-
-    def dst(self, dt):
-        """No daylight saving for UTC.
-
-        :param datetime.datetime dt: The datetime
-        :returns: The daylight saving time
-        :rtype: datetime.timedelta
-        """
-        return datetime.timedelta(hours=1)
-
-
-try:
-    from datetime import timezone as _FixedOffset  # type: ignore
-except ImportError:  # Python 2.7
-
-    class _FixedOffset(datetime.tzinfo):  # type: ignore
-        """Fixed offset in minutes east from UTC.
-        Copy/pasted from Python doc
-        :param datetime.timedelta offset: offset in timedelta format
-        """
-
-        def __init__(self, offset) -> None:
-            self.__offset = offset
-
-        def utcoffset(self, dt):
-            return self.__offset
-
-        def tzname(self, dt):
-            return str(self.__offset.total_seconds() / 3600)
-
-        def __repr__(self):
-            return "<FixedOffset {}>".format(self.tzname(None))
-
-        def dst(self, dt):
-            return datetime.timedelta(0)
-
-        def __getinitargs__(self):
-            return (self.__offset,)
-
-
-try:
-    from datetime import timezone
-
-    TZ_UTC = timezone.utc
-except ImportError:
-    TZ_UTC = UTC()  # type: ignore
+TZ_UTC = datetime.timezone.utc
 
 _FLATTEN = re.compile(r"(?<!\\)\.")
 
@@ -2051,7 +1985,7 @@ def deserialize_rfc(attr):
         try:
             parsed_date = email.utils.parsedate_tz(attr)  # type: ignore
             date_obj = datetime.datetime(
-                *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60))
+                *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60))
             )
             if not date_obj.tzinfo:
                 date_obj = date_obj.astimezone(tz=TZ_UTC)

sdk/ai/azure-ai-inference/azure/ai/inference/_version.py

@@ -6,4 +6,4 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-VERSION = "1.0.0b7"
+VERSION = "1.0.0b8"

sdk/ai/azure-ai-inference/azure/ai/inference/aio/_client.py

@@ -36,8 +36,8 @@ class ChatCompletionsClient(ChatCompletionsClientOperationsMixin):
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials_async.AsyncTokenCredential
@@ -119,8 +119,8 @@ class EmbeddingsClient(EmbeddingsClientOperationsMixin):
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials_async.AsyncTokenCredential
@@ -202,8 +202,8 @@ class ImageEmbeddingsClient(ImageEmbeddingsClientOperationsMixin):
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials_async.AsyncTokenCredential

sdk/ai/azure-ai-inference/azure/ai/inference/aio/_configuration.py

@@ -25,8 +25,8 @@ class ChatCompletionsClientConfiguration:  # pylint: disable=too-many-instance-a
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials_async.AsyncTokenCredential
@@ -85,8 +85,8 @@ class EmbeddingsClientConfiguration:  # pylint: disable=too-many-instance-attrib
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials_async.AsyncTokenCredential
@@ -145,8 +145,8 @@ class ImageEmbeddingsClientConfiguration:  # pylint: disable=too-many-instance-a
 
     :param endpoint: Service host. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is one of the
-     following types: AzureKeyCredential, AzureKeyCredential, TokenCredential Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
     :type credential: ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials.AzureKeyCredential or
      ~azure.core.credentials_async.AsyncTokenCredential