Skip to content

Commit 29d2628

Browse files
authored
Changes for release of azure-ai-projects client library version 1.1.0b1 (#42306)
1 parent afce6c3 commit 29d2628

File tree

71 files changed

+1922
-1542
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+1922
-1542
lines changed

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

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,41 @@
11
# Release History
22

3-
## 1.0.0b13 (Unreleased)
3+
## 1.1.0b1 (2025-08-01)
4+
5+
First beta version following the 1.0.0 stable release. It brings back the Evaluation and Red-Team operations which are still in preview.
6+
7+
### Features added
8+
9+
* Added methods `cancel` and `delete` to Evaluations.
10+
11+
## 1.0.0 (2025-07-31)
12+
13+
First stable version of the client library. The client library now uses version `v1` of the
14+
AI Foundry [data plane REST APIs](https://aka.ms/azsdk/azure-ai-projects/ga-rest-api-reference).
415

516
### Breaking changes
617

7-
* Updated evaluator ids for AOAI graders.
18+
* Features that are still in preview were removed from this stable release. This includes:
19+
* Evaluation operations (property `.evaluations`)
20+
* Red-Team operations (property `.red_teams`)
21+
* Class `PromptTemplate`.
22+
* Package function `enable_telemetry()`
23+
* Classes were renamed:
24+
* Class `Sku` was renamed `ModelDeploymentSku`
25+
* Class `SasCredential` was renamed `BlobReferenceSasCredential`
26+
* Class `AssetCredentialResponse` was renamed `DatasetCredential`
27+
* Method `.inference.get_azure_openai_client()` was renamed `.get_openai_client()`. The `.inference` property was removed.
28+
The method is documented as returning an object of type `OpenAI`, but it still returns an object of the derived type `AzureOpenAI`.
29+
The function implementation has not changed.
30+
* Method `.telemetry.get_connection_string()` was renamed `.telemetry.get_application_insights_connection_string()`
31+
32+
### Sample updates
33+
34+
* Added a new Dataset sample named `sample_datasets_download.py` to show how you can download all files referenced by a certain Dataset (following a question in [this GitHub issue](https://github.com/Azure/azure-sdk-for-python/issues/41960))
35+
* Two samples added showing how to do a `responses` operation using an authenticated Azure OpenAI client created
36+
using `get_openai_client()`.
37+
* Existing inference samples that used the package function `enable_telemetry()` were updated to remove this call,
38+
and instead add the necessary tracing configuration calls to the sample.
839

940
## 1.0.0b12 (2025-06-23)
1041

@@ -14,7 +45,7 @@
1445
`.inference.get_embeddings_client()` and `.inference.get_image_embeddings_client()`.
1546
For guidance on obtaining an authenticated `azure-ai-inference` client for your AI Foundry Project,
1647
refer to the updated samples in the `samples\inference` directory. For example,
17-
[sample_chat_completions_with_azure_ai_inference_client.py](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ai/azure-ai-projects/samples/inference/sample_chat_completions_with_azure_ai_inference_client.py). Alternatively, use the `.inference.get_azure_openai_client()` method to perform chat completions with an Azure OpenAI client.
48+
`sample_chat_completions_with_azure_ai_inference_client.py`. Alternatively, use the `.inference.get_azure_openai_client()` method to perform chat completions with an Azure OpenAI client.
1849
* Method argument name changes:
1950
* In method `.indexes.create_or_update()` argument `body` was renamed `index`.
2051
* In method `.datasets.create_or_update()` argument `body` was renamed `dataset_version`.

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

Lines changed: 84 additions & 36 deletions
Large diffs are not rendered by default.

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,25 @@
88
"azure.ai.projects.models.AgentEvaluationSamplingConfiguration": "Azure.AI.Projects.AgentEvaluationSamplingConfiguration",
99
"azure.ai.projects.models.BaseCredentials": "Azure.AI.Projects.BaseCredentials",
1010
"azure.ai.projects.models.ApiKeyCredentials": "Azure.AI.Projects.ApiKeyCredentials",
11-
"azure.ai.projects.models.AssetCredentialResponse": "Azure.AI.Projects.AssetCredentialResponse",
11+
"azure.ai.projects.models.Message": "Azure.AI.Projects.Message",
12+
"azure.ai.projects.models.AssistantMessage": "Azure.AI.Projects.AssistantMessage",
1213
"azure.ai.projects.models.Index": "Azure.AI.Projects.Index",
1314
"azure.ai.projects.models.AzureAISearchIndex": "Azure.AI.Projects.AzureAISearchIndex",
1415
"azure.ai.projects.models.TargetConfig": "Azure.AI.Projects.TargetConfig",
1516
"azure.ai.projects.models.AzureOpenAIModelConfiguration": "Azure.AI.Projects.AzureOpenAIModelConfiguration",
1617
"azure.ai.projects.models.BlobReference": "Azure.AI.Projects.BlobReference",
18+
"azure.ai.projects.models.BlobReferenceSasCredential": "Azure.AI.Projects.SasCredential",
1719
"azure.ai.projects.models.Connection": "Azure.AI.Projects.Connection",
1820
"azure.ai.projects.models.CosmosDBIndex": "Azure.AI.Projects.CosmosDBIndex",
1921
"azure.ai.projects.models.CustomCredential": "Azure.AI.Projects.CustomCredential",
22+
"azure.ai.projects.models.DatasetCredential": "Azure.AI.Projects.AssetCredentialResponse",
2023
"azure.ai.projects.models.DatasetVersion": "Azure.AI.Projects.DatasetVersion",
2124
"azure.ai.projects.models.Deployment": "Azure.AI.Projects.Deployment",
25+
"azure.ai.projects.models.DeveloperMessage": "Azure.AI.Projects.DeveloperMessage",
2226
"azure.ai.projects.models.EmbeddingConfiguration": "Azure.AI.Projects.EmbeddingConfiguration",
2327
"azure.ai.projects.models.EntraIDCredentials": "Azure.AI.Projects.EntraIDCredentials",
2428
"azure.ai.projects.models.Evaluation": "Azure.AI.Projects.Evaluation",
29+
"azure.ai.projects.models.EvaluationTarget": "Azure.AI.Projects.EvaluationTarget",
2530
"azure.ai.projects.models.EvaluatorConfiguration": "Azure.AI.Projects.EvaluatorConfiguration",
2631
"azure.ai.projects.models.FieldMapping": "Azure.AI.Projects.FieldMapping",
2732
"azure.ai.projects.models.FileDatasetVersion": "Azure.AI.Projects.FileDatasetVersion",
@@ -30,15 +35,18 @@
3035
"azure.ai.projects.models.InputDataset": "Azure.AI.Projects.InputDataset",
3136
"azure.ai.projects.models.ManagedAzureAISearchIndex": "Azure.AI.Projects.ManagedAzureAISearchIndex",
3237
"azure.ai.projects.models.ModelDeployment": "Azure.AI.Projects.ModelDeployment",
38+
"azure.ai.projects.models.ModelDeploymentSku": "Azure.AI.Projects.Sku",
39+
"azure.ai.projects.models.ModelResponseGenerationTarget": "Azure.AI.Projects.modelResponseGenerationTarget",
3340
"azure.ai.projects.models.NoAuthenticationCredentials": "Azure.AI.Projects.NoAuthenticationCredentials",
3441
"azure.ai.projects.models.PendingUploadRequest": "Azure.AI.Projects.PendingUploadRequest",
3542
"azure.ai.projects.models.PendingUploadResponse": "Azure.AI.Projects.PendingUploadResponse",
3643
"azure.ai.projects.models.RedTeam": "Azure.AI.Projects.RedTeam",
37-
"azure.ai.projects.models.SasCredential": "Azure.AI.Projects.SasCredential",
3844
"azure.ai.projects.models.SASCredentials": "Azure.AI.Projects.SASCredentials",
39-
"azure.ai.projects.models.Sku": "Azure.AI.Projects.Sku",
45+
"azure.ai.projects.models.SystemMessage": "Azure.AI.Projects.SystemMessage",
46+
"azure.ai.projects.models.UserMessage": "Azure.AI.Projects.UserMessage",
4047
"azure.ai.projects.models.ConnectionType": "Azure.AI.Projects.ConnectionType",
4148
"azure.ai.projects.models.CredentialType": "Azure.AI.Projects.CredentialType",
49+
"azure.ai.projects.models.EvaluationTargetType": "Azure.AI.Projects.EvaluationTargetType",
4250
"azure.ai.projects.models.DatasetType": "Azure.AI.Projects.DatasetType",
4351
"azure.ai.projects.models.PendingUploadType": "Azure.AI.Projects.PendingUploadType",
4452
"azure.ai.projects.models.IndexType": "Azure.AI.Projects.IndexType",
@@ -55,6 +63,10 @@
5563
"azure.ai.projects.aio.operations.EvaluationsOperations.create": "Azure.AI.Projects.Evaluations.create",
5664
"azure.ai.projects.operations.EvaluationsOperations.create_agent_evaluation": "Azure.AI.Projects.Evaluations.createAgentEvaluation",
5765
"azure.ai.projects.aio.operations.EvaluationsOperations.create_agent_evaluation": "Azure.AI.Projects.Evaluations.createAgentEvaluation",
66+
"azure.ai.projects.operations.EvaluationsOperations.cancel": "Azure.AI.Projects.Evaluations.cancel",
67+
"azure.ai.projects.aio.operations.EvaluationsOperations.cancel": "Azure.AI.Projects.Evaluations.cancel",
68+
"azure.ai.projects.operations.EvaluationsOperations.delete": "Azure.AI.Projects.Evaluations.delete",
69+
"azure.ai.projects.aio.operations.EvaluationsOperations.delete": "Azure.AI.Projects.Evaluations.delete",
5870
"azure.ai.projects.operations.DatasetsOperations.list_versions": "Azure.AI.Projects.Datasets.listVersions",
5971
"azure.ai.projects.aio.operations.DatasetsOperations.list_versions": "Azure.AI.Projects.Datasets.listVersions",
6072
"azure.ai.projects.operations.DatasetsOperations.list": "Azure.AI.Projects.Datasets.listLatest",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"AssetsRepo": "Azure/azure-sdk-assets",
33
"AssetsRepoPrefixPath": "python",
44
"TagPrefix": "python/ai/azure-ai-projects",
5-
"Tag": "python/ai/azure-ai-projects_8e58b42168"
5+
"Tag": "python/ai/azure-ai-projects_85a150439d"
66
}

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,10 @@ class AIProjectClient:
4545
:ivar red_teams: RedTeamsOperations operations
4646
:vartype red_teams: azure.ai.projects.operations.RedTeamsOperations
4747
:param endpoint: Project endpoint. In the form
48-
"https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/_project"
48+
"https://your-ai-services-account-name.services.ai.azure.com/api/projects/_project"
4949
if your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the
50-
form
51-
"https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/<your-project-name>"
52-
if you want to explicitly
53-
specify the Foundry Project name. Required.
50+
form "https://your-ai-services-account-name.services.ai.azure.com/api/projects/your-project-name"
51+
if you want to explicitly specify the Foundry Project name. Required.
5452
:type endpoint: str
5553
:param credential: Credential used to authenticate requests to the service. Required.
5654
:type credential: ~azure.core.credentials.TokenCredential

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,10 @@ class AIProjectClientConfiguration: # pylint: disable=too-many-instance-attribu
2323
attributes.
2424
2525
:param endpoint: Project endpoint. In the form
26-
"https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/_project"
26+
"https://your-ai-services-account-name.services.ai.azure.com/api/projects/_project"
2727
if your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the
28-
form
29-
"https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/<your-project-name>"
30-
if you want to explicitly
31-
specify the Foundry Project name. Required.
28+
form "https://your-ai-services-account-name.services.ai.azure.com/api/projects/your-project-name"
29+
if you want to explicitly specify the Foundry Project name. Required.
3230
:type endpoint: str
3331
:param credential: Credential used to authenticate requests to the service. Required.
3432
:type credential: ~azure.core.credentials.TokenCredential

0 commit comments

Comments
 (0)