Skip to content

Commit 1179395

Browse files
author
SDKAuto
committed
CodeGen from PR 31869 in Azure/azure-rest-api-specs
Merge 41bbb0705062205769a3360373705880ee98b6a5 into 5d48b962e325123b8a3514f7eff49702838a942d
1 parent 5e04ce6 commit 1179395

31 files changed

+391
-6561
lines changed

‎sdk/ai/azure-ai-inference/_meta.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "03dbe6c563a5196704d5381e97d1df4d1da1dea6",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/ai/ModelClient",
5+
"@azure-tools/typespec-python": "0.38.3"
6+
}

‎sdk/ai/azure-ai-inference/apiview-properties.json‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"CrossLanguagePackageId": "AI.Model",
3+
"CrossLanguageDefinitionId": {
4+
"azure.ai.inference.models.ContentItem": "AI.Model.ChatMessageContentItem",
5+
"azure.ai.inference.models.AudioUrlContentItem": "AI.Model.ChatMessageAudioUrlContentItem",
6+
"azure.ai.inference.models.ChatChoice": "AI.Model.ChatChoice",
7+
"azure.ai.inference.models.ChatCompletions": "AI.Model.ChatCompletions",
8+
"azure.ai.inference.models.ChatCompletionsNamedToolChoice": "AI.Model.ChatCompletionsNamedToolChoice",
9+
"azure.ai.inference.models.ChatCompletionsNamedToolChoiceFunction": "AI.Model.ChatCompletionsNamedToolChoiceFunction",
10+
"azure.ai.inference.models.ChatCompletionsToolCall": "AI.Model.ChatCompletionsToolCall",
11+
"azure.ai.inference.models.ChatCompletionsToolDefinition": "AI.Model.ChatCompletionsToolDefinition",
12+
"azure.ai.inference.models.ChatMessageAudioDataContentItem": "AI.Model.ChatMessageAudioDataContentItem",
13+
"azure.ai.inference.models.ChatMessageInputAudioUrl": "AI.Model.ChatMessageInputAudioUrl",
14+
"azure.ai.inference.models.ChatResponseMessage": "AI.Model.ChatResponseMessage",
15+
"azure.ai.inference.models.CompletionsUsage": "AI.Model.CompletionsUsage",
16+
"azure.ai.inference.models.EmbeddingItem": "AI.Model.EmbeddingItem",
17+
"azure.ai.inference.models.EmbeddingsResult": "AI.Model.EmbeddingsResult",
18+
"azure.ai.inference.models.EmbeddingsUsage": "AI.Model.EmbeddingsUsage",
19+
"azure.ai.inference.models.FunctionCall": "AI.Model.FunctionCall",
20+
"azure.ai.inference.models.FunctionDefinition": "AI.Model.FunctionDefinition",
21+
"azure.ai.inference.models.ImageContentItem": "AI.Model.ChatMessageImageContentItem",
22+
"azure.ai.inference.models.ImageEmbeddingInput": "AI.Model.ImageEmbeddingInput",
23+
"azure.ai.inference.models.ImageUrl": "AI.Model.ChatMessageImageUrl",
24+
"azure.ai.inference.models.InputAudio": "AI.Model.ChatMessageInputAudio",
25+
"azure.ai.inference.models.JsonSchemaFormat": "AI.Model.ChatCompletionsResponseFormatJsonSchemaDefinition",
26+
"azure.ai.inference.models.ModelInfo": "AI.Model.ModelInfo",
27+
"azure.ai.inference.models.StreamingChatChoiceUpdate": "AI.Model.StreamingChatChoiceUpdate",
28+
"azure.ai.inference.models.StreamingChatCompletionsUpdate": "AI.Model.StreamingChatCompletionsUpdate",
29+
"azure.ai.inference.models.StreamingChatResponseMessageUpdate": "AI.Model.StreamingChatResponseMessageUpdate",
30+
"azure.ai.inference.models.StreamingChatResponseToolCallUpdate": "AI.Model.StreamingChatResponseToolCallUpdate",
31+
"azure.ai.inference.models.TextContentItem": "AI.Model.ChatMessageTextContentItem",
32+
"azure.ai.inference.models.CompletionsFinishReason": "AI.Model.CompletionsFinishReason",
33+
"azure.ai.inference.models.ChatRole": "AI.Model.ChatRole",
34+
"azure.ai.inference.models.ImageDetailLevel": "AI.Model.ChatMessageImageDetailLevel",
35+
"azure.ai.inference.models.AudioContentFormat": "AI.Model.AudioContentFormat",
36+
"azure.ai.inference.models.ChatCompletionsToolChoicePreset": "AI.Model.ChatCompletionsToolChoicePreset",
37+
"azure.ai.inference.models.ModelType": "AI.Model.ModelType",
38+
"azure.ai.inference.models.EmbeddingEncodingFormat": "AI.Model.EmbeddingEncodingFormat",
39+
"azure.ai.inference.models.EmbeddingInputType": "AI.Model.EmbeddingInputType"
40+
}
41+
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class ChatCompletionsClient(ChatCompletionsClientOperationsMixin):
3939
:param credential: Credential used to authenticate requests to the service. Is either a key
4040
credential type or a token credential type. Required.
4141
:type credential: ~azure.core.credentials.AzureKeyCredential or
42-
~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
42+
~azure.core.credentials.TokenCredential
4343
:keyword api_version: The API version to use for this operation. Default value is
4444
"2024-05-01-preview". Note that overriding this default value may result in unsupported
4545
behavior.
@@ -117,7 +117,7 @@ class EmbeddingsClient(EmbeddingsClientOperationsMixin):
117117
:param credential: Credential used to authenticate requests to the service. Is either a key
118118
credential type or a token credential type. Required.
119119
:type credential: ~azure.core.credentials.AzureKeyCredential or
120-
~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
120+
~azure.core.credentials.TokenCredential
121121
:keyword api_version: The API version to use for this operation. Default value is
122122
"2024-05-01-preview". Note that overriding this default value may result in unsupported
123123
behavior.
@@ -195,7 +195,7 @@ class ImageEmbeddingsClient(ImageEmbeddingsClientOperationsMixin):
195195
:param credential: Credential used to authenticate requests to the service. Is either a key
196196
credential type or a token credential type. Required.
197197
:type credential: ~azure.core.credentials.AzureKeyCredential or
198-
~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
198+
~azure.core.credentials.TokenCredential
199199
:keyword api_version: The API version to use for this operation. Default value is
200200
"2024-05-01-preview". Note that overriding this default value may result in unsupported
201201
behavior.

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class ChatCompletionsClientConfiguration: # pylint: disable=too-many-instance-a
2828
:param credential: Credential used to authenticate requests to the service. Is either a key
2929
credential type or a token credential type. Required.
3030
:type credential: ~azure.core.credentials.AzureKeyCredential or
31-
~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
31+
~azure.core.credentials.TokenCredential
3232
:keyword api_version: The API version to use for this operation. Default value is
3333
"2024-05-01-preview". Note that overriding this default value may result in unsupported
3434
behavior.
@@ -54,8 +54,6 @@ def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCr
5454
def _infer_policy(self, **kwargs):
5555
if isinstance(self.credential, AzureKeyCredential):
5656
return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", prefix="Bearer", **kwargs)
57-
if isinstance(self.credential, AzureKeyCredential):
58-
return policies.AzureKeyCredentialPolicy(self.credential, "api-key", **kwargs)
5957
if hasattr(self.credential, "get_token"):
6058
return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs)
6159
raise TypeError(f"Unsupported credential: {self.credential}")
@@ -85,7 +83,7 @@ class EmbeddingsClientConfiguration: # pylint: disable=too-many-instance-attrib
8583
:param credential: Credential used to authenticate requests to the service. Is either a key
8684
credential type or a token credential type. Required.
8785
:type credential: ~azure.core.credentials.AzureKeyCredential or
88-
~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
86+
~azure.core.credentials.TokenCredential
8987
:keyword api_version: The API version to use for this operation. Default value is
9088
"2024-05-01-preview". Note that overriding this default value may result in unsupported
9189
behavior.
@@ -111,8 +109,6 @@ def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCr
111109
def _infer_policy(self, **kwargs):
112110
if isinstance(self.credential, AzureKeyCredential):
113111
return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", prefix="Bearer", **kwargs)
114-
if isinstance(self.credential, AzureKeyCredential):
115-
return policies.AzureKeyCredentialPolicy(self.credential, "api-key", **kwargs)
116112
if hasattr(self.credential, "get_token"):
117113
return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs)
118114
raise TypeError(f"Unsupported credential: {self.credential}")
@@ -142,7 +138,7 @@ class ImageEmbeddingsClientConfiguration: # pylint: disable=too-many-instance-a
142138
:param credential: Credential used to authenticate requests to the service. Is either a key
143139
credential type or a token credential type. Required.
144140
:type credential: ~azure.core.credentials.AzureKeyCredential or
145-
~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
141+
~azure.core.credentials.TokenCredential
146142
:keyword api_version: The API version to use for this operation. Default value is
147143
"2024-05-01-preview". Note that overriding this default value may result in unsupported
148144
behavior.
@@ -168,8 +164,6 @@ def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCr
168164
def _infer_policy(self, **kwargs):
169165
if isinstance(self.credential, AzureKeyCredential):
170166
return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", prefix="Bearer", **kwargs)
171-
if isinstance(self.credential, AzureKeyCredential):
172-
return policies.AzureKeyCredentialPolicy(self.credential, "api-key", **kwargs)
173167
if hasattr(self.credential, "get_token"):
174168
return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs)
175169
raise TypeError(f"Unsupported credential: {self.credential}")

