Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion sdk/ai/azure-ai-projects/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,20 @@
### Features Added

* Two new methods `enable` and `disable` on the `.agents` subclient.
* New Agent tool type `REMINDER_PREVIEW`.
* Hosted agents are now stable. There is no need to set `allow_preview=True` on the `AIProjectClient` constructor to create a Hosted agent.
* Toolboxes operations are now stable. The have moved from `.beta.toolboxes` subclient to the `.toolboxes` subclient.
* Session and Session files operations are now stable. They have moved from the `.beta.agents` subclient to the `.agents` subclient.
* Agent code operations are now stable. This includes `create_version_from_code` and `download_code`. They have moved from the `.beta.agents` subclient to the `.agents` subclient.

### Breaking Changes

Breaking changes in beta methods:
* Toolbox operation `create_version` now defines `tools` of type `List[ToolboxTool]` instead of `List[Tool]`.
* Input argument `path` renamed to `remote_path` in methods `.agents.delete_session_file`, `.agents.download_session_file`, `.agents.list_session_files` and `.agents.upload_session_file`.
* Agent Optimization methods `.beta.agents.*optimization*` were re-written. Updated from v1 to v2 preview, focusing on cleanup to better align with Foundry job guidelines and platform standards. The v1 surface accumulated unused candidate sub-resources, internal-detail properties, and custom operation patterns inconsistent with the Foundry platform. The v2 API removes redundant models and operations, adopts shared Foundry job patterns (`JobLike<>`, standard job verbs), and introduces typed discriminated unions for dataset inputs and evaluator references.
* Method `.beta.agents.list_optimization_candidates` now returns `ItemPaged[OptimizationCandidate]` instead of `AgentsPagedResultOptimizationCandidate`. The `after` parameter has been removed (use continuation-token-based paging instead).


### Sample updates

