Skip to content

Commit

Permalink
Updating to the latest TypeSpec and preparing for Document Translatio…
Browse files Browse the repository at this point in the history
…n SDK GA release. (#45478)

* Updating to the latest TypeSpec and preparing for GA release.

* Adding the next release section

* Fixing build issue

* Updating Readme
  • Loading branch information
hamshavathimunibyraiah authored Aug 15, 2024
1 parent 6715df5 commit acab4cc
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 6 deletions.
8 changes: 6 additions & 2 deletions sdk/translation/Azure.AI.Translation.Document/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Release History

## 2.0.0-beta.3 (Unreleased)
## 2.1.0-beta.1 (Unreleased)

### Features Added

Expand All @@ -10,6 +9,11 @@

### Other Changes

## 2.0.0 (2024-08-16)

### Other Changes
This is a GA release. No new features added.

## 2.0.0-beta.2 (2024-07-05)

### Features Added
Expand Down
8 changes: 8 additions & 0 deletions sdk/translation/Azure.AI.Translation.Document/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ az cognitiveservices account create \
```
For more information about creating the resource or how to get the location information see [here][cognitive_resource_cli].

#### Setup Azure Blob Storage Account
For more information about creating an Azure Blob Storage account see [here][azure_blob_storage_account]. For creating containers for your source and target files see [here][container]. Make sure to authorize your Translation resource storage access, more info [here][storage_container_authorization].

### Authenticate the client
In order to interact with the Document Translation service, you'll need to create an instance of the [DocumentTranslationClient][documenttranslation_client_class] class. You will need an **endpoint**, and either an **API key** or `TokenCredential` to instantiate a client object. For more information regarding authenticating with cognitive services, see [Authenticate requests to Azure Cognitive Services][cognitive_auth].

Expand Down Expand Up @@ -153,6 +156,8 @@ var inputs = new List<DocumentTranslationInput>

Note that documents written to a target container must have unique names. So you can't translate a source container into a target container twice or have sources with the same documents translated into the same target container.

If "Allow Storage Account Key Access" is disabled on the storage account , Managed Identity is enabled on the Translator resource and it is assigned the role "Storage Blob Data Contributor" on the storage account, then you can use the container URLs directly and no SAS URIs will be needed.

### Long-Running Operations

Document Translation is implemented as a [**long-running operation**][dotnet_lro]. Long-running operations consist of an initial request sent to the service to start an operation, followed by polling the service at intervals to determine whether the operation has completed successfully or failed.
Expand Down Expand Up @@ -502,6 +507,9 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
[glossary]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/overview#supported-glossary-formats
[sas_token]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers#create-your-sas-tokens-with-azure-storage-explorer
[sas_token_permissions]: https://aka.ms/azsdk/documenttranslation/sas-permissions
[azure_blob_storage_account]: https://ms.portal.azure.com/#create/Microsoft.StorageAccount
[container]: https://learn.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container
[storage_container_authorization]: https://learn.microsoft.com/azure/ai-services/translator/document-translation/quickstarts/client-library-sdks?tabs=dotnet&pivots=programming-language-csharp#storage-container-authorization

[documenttranslation_client_class]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationClient.cs
[azure_identity]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<Description>Translator is a cloud-based machine translation service and is part of the Azure Cognitive Services family of cognitive APIs used to build intelligent apps. Translator is easy to integrate in your applications, websites, tools, and solutions. It allows you to add multi-language user experiences in 90 languages and dialects. And it can be used on any hardware platform with any operating system for text translation.</Description>
<AssemblyTitle>Microsoft Azure.AI.Translation.Document client library</AssemblyTitle>
<Version>2.0.0-beta.3</Version>
<Version>2.1.0-beta.1</Version>
<!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
<!--<ApiCompatVersion>1.0.0</ApiCompatVersion> -->
<PackageTags>Microsoft Azure Document Translation</PackageTags>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
directory: specification/translation/Azure.AI.DocumentTranslation
commit: bd246a654089bc08bbb99f1dbf2c35755a51e40b
commit: 27a9398801386caaba2df7e1a4d1a8abd19e3789
repo: Azure/azure-rest-api-specs


0 comments on commit acab4cc

Please sign in to comment.