‎sdk/ai/azure-ai-inference/azure/ai/inference/_model_base.py‎

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# pylint: disable=too-many-lines,arguments-differ,signature-differs,no-member
1+
# pylint: disable=too-many-lines
22
# coding=utf-8
33
# --------------------------------------------------------------------------
44
# Copyright (c) Microsoft Corporation. All rights reserved.
@@ -373,15 +373,34 @@ def __ne__(self, other: typing.Any) -> bool:
373373
return not self.__eq__(other)
374374

375375
def keys(self) -> typing.KeysView[str]:
376+
"""
377+
:returns: a set-like object providing a view on D's keys
378+
:rtype: ~typing.KeysView
379+
"""
376380
return self._data.keys()
377381

378382
def values(self) -> typing.ValuesView[typing.Any]:
383+
"""
384+
:returns: an object providing a view on D's values
385+
:rtype: ~typing.ValuesView
386+
"""
379387
return self._data.values()
380388

381389
def items(self) -> typing.ItemsView[str, typing.Any]:
390+
"""
391+
:returns: set-like object providing a view on D's items
392+
:rtype: ~typing.ItemsView
393+
"""
382394
return self._data.items()
383395

384396
def get(self, key: str, default: typing.Any = None) -> typing.Any:
397+
"""
398+
Get the value for key if key is in the dictionary, else default.
399+
:param str key: The key to look up.
400+
:param any default: The value to return if key is not in the dictionary. Defaults to None
401+
:returns: D[k] if k in D, else d.
402+
:rtype: any
403+
"""
385404
try:
386405
return self[key]
387406
except KeyError:
@@ -397,17 +416,38 @@ def pop(self, key: str, default: _T) -> _T: ...
397416
def pop(self, key: str, default: typing.Any) -> typing.Any: ...
398417

