Skip to content

Commit 5f3614c

Browse files
[Conv Authoring] Create dotnet sdk preview 20250515 (Azure#51142)
* generate the first version of 2025-05-15-preview sdk * update commit id in tsp-location.yaml * updated some tests for 2025-05-15-preview * add tests for Train_withDataGenerationSettings * update the tests for importProject * added the tests for training with data generation * added tests for deployProjectWithAssignedResrouce and importProjectWithAssignedResources * updated the tests. * udpate samples for training with data generation * adjust the DeployProject_WithAssignedResources, and successfully record it. * add GetDeploymentAsync and GetDeployment tests and samples * updated {endpoint} and {api-key} in snippets * updated the live test GetDeploymentAsync * add tests and samples for deployProject_with_assignResources * add tests and samples for import_withAssetsMetaData * updated test records * record tests for getModelEvaluationResultAsync * run `Export API` * use the latest commit id * added 1.0.0-beta.2 in readme * add the tests for assigndeploymentResources and getAssignstatus * add test samples for unassignDeploymentResource and getUnassignDeploymentResourceStatus * remove options from clients for unassignDeploymentResources * added samples for UnassignDeploymentResources and updated snippets * add samples for AssingDeploymentResourceAsync and getStatus, and removed the record tests * trigger CI * add tests and samples for assign/unassignDeployments and getAssign/UnassignStatus * updated samples and links in main readme file * udpate samples and links in samples readme file * update change log * generate the sdk with importRawJson * customize importRawJson funciton and add the record tests * customize the low-level importRawJsonAsync and importRawJson * changed name "ImportRawJson" to "import" * added samples and tests for importWithRawJson * updated the snippets and export API * add import raw json string to change log * Run Export-API.ps1 * modify the release date in change log * udpate import version to 2025-05-15-preview in samples * updated the versions on readme * update all smaple links from amber to main * update exportedProjectFormat to projectFormat in import functions * updated exportedProject to projectJson for importJson * updated all the values to placeholder in samples * update rigion to placeholder * udpated the date on changelog * update all sync and async sample into one file * run Update-Snippets.ps1 * update key and AAD client for each sample * run Export-API.ps1 * add using System.Threading.Tasks; to all samples * add customized importRawJson feature * run Export-API.ps1 --------- Co-authored-by: Xiong Chen <[email protected]>
1 parent 106e960 commit 5f3614c

File tree

140 files changed

+9334
-3025
lines changed

Some content is hidden

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

140 files changed

+9334
-3025
lines changed

sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/CHANGELOG.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,28 @@
11
# Release History
22

3-
## 1.0.0-beta.2 (Unreleased)
3+
## 1.0.0-beta.2 (2025-07-24)
44

55
### Features Added
66

7-
### Breaking Changes
8-
9-
### Bugs Fixed
7+
- Added import feature for raw json string.
8+
- Added support for Conversations Authoring API Versions
9+
- 2025-05-15-preview
10+
- Added `DataGenerationSettings` in `TrainingJobDetails` when training a model.
11+
- Added corresponding test and sample.
12+
- Added `DataGenerationConnectionInfo` in `DeploymentResource` when deploying a model.
13+
- Added corresponding test and sample.
14+
- Added `ExportedAssociatedEntityLabel` in `ConversationExportedIntent` when importing a project.
15+
- Added corresponding test and sample.
1016

1117
### Other Changes
1218

19+
- Added tests and samples for some legacy features.
20+
- Get Deployment
21+
- Assign Deployment Resources
22+
- Get Assign Deployment Resources Status
23+
- Unassign Deployment Resources
24+
- Get Unassign Deployment Resources Status
25+
1326
## 1.0.0-beta.1 (2025-03-04)
1427

1528
### Other Changes

sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,24 @@
33
Azure Conversations Authoring is part of the Azure Cognitive Service for Language, a cloud-based service that provides tools for creating, managing, and deploying conversational AI solutions. This client library offers the following features:
44

55
* Creating and managing conversation projects
6-
* Importing and exporting conversation projects
6+
* Importing conversation projects
7+
* Exporting conversation projects
8+
* Getting project details
9+
* Deleting projects
710
* Training models for conversational AI
8-
* Evaluating trained models
9-
* Deploying conversational AI models
10-
* Swapping deployments for active models
1111
* Canceling active training jobs
12+
* Evaluating model summaries
13+
* Evaluating model results
1214
* Managing project snapshots
13-
* Deleting trained models and deployments
15+
* Loading snapshots
16+
* Deploying conversational AI models
17+
* Swapping deployments for active models
18+
* Deleting trained models
19+
* Deleting deployments
20+
* Assigning deployment resources
21+
* Getting deployment resource assignment status
22+
* Unassigning deployment resources
23+
* Getting deployment resource unassignment status
1424

1525
[Source code][source_root] | [Package (NuGet)][package]| [API reference documentation][text_refdocs] | [Product documentation][text_docs] | [Samples][source_samples]
1626

@@ -27,8 +37,9 @@ dotnet add package Azure.AI.Language.Conversations.Authoring --prerelease
2737
```
2838

2939
|SDK version |Supported API version of service
30-
|-------------|-------------------------------------------------------------
31-
|1.0.0-beta.1 | 2022-05-01, 2023-04-01, 2023-11-15-preview, 2024-11-15-preview (default)
40+
|-------------|----------------------------------------------------------------------
41+
|1.0.0-beta.1 | 2023-04-01, 2023-04-15-preview, 2024-11-15-preview (default)
42+
|1.0.0-beta.2 | 2023-04-01, 2023-04-15-preview, 2024-11-15-preview, 2025-05-15-preview (default)
3243

3344
### Prerequisites
3445

@@ -60,8 +71,8 @@ using Azure.AI.Language.Conversations.Authoring;
6071
With your endpoint and API key, you can instantiate a `ConversationAnalysisAuthoringClient` using specific service options:
6172

6273
```C# Snippet:CreateAuthoringClientForSpecificApiVersion
63-
Uri endpoint = new Uri("https://myaccount.cognitiveservices.azure.com");
64-
AzureKeyCredential credential = new("your apikey");
74+
Uri endpoint = new Uri("{endpoint}");
75+
AzureKeyCredential credential = new AzureKeyCredential("{api-key}");
6576
ConversationAnalysisAuthoringClientOptions options = new ConversationAnalysisAuthoringClientOptions(ConversationAnalysisAuthoringClientOptions.ServiceVersion.V2024_11_15_Preview);
6677
ConversationAnalysisAuthoringClient client = new ConversationAnalysisAuthoringClient(endpoint, credential, options);
6778
```
@@ -86,7 +97,7 @@ using Azure.Core;
8697
Then you can create an instance of `DefaultAzureCredential` and pass it to a new instance of your client:
8798

8899
```C# Snippet:AnalyzeConversationAuthoring_CreateWithDefaultAzureCredential
89-
Uri endpoint = new Uri("https://myaccount.cognitiveservices.azure.com");
100+
Uri endpoint = new Uri("{endpoint}");
90101
DefaultAzureCredential credential = new DefaultAzureCredential();
91102
ConversationAnalysisAuthoringClient client = new ConversationAnalysisAuthoringClient(endpoint, credential);
92103
```
@@ -104,8 +115,8 @@ You have the flexibility to explicitly select a supported service API version wh
104115
For example,
105116

106117
```C# Snippet:CreateAuthoringClientForSpecificApiVersion
107-
Uri endpoint = new Uri("https://myaccount.cognitiveservices.azure.com");
108-
AzureKeyCredential credential = new("your apikey");
118+
Uri endpoint = new Uri("{endpoint}");
119+
AzureKeyCredential credential = new AzureKeyCredential("{api-key}");
109120
ConversationAnalysisAuthoringClientOptions options = new ConversationAnalysisAuthoringClientOptions(ConversationAnalysisAuthoringClientOptions.ServiceVersion.V2024_11_15_Preview);
110121
ConversationAnalysisAuthoringClient client = new ConversationAnalysisAuthoringClient(endpoint, credential, options);
111122
```
@@ -142,33 +153,23 @@ We guarantee that all client instance methods are thread-safe and independent of
142153
You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples).
143154

144155
* [Create a New Project (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample1_ConversationsAuthoring_CreateProject.md)
145-
* [Create a New Project (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample1_ConversationsAuthoring_CreateProjectAsync.md)
146156
* [Import a Project (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample2_ConversationsAuthoring_Import.md)
147-
* [Import a Project (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample2_ConversationsAuthoring_ImportAsync.md)
148157
* [Export a Project (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample3_ConversationsAuthoring_Export.md)
149-
* [Export a Project (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample3_ConversationsAuthoring_ExportAsync.md)
150158
* [Get Project Details (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample4_ConversationsAuthoring_GetProject.md)
151-
* [Get Project Details (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample4_ConversationsAuthoring_GetProjectAsync.md)
152159
* [Delete a Project (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample5_ConversationsAuthoring_DeleteProject.md)
153-
* [Delete a Project (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample5_ConversationsAuthoring_DeleteProjectAsync.md)
154160
* [Train a Model (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample6_ConversationsAuthoring_Train.md)
155-
* [Train a Model (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample6_ConversationsAuthoring_TrainAsync.md)
156161
* [Cancel Training Job (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample7_ConversationsAuthoring_CancelTrainingJob.md)
157-
* [Cancel Training Job (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample7_ConversationsAuthoring_CancelTrainingJobAsync.md)
158162
* [Get Model Evaluation Summary (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample8_ConversationsAuthoring_GetModelEvaluationSummary.md)
159-
* [Get Model Evaluation Summary (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample8_ConversationsAuthoring_GetModelEvaluationSummaryAsync.md)
160163
* [Get Model Evaluation Results (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample9_ConversationsAuthoring_GetModelEvaluationResults.md)
161-
* [Get Model Evaluation Results (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample9_ConversationsAuthoring_GetModelEvaluationResultsAsync.md)
162164
* [Load Snapshot (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample10_ConversationsAuthoring_LoadSnapshot.md)
163-
* [Load Snapshot (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample10_ConversationsAuthoring_LoadSnapshotAsync.md)
164165
* [Delete a Trained Model (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample11_ConversationsAuthoring_DeleteTrainedModel.md)
165-
* [Delete a Trained Model (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample11_ConversationsAuthoring_DeleteTrainedModelAsync.md)
166166
* [Swap Deployments (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample12_ConversationsAuthoring_SwapDeployments.md)
167-
* [Swap Deployments (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample12_ConversationsAuthoring_SwapDeploymentsAsync.md)
168167
* [Delete a Deployment (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample13_ConversationsAuthoring_DeleteDeployment.md)
169-
* [Delete a Deployment (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample13_ConversationsAuthoring_DeleteDeploymentAsync.md)
170168
* [Deploy a Project (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample14_ConversationsAuthoring_DeployProject.md)
171-
* [Delete a Project (Async)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample14_ConversationsAuthoring_DeployProjectAsync.md)
169+
* [Assign Deployment Resources (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample16_ConversationsAuthoring_AssignDeploymentResources.md)
170+
* [Get Assign Deployment Resources Status (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample17_ConversationsAuthoring_GetAssignDeploymentResourcesStatus.md)
171+
* [Unassign Deployment Resources (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample18_ConversationsAuthoring_UnassignDeploymentResources.md)
172+
* [Get Unassign Deployment Resources Status (Sync)](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations.Authoring/samples/Sample19_ConversationsAuthoring_GetUnassignDeploymentResourcesStatus.md)
172173

173174
## Troubleshooting
174175

0 commit comments

Comments
 (0)