npm package: @harmony-ai/harmonyspeech
Description: API for the Harmony Speech Engine.
Latest version: 0.1.1

# harmonyspeech

Harmonyspeech - JavaScript client for harmonyspeech
API for the Harmony Speech Engine.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 0.1.0a
- Generator version: 7.11.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install harmonyspeech --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your harmonyspeech from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

If the library is hosted at a git repository, e.g.https://github.com/harmony-ai-solutions/harmony-speech-engine-client-js
then install it via:

```shell
    npm install harmony-ai-solutions/harmony-speech-engine-client-js --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var Harmonyspeech = require('harmonyspeech');


var api = new Harmonyspeech.DefaultApi()
var voiceConversionRequest = new Harmonyspeech.VoiceConversionRequest(); // {VoiceConversionRequest} 
var opts = {
  'xApiKey': "xApiKey_example", // {String} 
  'apiKey': "apiKey_example" // {String} 
};
api.convertVoiceV1VoiceConvertPost(voiceConversionRequest, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*Harmonyspeech.DefaultApi* | [**convertVoiceV1VoiceConvertPost**](docs/DefaultApi.md#convertVoiceV1VoiceConvertPost) | **POST** /v1/voice/convert | Convert Voice
*Harmonyspeech.DefaultApi* | [**createEmbeddingV1EmbedSpeakerPost**](docs/DefaultApi.md#createEmbeddingV1EmbedSpeakerPost) | **POST** /v1/embed/speaker | Create Embedding
*Harmonyspeech.DefaultApi* | [**createSpeechV1AudioSpeechPost**](docs/DefaultApi.md#createSpeechV1AudioSpeechPost) | **POST** /v1/audio/speech | Create Speech
*Harmonyspeech.DefaultApi* | [**createTranscriptionV1AudioTranscriptionsPost**](docs/DefaultApi.md#createTranscriptionV1AudioTranscriptionsPost) | **POST** /v1/audio/transcriptions | Create Transcription
*Harmonyspeech.DefaultApi* | [**createVadV1AudioVadPost**](docs/DefaultApi.md#createVadV1AudioVadPost) | **POST** /v1/audio/vad | Create Vad
*Harmonyspeech.DefaultApi* | [**healthHealthGet**](docs/DefaultApi.md#healthHealthGet) | **GET** /health | Health
*Harmonyspeech.DefaultApi* | [**showAvailableEmbeddingModelsV1EmbedModelsGet**](docs/DefaultApi.md#showAvailableEmbeddingModelsV1EmbedModelsGet) | **GET** /v1/embed/models | Show Available Embedding Models
*Harmonyspeech.DefaultApi* | [**showAvailableSpeechModelsV1AudioSpeechModelsGet**](docs/DefaultApi.md#showAvailableSpeechModelsV1AudioSpeechModelsGet) | **GET** /v1/audio/speech/models | Show Available Speech Models
*Harmonyspeech.DefaultApi* | [**showAvailableTranscriptionModelsV1AudioTranscriptionsModelsGet**](docs/DefaultApi.md#showAvailableTranscriptionModelsV1AudioTranscriptionsModelsGet) | **GET** /v1/audio/transcriptions/models | Show Available Transcription Models
*Harmonyspeech.DefaultApi* | [**showAvailableVadModelsV1AudioVadModelsGet**](docs/DefaultApi.md#showAvailableVadModelsV1AudioVadModelsGet) | **GET** /v1/audio/vad/models | Show Available Vad Models
*Harmonyspeech.DefaultApi* | [**showAvailableVoiceConversionModelsV1VoiceConvertModelsGet**](docs/DefaultApi.md#showAvailableVoiceConversionModelsV1VoiceConvertModelsGet) | **GET** /v1/voice/convert/models | Show Available Voice Conversion Models
*Harmonyspeech.DefaultApi* | [**showVersionVersionGet**](docs/DefaultApi.md#showVersionVersionGet) | **GET** /version | Show Version


## Documentation for Models

 - [Harmonyspeech.AudioOutputOptions](docs/AudioOutputOptions.md)
 - [Harmonyspeech.DetectVoiceActivityRequest](docs/DetectVoiceActivityRequest.md)
 - [Harmonyspeech.DetectVoiceActivityResponse](docs/DetectVoiceActivityResponse.md)
 - [Harmonyspeech.EmbedSpeakerRequest](docs/EmbedSpeakerRequest.md)
 - [Harmonyspeech.EmbedSpeakerResponse](docs/EmbedSpeakerResponse.md)
 - [Harmonyspeech.GenerationOptions](docs/GenerationOptions.md)
 - [Harmonyspeech.HTTPValidationError](docs/HTTPValidationError.md)
 - [Harmonyspeech.LanguageOptions](docs/LanguageOptions.md)
 - [Harmonyspeech.ModelCard](docs/ModelCard.md)
 - [Harmonyspeech.ModelList](docs/ModelList.md)
 - [Harmonyspeech.SpeechToTextResponse](docs/SpeechToTextResponse.md)
 - [Harmonyspeech.SpeechTranscribeRequest](docs/SpeechTranscribeRequest.md)
 - [Harmonyspeech.TextToSpeechRequest](docs/TextToSpeechRequest.md)
 - [Harmonyspeech.TextToSpeechResponse](docs/TextToSpeechResponse.md)
 - [Harmonyspeech.ValidationError](docs/ValidationError.md)
 - [Harmonyspeech.ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
 - [Harmonyspeech.VoiceConversionRequest](docs/VoiceConversionRequest.md)
 - [Harmonyspeech.VoiceConversionResponse](docs/VoiceConversionResponse.md)
 - [Harmonyspeech.VoiceOptions](docs/VoiceOptions.md)


## Documentation for Authorization

Endpoints do not require authorization.