azure-translate v1.2.1

azure-translate

A NPM Package for the Azure Translate API V3

Installation

npm install azure-translate --save

Usage

Javascript

var azureTranslator = require('azure-translate')('AZURE_KEY');

TypeScript

import { AzureTranslator } from 'azure-translate';
const translator = new AzureTranslator('AZURE_KEY')

Get Languages

translator.getLanguages(args: LanguageOptions): Promise<LanguageResponse[]>

// args
export interface LanguageOptions {
    scope?: Scope,
    headers?: LanguageHeaders;
}

export interface LanguageHeaders {
    'Accept-Language'?: string,
    'X-ClientTraceId'?: string
}

export interface Scope {
    translation?: boolean;
    transliteration?: boolean;
    dictionary?: boolean;
}

Translate

translator.translate(args: TranslateOptions): Promise<TranslateResponse>

// args
export interface TranslateOptions {
    text: string | string[];
    to: string;
    from?: string;
    textType?: 'plain' | 'html';
    category?: string;
    profanityAction?: 'NoAction' | 'Marked' | 'Deleted';
    profanityMarker?: 'Asterisk' | 'Tag';
    includeAlignment?: boolean;
    includeSentenceLength?: boolean;
    suggestedFrom?: string;
    fromScript?: string;
    toScript?: string;
    allowFallback?: boolean;
    header?: Headers;
}

// Header for Translate and all following Functions
export interface Headers {
    'X-ClientTraceId': string;
}

Transliterate

translator.transliterate(args: TransliterateOptions): Promise<TransliterateResponse>

// args
export interface TransliterateOptions {
    language: string;
    fromScript: string;
    toScript: string;
    text: string | string[];
    header?: Headers;
}

Detect

translator.detect(args: DetectOptions): Promise<DetectResponse>

// args
export interface DetectOptions {
    text: string | string[];
    header?: Headers;
}

Break Sentence

translator.breakSentence(args: BreakSentenceOptions): Promise<BreakSentenceResponse>

// args
export interface BreakSentenceOptions {
    text: string | string;
    language?: string;
    script?: string;
    header?: Headers;
}

Dictionary Lookup

translator.dictionaryLookup(args: DictionaryLookupOptions): Promise<DictionaryLookupResponse>

// args
export interface DictionaryLookupOptions {
    from: string;
    to: string;
    text: string | string[];
    header?: Headers;
}

Dictionary Examples

translator.dictionaryExamples(args: DictionaryExamplesOptions): Promise<DictionaryExamplesResponse>

// args
export interface DictionaryExamplesOptions {
    from: string;
    to: string;
    text: string;
    translation: string;
    header?: Headers;
}

DOCS

For the Results of the Functions and for further information for the possible args please check the Interfaces or the official Docs https://docs.microsoft.com/en-us/azure/cognitive-services/translator/reference/v3-0-reference