https://github.com/brenoepics/at4j
Microsoft Azure Translator for Java
https://github.com/brenoepics/at4j
auto-translation azure azure-translation collaborate ghdesktop github github-copilot github-pages jetbrains microsoft microsoft-azure microsoft-translator tech translation translation-api translation-tool translator
Last synced: 2 months ago
JSON representation
Microsoft Azure Translator for Java
- Host: GitHub
- URL: https://github.com/brenoepics/at4j
- Owner: brenoepics
- License: apache-2.0
- Created: 2024-01-11T15:41:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-20T00:44:49.000Z (10 months ago)
- Last Synced: 2024-08-20T04:30:50.726Z (10 months ago)
- Topics: auto-translation, azure, azure-translation, collaborate, ghdesktop, github, github-copilot, github-pages, jetbrains, microsoft, microsoft-azure, microsoft-translator, tech, translation, translation-api, translation-tool, translator
- Language: Java
- Homepage: https://brenoepics.github.io/at4j/
- Size: 1.22 MB
- Stars: 19
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Azure Translator for Java (AT4J)
[](https://central.sonatype.com/artifact/io.github.brenoepics/at4j)
[](https://www.postman.com/maintenance-astronaut-2993290/workspace/brenoepics/collection/18589822-dfe7a640-9b94-47a8-b19f-46cb9cc8843e?action=share&creator=18589822)
[](https://sonarcloud.io/summary/new_code?id=brenoepics_at4j)
[](https://sonarcloud.io/summary/new_code?id=brenoepics_at4j)
An unofficial Java library for translating text using Azure AI Cognitive Services.
## ✨ Features
- Text Translation: Translate text from one language (or detect) to another or to a list of languages.
- Language Detection: Detect the language of a given text.
- Profanity Handling: Options for handling profanity in translations.
- Text Type Support: We support both plain text and HTML text translation.
- And more.
## 📝 Documentation
- [AT4J Docs](https://brenoepics.github.io/at4j/)
- [JavaDoc](https://brenoepics.github.io/at4j/javadoc/)
## 🎉 Basic Usage
> [!NOTE]
> Example repository [Azure-Translator-Example](https://github.com/brenoepics/Azure-Translator-Example)
The following example translates a simple Hello World to Portuguese, Spanish and French.
```java
public class ExampleTranslator {
public static void main(String[] args) {
// Insert your Azure key and region here
String azureKey = "";
String azureRegion = "";
AzureApi api = new AzureApiBuilder().setKey(azureKey).region(azureRegion).build();
// Set up translation parameters
List < String > targetLanguages = List.of("pt", "es", "fr");
TranslateParams params =
new TranslateParams("Hello World!", targetLanguages).setSourceLanguage("en");
// Translate the text
Optional < TranslationResponse > translationResult = api.translate(params).join();
// Print the translations
translationResult.ifPresent(
response ->
response.getFirstResult().getTranslations().forEach(ExampleTranslator::logLanguage));
}
public static void logLanguage(Translation translation) {
System.out.println(translation.getLanguageCode() + ": " + translation.getText());
}
}
```
Expected Output
```console
pt: Olá, Mundo!
es: ¡Hola mundo!
fr: Salut tout le monde!
```
## 📦 Download / Installation
The recommended way to get AT4J is to use a build manager, like Gradle or Maven.
### [AT4J Dependency](https://central.sonatype.com/artifact/io.github.brenoepics/at4j)
Gradle
```gradle
implementation group: 'io.github.brenoepics', name: 'at4j', version: '1.2.0'
```
Maven
```xml
io.github.brenoepics
at4j
1.2.0
```
Sbt
```sbt
libraryDependencies += "io.github.brenoepics" % "at4j" % "1.2.0"
```
### Frequently Asked Questions (FAQ)
**Q:** How do I access Azure Translator Keys for my project?
**A:** You can access your Azure Translator Keys through your Azure portal. Remember to keep your keys secure and
refrain from sharing them publicly. If you suspect a key has been compromised, it's crucial to regenerate it promptly.
For detailed instructions on generating your own keys, refer
to [this guide](https://brenoepics.github.io/at4j/guide/azure-subscription.html#azure-subscription). Additionally, you
can explore the [Azure Free Tier](https://brenoepics.github.io/at4j/guide/azure-subscription.html#azure-free-tier) for
more information.
## 🤝 Thank You!
- **Microsoft Azure**: Supporting our project with a generous grant of $10,000+ in Azure credits, enabling us to use
virtual machines, document translation and other essential cloud resources for our development needs.
- We extend our sincere thanks to all contributors for their invaluable contributions.
## 🧑💻 Contributing
Contributions of any kind are welcome. You can start contributing to this library by creating issues, submitting pull
requests or giving a star to the project.
## 📃 License
AT4J is distributed under the [Apache license version 2.0](./LICENSE).