399418
def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any:
419+
"""
420+
Removes specified key and return the corresponding value.
421+
:param str key: The key to pop.
422+
:param any default: The value to return if key is not in the dictionary
423+
:returns: The value corresponding to the key.
424+
:rtype: any
425+
:raises KeyError: If key is not found and default is not given.
426+
"""
400427
if default is _UNSET:
401428
return self._data.pop(key)
402429
return self._data.pop(key, default)
403430

404431
def popitem(self) -> typing.Tuple[str, typing.Any]:
432+
"""
433+
Removes and returns some (key, value) pair
434+
:returns: The (key, value) pair.
435+
:rtype: tuple
436+
:raises KeyError: if D is empty.
437+
"""
405438
return self._data.popitem()
406439

407440
def clear(self) -> None:
441+
"""
442+
Remove all items from D.
443+
"""
408444
self._data.clear()
409445

410446
def update(self, *args: typing.Any, **kwargs: typing.Any) -> None:
447+
"""
448+
Updates D from mapping/iterable E and F.
449+
:param any args: Either a mapping object or an iterable of key-value pairs.
450+
"""
411451
self._data.update(*args, **kwargs)
412452

413453
@typing.overload
@@ -417,6 +457,13 @@ def setdefault(self, key: str, default: None = None) -> None: ...
417457
def setdefault(self, key: str, default: typing.Any) -> typing.Any: ...
418458

