Skip to content

Commit f3984ab

Browse files
authored
Rename Python classes ending with "Object", such that now end with "Details". (#44122)
1 parent fbda19f commit f3984ab

File tree

12 files changed

+375
-369
lines changed

12 files changed

+375
-369
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
### Breaking changes
88

9+
* Rename class `AgentObject` to `AgentDetails`
10+
* Rename class `AgentVersionObject` to `AgentVersionDetails`
11+
* Rename class `MemoryStoreObject` to `MemoryStoreDetails`
12+
913
### Bugs Fixed
1014

1115
### Sample updates
@@ -14,7 +18,6 @@
1418
* Added OpenAPI with Project Connection sample. See `sample_agent_openapi_with_project_connection.py`.
1519
* Added SharePoint grounding tool sample. See `sample_agent_sharepoint.py`.
1620

17-
1821
## 2.0.0b2 (2025-11-14)
1922

2023
### Features Added

sdk/ai/azure-ai-projects/apiview-properties.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
"azure.ai.projects.models.InsightRequest": "Azure.AI.Projects.InsightRequest",
99
"azure.ai.projects.models.AgentClusterInsightsRequest": "Azure.AI.Projects.AgentClusterInsightsRequest",
1010
"azure.ai.projects.models.AgentDefinition": "Azure.AI.Projects.AgentDefinition",
11+
"azure.ai.projects.models.AgentDetails": "Azure.AI.Projects.AgentObject",
1112
"azure.ai.projects.models.BaseCredentials": "Azure.AI.Projects.BaseCredentials",
1213
"azure.ai.projects.models.AgenticIdentityCredentials": "Azure.AI.Projects.AgenticIdentityCredentials",
1314
"azure.ai.projects.models.AgentId": "Azure.AI.Projects.AgentId",
14-
"azure.ai.projects.models.AgentObject": "Azure.AI.Projects.AgentObject",
1515
"azure.ai.projects.models.AgentObjectVersions": "Azure.AI.Projects.AgentObject.versions.anonymous",
1616
"azure.ai.projects.models.AgentReference": "Azure.AI.Projects.AgentReference",
1717
"azure.ai.projects.models.EvaluationTaxonomyInput": "Azure.AI.Projects.EvaluationTaxonomyInput",
1818
"azure.ai.projects.models.AgentTaxonomyInput": "Azure.AI.Projects.AgentTaxonomyInput",
19-
"azure.ai.projects.models.AgentVersionObject": "Azure.AI.Projects.AgentVersionObject",
19+
"azure.ai.projects.models.AgentVersionDetails": "Azure.AI.Projects.AgentVersionDetails",
2020
"azure.ai.projects.models.AISearchIndexResource": "Azure.AI.Projects.AISearchIndexResource",
2121
"azure.ai.projects.models.Annotation": "OpenAI.Annotation",
2222
"azure.ai.projects.models.AnnotationFileCitation": "OpenAI.AnnotationFileCitation",
@@ -193,7 +193,7 @@
193193
"azure.ai.projects.models.MemoryStoreDefaultDefinition": "Azure.AI.Projects.MemoryStoreDefaultDefinition",
194194
"azure.ai.projects.models.MemoryStoreDefaultOptions": "Azure.AI.Projects.MemoryStoreDefaultOptions",
195195
"azure.ai.projects.models.MemoryStoreDeleteScopeResult": "Azure.AI.Projects.MemoryStoreDeleteScopeResponse",
196-
"azure.ai.projects.models.MemoryStoreObject": "Azure.AI.Projects.MemoryStoreObject",
196+
"azure.ai.projects.models.MemoryStoreDetails": "Azure.AI.Projects.MemoryStoreObject",
197197
"azure.ai.projects.models.MemoryStoreOperationUsage": "Azure.AI.Projects.MemoryStoreOperationUsage",
198198
"azure.ai.projects.models.MemoryStoreOperationUsageInputTokensDetails": "Azure.AI.Projects.MemoryStoreOperationUsage.input_tokens_details.anonymous",
199199
"azure.ai.projects.models.MemoryStoreOperationUsageOutputTokensDetails": "Azure.AI.Projects.MemoryStoreOperationUsage.output_tokens_details.anonymous",

sdk/ai/azure-ai-projects/azure/ai/projects/aio/operations/_operations.py

Lines changed: 144 additions & 142 deletions
Large diffs are not rendered by default.

sdk/ai/azure-ai-projects/azure/ai/projects/models/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
AgentClusterInsightResult,
2020
AgentClusterInsightsRequest,
2121
AgentDefinition,
22+
AgentDetails,
2223
AgentId,
23-
AgentObject,
2424
AgentObjectVersions,
2525
AgentReference,
2626
AgentTaxonomyInput,
27-
AgentVersionObject,
27+
AgentVersionDetails,
2828
AgenticIdentityCredentials,
2929
Annotation,
3030
AnnotationFileCitation,
@@ -200,7 +200,7 @@
200200
MemoryStoreDefaultOptions,
201201
MemoryStoreDefinition,
202202
MemoryStoreDeleteScopeResult,
203-
MemoryStoreObject,
203+
MemoryStoreDetails,
204204
MemoryStoreOperationUsage,
205205
MemoryStoreOperationUsageInputTokensDetails,
206206
MemoryStoreOperationUsageOutputTokensDetails,
@@ -414,12 +414,12 @@
414414
"AgentClusterInsightResult",
415415
"AgentClusterInsightsRequest",
416416
"AgentDefinition",
417+
"AgentDetails",
417418
"AgentId",
418-
"AgentObject",
419419
"AgentObjectVersions",
420420
"AgentReference",
421421
"AgentTaxonomyInput",
422-
"AgentVersionObject",
422+
"AgentVersionDetails",
423423
"AgenticIdentityCredentials",
424424
"Annotation",
425425
"AnnotationFileCitation",
@@ -595,7 +595,7 @@
595595
"MemoryStoreDefaultOptions",
596596
"MemoryStoreDefinition",
597597
"MemoryStoreDeleteScopeResult",
598-
"MemoryStoreObject",
598+
"MemoryStoreDetails",
599599
"MemoryStoreOperationUsage",
600600
"MemoryStoreOperationUsageInputTokensDetails",
601601
"MemoryStoreOperationUsageOutputTokensDetails",

sdk/ai/azure-ai-projects/azure/ai/projects/models/_models.py

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,49 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
325325
super().__init__(*args, **kwargs)
326326

327327

328+
class AgentDetails(_Model):
329+
"""AgentDetails.
330+
331+
:ivar object: The object type, which is always 'agent'. Required. Default value is "agent".
332+
:vartype object: str
333+
:ivar id: The unique identifier of the agent. Required.
334+
:vartype id: str
335+
:ivar name: The name of the agent. Required.
336+
:vartype name: str
337+
:ivar versions: The latest version of the agent. Required.
338+
:vartype versions: ~azure.ai.projects.models.AgentObjectVersions
339+
"""
340+
341+
object: Literal["agent"] = rest_field(visibility=["read", "create", "update", "delete", "query"])
342+
"""The object type, which is always 'agent'. Required. Default value is \"agent\"."""
343+
id: str = rest_field(visibility=["read", "create", "update", "delete", "query"])
344+
"""The unique identifier of the agent. Required."""
345+
name: str = rest_field(visibility=["read", "create", "update", "delete", "query"])
346+
"""The name of the agent. Required."""
347+
versions: "_models.AgentObjectVersions" = rest_field(visibility=["read", "create", "update", "delete", "query"])
348+
"""The latest version of the agent. Required."""
349+
350+
@overload
351+
def __init__(
352+
self,
353+
*,
354+
id: str, # pylint: disable=redefined-builtin
355+
name: str,
356+
versions: "_models.AgentObjectVersions",
357+
) -> None: ...
358+
359+
@overload
360+
def __init__(self, mapping: Mapping[str, Any]) -> None:
361+
"""
362+
:param mapping: raw JSON to initialize the model.
363+
:type mapping: Mapping[str, Any]
364+
"""
365+
366+
def __init__(self, *args: Any, **kwargs: Any) -> None:
367+
super().__init__(*args, **kwargs)
368+
self.object: Literal["agent"] = "agent"
369+
370+
328371
class BaseCredentials(_Model):
329372
"""A base class for connection credentials.
330373

@@ -425,64 +468,21 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
425468
self.type: Literal["agent_id"] = "agent_id"
426469

427470

428-
class AgentObject(_Model):
429-
"""AgentObject.
430-
431-
:ivar object: The object type, which is always 'agent'. Required. Default value is "agent".
432-
:vartype object: str
433-
:ivar id: The unique identifier of the agent. Required.
434-
:vartype id: str
435-
:ivar name: The name of the agent. Required.
436-
:vartype name: str
437-
:ivar versions: The latest version of the agent. Required.
438-
:vartype versions: ~azure.ai.projects.models.AgentObjectVersions
439-
"""
440-
441-
object: Literal["agent"] = rest_field(visibility=["read", "create", "update", "delete", "query"])
442-
"""The object type, which is always 'agent'. Required. Default value is \"agent\"."""
443-
id: str = rest_field(visibility=["read", "create", "update", "delete", "query"])
444-
"""The unique identifier of the agent. Required."""
445-
name: str = rest_field(visibility=["read", "create", "update", "delete", "query"])
446-
"""The name of the agent. Required."""
447-
versions: "_models.AgentObjectVersions" = rest_field(visibility=["read", "create", "update", "delete", "query"])
448-
"""The latest version of the agent. Required."""
449-
450-
@overload
451-
def __init__(
452-
self,
453-
*,
454-
id: str, # pylint: disable=redefined-builtin
455-
name: str,
456-
versions: "_models.AgentObjectVersions",
457-
) -> None: ...
458-
459-
@overload
460-
def __init__(self, mapping: Mapping[str, Any]) -> None:
461-
"""
462-
:param mapping: raw JSON to initialize the model.
463-
:type mapping: Mapping[str, Any]
464-
"""
465-
466-
def __init__(self, *args: Any, **kwargs: Any) -> None:
467-
super().__init__(*args, **kwargs)
468-
self.object: Literal["agent"] = "agent"
469-
470-
471471
class AgentObjectVersions(_Model):
472472
"""AgentObjectVersions.
473473

474474
:ivar latest: Required.
475-
:vartype latest: ~azure.ai.projects.models.AgentVersionObject
475+
:vartype latest: ~azure.ai.projects.models.AgentVersionDetails
476476
"""
477477

478-
latest: "_models.AgentVersionObject" = rest_field(visibility=["read", "create", "update", "delete", "query"])
478+
latest: "_models.AgentVersionDetails" = rest_field(visibility=["read", "create", "update", "delete", "query"])
479479
"""Required."""
480480

481481
@overload
482482
def __init__(
483483
self,
484484
*,
485-
latest: "_models.AgentVersionObject",
485+
latest: "_models.AgentVersionDetails",
486486
) -> None: ...
487487

488488
@overload
@@ -607,8 +607,8 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
607607
self.type = EvaluationTaxonomyInputType.AGENT # type: ignore
608608

609609

610-
class AgentVersionObject(_Model):
611-
"""AgentVersionObject.
610+
class AgentVersionDetails(_Model):
611+
"""AgentVersionDetails.
612612

613613
:ivar metadata: Set of 16 key-value pairs that can be attached to an object. This can be
614614
useful for storing additional information about the object in a structured
@@ -8369,7 +8369,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
83698369
self.object: Literal["memory_store.scope.deleted"] = "memory_store.scope.deleted"
83708370

83718371

8372-
class MemoryStoreObject(_Model):
8372+
class MemoryStoreDetails(_Model):
83738373
"""A memory store that can store and retrieve user memories.
83748374

83758375
:ivar object: The object type, which is always 'memory_store'. Required. Default value is

0 commit comments

Comments
 (0)