* Added `sample_routines_crud.py` to demonstrate CRUD operations.
Expand Down
32 changes: 24 additions & 8 deletions sdk/ai/azure-ai-projects/apiview-properties.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"CrossLanguageDefinitionId": {
"azure.ai.projects.models.Tool": "OpenAI.Tool",
"azure.ai.projects.models.A2APreviewTool": "Azure.AI.Projects.A2APreviewTool",
"azure.ai.projects.models.ToolboxTool": "Azure.AI.Projects.ToolboxTool",
"azure.ai.projects.models.A2APreviewToolboxTool": "Azure.AI.Projects.A2APreviewToolboxTool",
"azure.ai.projects.models.A2aProtocolConfiguration": "Azure.AI.Projects.A2aProtocolConfiguration",
"azure.ai.projects.models.ActivityProtocolConfiguration": "Azure.AI.Projects.ActivityProtocolConfiguration",
"azure.ai.projects.models.AgentBlueprintReference": "Azure.AI.Projects.AgentBlueprintReference",
"azure.ai.projects.models.AgentCard": "Azure.AI.Projects.AgentCard",
"azure.ai.projects.models.AgentCardSkill": "Azure.AI.Projects.AgentCardSkill",
Expand Down Expand Up @@ -40,6 +44,7 @@
"azure.ai.projects.models.Index": "Azure.AI.Projects.Index",
"azure.ai.projects.models.AzureAISearchIndex": "Azure.AI.Projects.AzureAISearchIndex",
"azure.ai.projects.models.AzureAISearchTool": "Azure.AI.Projects.AzureAISearchTool",
"azure.ai.projects.models.AzureAISearchToolboxTool": "Azure.AI.Projects.AzureAISearchToolboxTool",
"azure.ai.projects.models.AzureAISearchToolResource": "Azure.AI.Projects.AzureAISearchToolResource",
"azure.ai.projects.models.AzureFunctionBinding": "Azure.AI.Projects.AzureFunctionBinding",
"azure.ai.projects.models.AzureFunctionDefinition": "Azure.AI.Projects.AzureFunctionDefinition",
Expand All @@ -58,7 +63,9 @@
"azure.ai.projects.models.BlobReferenceSasCredential": "Azure.AI.Projects.SasCredential",
"azure.ai.projects.models.BotServiceAuthorizationScheme": "Azure.AI.Projects.BotServiceAuthorizationScheme",
"azure.ai.projects.models.BotServiceRbacAuthorizationScheme": "Azure.AI.Projects.BotServiceRbacAuthorizationScheme",
"azure.ai.projects.models.BotServiceTenantAuthorizationScheme": "Azure.AI.Projects.BotServiceTenantAuthorizationScheme",
"azure.ai.projects.models.BrowserAutomationPreviewTool": "Azure.AI.Projects.BrowserAutomationPreviewTool",
"azure.ai.projects.models.BrowserAutomationPreviewToolboxTool": "Azure.AI.Projects.BrowserAutomationPreviewToolboxTool",
"azure.ai.projects.models.BrowserAutomationToolConnectionParameters": "Azure.AI.Projects.BrowserAutomationToolConnectionParameters",
"azure.ai.projects.models.BrowserAutomationToolParameters": "Azure.AI.Projects.BrowserAutomationToolParameters",
"azure.ai.projects.models.CaptureStructuredOutputsTool": "Azure.AI.Projects.CaptureStructuredOutputsTool",
Expand All @@ -71,6 +78,7 @@
"azure.ai.projects.models.CodeBasedEvaluatorDefinition": "Azure.AI.Projects.CodeBasedEvaluatorDefinition",
"azure.ai.projects.models.CodeConfiguration": "Azure.AI.Projects.CodeConfiguration",
"azure.ai.projects.models.CodeInterpreterTool": "OpenAI.CodeInterpreterTool",
"azure.ai.projects.models.CodeInterpreterToolboxTool": "Azure.AI.Projects.CodeInterpreterToolboxTool",
"azure.ai.projects.models.ComparisonFilter": "OpenAI.ComparisonFilter",
"azure.ai.projects.models.CompoundFilter": "OpenAI.CompoundFilter",
"azure.ai.projects.models.ComputerTool": "OpenAI.ComputerTool",
Expand Down Expand Up @@ -128,8 +136,6 @@
"azure.ai.projects.models.EmptyModelParam": "OpenAI.EmptyModelParam",
"azure.ai.projects.models.EntraAuthorizationScheme": "Azure.AI.Projects.EntraAuthorizationScheme",
"azure.ai.projects.models.EntraIDCredentials": "Azure.AI.Projects.EntraIDCredentials",
"azure.ai.projects.models.IsolationKeySource": "Azure.AI.Projects.IsolationKeySource",
"azure.ai.projects.models.EntraIsolationKeySource": "Azure.AI.Projects.EntraIsolationKeySource",
"azure.ai.projects.models.EvalResult": "Azure.AI.Projects.EvalResult",
"azure.ai.projects.models.EvalRunResultCompareItem": "Azure.AI.Projects.EvalRunResultCompareItem",
"azure.ai.projects.models.EvalRunResultComparison": "Azure.AI.Projects.EvalRunResultComparison",
Expand All @@ -155,11 +161,13 @@
"azure.ai.projects.models.ExternalAgentDefinition": "Azure.AI.Projects.ExternalAgentDefinition",
"azure.ai.projects.models.FabricDataAgentToolParameters": "Azure.AI.Projects.FabricDataAgentToolParameters",
"azure.ai.projects.models.FabricIQPreviewTool": "Azure.AI.Projects.FabricIQPreviewTool",
"azure.ai.projects.models.FabricIQPreviewToolboxTool": "Azure.AI.Projects.FabricIQPreviewToolboxTool",
"azure.ai.projects.models.FieldMapping": "Azure.AI.Projects.FieldMapping",
"azure.ai.projects.models.FileDataGenerationJobOutput": "Azure.AI.Projects.FileDataGenerationJobOutput",
"azure.ai.projects.models.FileDataGenerationJobSource": "Azure.AI.Projects.FileDataGenerationJobSource",
"azure.ai.projects.models.FileDatasetVersion": "Azure.AI.Projects.FileDatasetVersion",
"azure.ai.projects.models.FileSearchTool": "OpenAI.FileSearchTool",
"azure.ai.projects.models.FileSearchToolboxTool": "Azure.AI.Projects.FileSearchToolboxTool",
"azure.ai.projects.models.VersionSelectionRule": "Azure.AI.Projects.VersionSelectionRule",
"azure.ai.projects.models.FixedRatioVersionSelectionRule": "Azure.AI.Projects.FixedRatioVersionSelectionRule",
"azure.ai.projects.models.FolderDatasetVersion": "Azure.AI.Projects.FolderDatasetVersion",
Expand All @@ -170,7 +178,6 @@
"azure.ai.projects.models.FunctionTool": "OpenAI.FunctionTool",
"azure.ai.projects.models.FunctionToolParam": "OpenAI.FunctionToolParam",
"azure.ai.projects.models.GitHubIssueRoutineTrigger": "Azure.AI.Projects.GitHubIssueRoutineTrigger",
"azure.ai.projects.models.HeaderIsolationKeySource": "Azure.AI.Projects.HeaderIsolationKeySource",
"azure.ai.projects.models.TelemetryEndpointAuth": "Azure.AI.Projects.TelemetryEndpointAuth",
"azure.ai.projects.models.HeaderTelemetryEndpointAuth": "Azure.AI.Projects.HeaderTelemetryEndpointAuth",
"azure.ai.projects.models.HostedAgentDefinition": "Azure.AI.Projects.HostedAgentDefinition",
Expand All @@ -187,6 +194,8 @@
"azure.ai.projects.models.InsightScheduleTask": "Azure.AI.Projects.InsightScheduleTask",
"azure.ai.projects.models.InsightsMetadata": "Azure.AI.Projects.InsightsMetadata",
"azure.ai.projects.models.InsightSummary": "Azure.AI.Projects.InsightSummary",
"azure.ai.projects.models.InvocationsProtocolConfiguration": "Azure.AI.Projects.InvocationsProtocolConfiguration",
"azure.ai.projects.models.InvocationsWsProtocolConfiguration": "Azure.AI.Projects.InvocationsWsProtocolConfiguration",
"azure.ai.projects.models.RoutineDispatchPayload": "Azure.AI.Projects.RoutineDispatchPayload",
"azure.ai.projects.models.InvokeAgentInvocationsApiDispatchPayload": "Azure.AI.Projects.InvokeAgentInvocationsApiDispatchPayload",
"azure.ai.projects.models.RoutineAction": "Azure.AI.Projects.RoutineAction",
Expand All @@ -198,7 +207,9 @@
"azure.ai.projects.models.LoraConfig": "Azure.AI.Projects.LoraConfig",
"azure.ai.projects.models.ManagedAgentIdentityBlueprintReference": "Azure.AI.Projects.ManagedAgentIdentityBlueprintReference",
"azure.ai.projects.models.ManagedAzureAISearchIndex": "Azure.AI.Projects.ManagedAzureAISearchIndex",
"azure.ai.projects.models.McpProtocolConfiguration": "Azure.AI.Projects.McpProtocolConfiguration",
"azure.ai.projects.models.MCPTool": "OpenAI.MCPTool",
"azure.ai.projects.models.MCPToolboxTool": "Azure.AI.Projects.MCPToolboxTool",
"azure.ai.projects.models.MCPToolFilter": "OpenAI.MCPToolFilter",
"azure.ai.projects.models.MCPToolRequireApproval": "OpenAI.MCPToolRequireApproval",
"azure.ai.projects.models.MemoryOperation": "Azure.AI.Projects.MemoryOperation",
Expand Down Expand Up @@ -236,6 +247,7 @@
"azure.ai.projects.models.OpenApiProjectConnectionAuthDetails": "Azure.AI.Projects.OpenApiProjectConnectionAuthDetails",
"azure.ai.projects.models.OpenApiProjectConnectionSecurityScheme": "Azure.AI.Projects.OpenApiProjectConnectionSecurityScheme",
"azure.ai.projects.models.OpenApiTool": "Azure.AI.Projects.OpenApiTool",
"azure.ai.projects.models.OpenApiToolboxTool": "Azure.AI.Projects.OpenApiToolboxTool",
"azure.ai.projects.models.OptimizationAgentIdentifier": "Azure.AI.Projects.OptimizationAgentIdentifier",
"azure.ai.projects.models.OptimizationCandidate": "Azure.AI.Projects.OptimizationCandidate",
"azure.ai.projects.models.OptimizationDatasetCriterion": "Azure.AI.Projects.OptimizationDatasetCriterion",
Expand All @@ -261,13 +273,16 @@
"azure.ai.projects.models.PromptBasedEvaluatorDefinition": "Azure.AI.Projects.PromptBasedEvaluatorDefinition",
"azure.ai.projects.models.PromptDataGenerationJobSource": "Azure.AI.Projects.PromptDataGenerationJobSource",
"azure.ai.projects.models.PromptEvaluatorGenerationJobSource": "Azure.AI.Projects.PromptEvaluatorGenerationJobSource",
"azure.ai.projects.models.ProtocolConfiguration": "Azure.AI.Projects.ProtocolConfiguration",
"azure.ai.projects.models.ProtocolVersionRecord": "Azure.AI.Projects.ProtocolVersionRecord",
"azure.ai.projects.models.RaiConfig": "Azure.AI.Projects.RaiConfig",
"azure.ai.projects.models.RankingOptions": "OpenAI.RankingOptions",
"azure.ai.projects.models.Reasoning": "OpenAI.Reasoning",
"azure.ai.projects.models.RecurrenceTrigger": "Azure.AI.Projects.RecurrenceTrigger",
"azure.ai.projects.models.RedTeam": "Azure.AI.Projects.RedTeam",
"azure.ai.projects.models.ReminderPreviewTool": "Azure.AI.Projects.ReminderPreviewTool",
"azure.ai.projects.models.ReminderPreviewToolboxTool": "Azure.AI.Projects.ReminderPreviewToolboxTool",
"azure.ai.projects.models.ResponsesProtocolConfiguration": "Azure.AI.Projects.ResponsesProtocolConfiguration",
"azure.ai.projects.models.ResponseUsageInputTokensDetails": "OpenAI.ResponseUsageInputTokensDetails",
"azure.ai.projects.models.ResponseUsageOutputTokensDetails": "OpenAI.ResponseUsageOutputTokensDetails",
"azure.ai.projects.models.Routine": "Azure.AI.Projects.Routine",
Expand Down Expand Up @@ -302,7 +317,7 @@
"azure.ai.projects.models.TimerRoutineTrigger": "Azure.AI.Projects.TimerRoutineTrigger",
"azure.ai.projects.models.ToolboxObject": "Azure.AI.Projects.ToolboxObject",
"azure.ai.projects.models.ToolboxPolicies": "Azure.AI.Projects.ToolboxPolicies",
"azure.ai.projects.models.ToolboxSearchPreviewTool": "Azure.AI.Projects.ToolboxSearchPreviewTool",
"azure.ai.projects.models.ToolboxSearchPreviewToolboxTool": "Azure.AI.Projects.ToolboxSearchPreviewToolboxTool",
"azure.ai.projects.models.ToolboxSkill": "Azure.AI.Projects.ToolboxSkill",
"azure.ai.projects.models.ToolboxSkillReference": "Azure.AI.Projects.ToolboxSkillReference",
"azure.ai.projects.models.ToolboxVersionObject": "Azure.AI.Projects.ToolboxVersionObject",
Expand Down Expand Up @@ -336,10 +351,12 @@
"azure.ai.projects.models.WebSearchConfiguration": "Azure.AI.Projects.WebSearchConfiguration",
"azure.ai.projects.models.WebSearchPreviewTool": "OpenAI.WebSearchPreviewTool",
"azure.ai.projects.models.WebSearchTool": "OpenAI.WebSearchTool",
"azure.ai.projects.models.WebSearchToolboxTool": "Azure.AI.Projects.WebSearchToolboxTool",
"azure.ai.projects.models.WebSearchToolFilters": "OpenAI.WebSearchToolFilters",
"azure.ai.projects.models.WeeklyRecurrenceSchedule": "Azure.AI.Projects.WeeklyRecurrenceSchedule",
"azure.ai.projects.models.WorkflowAgentDefinition": "Azure.AI.Projects.WorkflowAgentDefinition",
"azure.ai.projects.models.WorkIQPreviewTool": "Azure.AI.Projects.WorkIQPreviewTool",
"azure.ai.projects.models.WorkIQPreviewToolboxTool": "Azure.AI.Projects.WorkIQPreviewToolboxTool",
"azure.ai.projects.models.EvaluationTaxonomyInputType": "Azure.AI.Projects.EvaluationTaxonomyInputType",
"azure.ai.projects.models.ToolType": "OpenAI.ToolType",
"azure.ai.projects.models.AzureAISearchQueryType": "Azure.AI.Projects.AzureAISearchQueryType",
Expand Down Expand Up @@ -402,7 +419,7 @@
"azure.ai.projects.models.AgentObjectType": "Azure.AI.Projects.AgentObjectType",
"azure.ai.projects.models.AgentState": "Azure.AI.Projects.AgentState",
"azure.ai.projects.models.AgentKind": "Azure.AI.Projects.AgentKind",
"azure.ai.projects.models.AgentProtocol": "Azure.AI.Projects.AgentProtocol",
"azure.ai.projects.models.AgentEndpointProtocol": "Azure.AI.Projects.AgentEndpointProtocol",
"azure.ai.projects.models.CodeDependencyResolution": "Azure.AI.Projects.CodeDependencyResolution",
"azure.ai.projects.models.TelemetryEndpointKind": "Azure.AI.Projects.TelemetryEndpointKind",
"azure.ai.projects.models.TelemetryDataKind": "Azure.AI.Projects.TelemetryDataKind",
Expand All @@ -413,9 +430,7 @@
"azure.ai.projects.models.AgentVersionStatus": "Azure.AI.Projects.AgentVersionStatus",
"azure.ai.projects.models.AgentBlueprintReferenceType": "Azure.AI.Projects.AgentBlueprintReferenceType",
"azure.ai.projects.models.VersionSelectorType": "Azure.AI.Projects.VersionSelectorType",
"azure.ai.projects.models.AgentEndpointProtocol": "Azure.AI.Projects.AgentEndpointProtocol",
"azure.ai.projects.models.AgentEndpointAuthorizationSchemeType": "Azure.AI.Projects.AgentEndpointAuthorizationSchemeType",
"azure.ai.projects.models.IsolationKeySourceKind": "Azure.AI.Projects.IsolationKeySourceKind",
"azure.ai.projects.models.VersionIndicatorType": "Azure.AI.Projects.VersionIndicatorType",
"azure.ai.projects.models.AgentSessionStatus": "Azure.AI.Projects.AgentSessionStatus",
"azure.ai.projects.models.SessionLogEventType": "Azure.AI.Projects.SessionLogEventType",
Expand All @@ -426,6 +441,7 @@
"azure.ai.projects.models.DatasetType": "Azure.AI.Projects.DatasetType",
"azure.ai.projects.models.DeploymentType": "Azure.AI.Projects.DeploymentType",
"azure.ai.projects.models.IndexType": "Azure.AI.Projects.IndexType",
"azure.ai.projects.models.ToolboxToolType": "Azure.AI.Projects.ToolboxToolType",
"azure.ai.projects.models.MemoryStoreUpdateStatus": "Azure.AI.Projects.MemoryStoreUpdateStatus",
"azure.ai.projects.operations.AgentsOperations.get": "Azure.AI.Projects.Agents.getAgent",
"azure.ai.projects.aio.operations.AgentsOperations.get": "Azure.AI.Projects.Agents.getAgent",
Expand Down Expand Up @@ -526,5 +542,5 @@
"azure.ai.projects.operations.ToolboxesOperations.delete_version": "Azure.AI.Projects.Toolboxes.deleteToolboxVersion",
"azure.ai.projects.aio.operations.ToolboxesOperations.delete_version": "Azure.AI.Projects.Toolboxes.deleteToolboxVersion"
},
"CrossLanguageVersion": "623ba64ba559"
"CrossLanguageVersion": "ea005d146e87"
}
Loading
Loading