419459
def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any:
460+
"""
461+
Same as calling D.get(k, d), and setting D[k]=d if k not found
462+
:param str key: The key to look up.
463+
:param any default: The value to set if key is not in the dictionary
464+
:returns: D[k] if k in D, else d.
465+
:rtype: any
466+
"""
420467
if default is _UNSET:
421468
return self._data.setdefault(key)
422469
return self._data.setdefault(key, default)
@@ -910,6 +957,19 @@ def _failsafe_deserialize(
910957
return None
911958

912959

960+
def _failsafe_deserialize_xml(
961+
deserializer: typing.Any,
962+
value: typing.Any,
963+
) -> typing.Any:
964+
try:
965+
return _deserialize_xml(deserializer, value)
966+
except DeserializationError:
967+
_LOGGER.warning(
968+
"Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True
969+
)
970+
return None
971+
972+
913973
class _RestField:
914974
def __init__(
915975
self,

‎sdk/ai/azure-ai-inference/azure/ai/inference/_operations/_operations.py‎

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# pylint: disable=too-many-locals
21
# coding=utf-8
32
# --------------------------------------------------------------------------
43
# Copyright (c) Microsoft Corporation. All rights reserved.
@@ -181,15 +180,6 @@ def build_image_embeddings_get_model_info_request(**kwargs: Any) -> HttpRequest:
181180

182181
class ChatCompletionsClientOperationsMixin(ChatCompletionsClientMixinABC):
183182

184-
@overload
185-
def _complete(
186-
self,
187-
body: JSON,
188-
*,
189-
extra_params: Optional[Union[str, _models._enums.ExtraParameters]] = None,
190-
content_type: str = "application/json",
191-
**kwargs: Any
192-
) -> _models.ChatCompletions: ...
193183
@overload
194184
def _complete(
195185
self,
@@ -214,6 +204,15 @@ def _complete(
214204
**kwargs: Any
215205
) -> _models.ChatCompletions: ...
216206
@overload
207+
def _complete(
208+
self,
209+
body: JSON,
210+
*,
211+
extra_params: Optional[Union[str, _models._enums.ExtraParameters]] = None,
212+
content_type: str = "application/json",
213+
**kwargs: Any
214+
) -> _models.ChatCompletions: ...
215+
@overload
217216
def _complete(
218217
self,
219218
body: IO[bytes],
@@ -488,23 +487,23 @@ class EmbeddingsClientOperationsMixin(EmbeddingsClientMixinABC):
488487
@overload
489488
def _embed(
490489
self,
491-
body: JSON,
492490
*,
491+
input: List[str],
493492
extra_params: Optional[Union[str, _models._enums.ExtraParameters]] = None,
494493
content_type: str = "application/json",
494+
dimensions: Optional[int] = None,
495+
encoding_format: Optional[Union[str, _models.EmbeddingEncodingFormat]] = None,
496+
input_type: Optional[Union[str, _models.EmbeddingInputType]] = None,
497+
model: Optional[str] = None,
495498
**kwargs: Any
496499
) -> _models.EmbeddingsResult: ...
497500
@overload
498501
def _embed(
499502
self,
503+
body: JSON,
500504
*,
501-
input: List[str],
502505
extra_params: Optional[Union[str, _models._enums.ExtraParameters]] = None,
503506
content_type: str = "application/json",
504-
dimensions: Optional[int] = None,
505-
encoding_format: Optional[Union[str, _models.EmbeddingEncodingFormat]] = None,
506-
input_type: Optional[Union[str, _models.EmbeddingInputType]] = None,
507-
model: Optional[str] = None,
508507
**kwargs: Any
509508
) -> _models.EmbeddingsResult: ...
510509
@overload
@@ -701,23 +700,23 @@ class ImageEmbeddingsClientOperationsMixin(ImageEmbeddingsClientMixinABC):
701700
@overload
702701
def _embed(
703702
self,
704-
body: JSON,
705703
*,
704+
input: List[_models.ImageEmbeddingInput],
706705
extra_params: Optional[Union[str, _models._enums.ExtraParameters]] = None,
707706
content_type: str = "application/json",
707+
dimensions: Optional[int] = None,
708+
encoding_format: Optional[Union[str, _models.EmbeddingEncodingFormat]] = None,
709+
input_type: Optional[Union[str, _models.EmbeddingInputType]] = None,
710+
model: Optional[str] = None,
708711
**kwargs: Any
709712
) -> _models.EmbeddingsResult: ...
710713
@overload
711714
def _embed(
712715
self,
716+
body: JSON,
713717
*,
714-
input: List[_models.ImageEmbeddingInput],
715718
extra_params: Optional[Union[str, _models._enums.ExtraParameters]] = None,
716719
content_type: str = "application/json",
717-
dimensions: Optional[int] = None,
718-
encoding_format: Optional[Union[str, _models.EmbeddingEncodingFormat]] = None,
719-
input_type: Optional[Union[str, _models.EmbeddingInputType]] = None,
720-
model: Optional[str] = None,
721720
**kwargs: Any
722721
) -> _models.EmbeddingsResult: ...
723722
@overload

0 commit comments

Comments
 (0)