speechtotextapiv30 v2.0.1

SpeechToTextApiV30

SpeechToTextApiV30 - JavaScript client for SpeechToTextApiV30 Speech to Text API v3.0. This SDK is automatically generated by the Swagger Codegen project:

• API version: v3.0
• Package version: v3.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install SpeechToTextApiV30 --save

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your SpeechToTextApiV30 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('SpeechToTextApiV30') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/SpeechToTextApiV30 then install it via:

    npm install YOUR_USERNAME/SpeechToTextApiV30 --save

For browser

The library also works in the browser environment via npm and browserify. 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, that's to say your javascript file where you actually use this library):

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:

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

Getting Started

Please follow the installation instruction and execute the following JS code:

var SpeechToTextApiV30 = require('SpeechToTextApiV30');

var defaultClient = SpeechToTextApiV30.ApiClient.instance;

// Configure API key authorization: apiKeyHeader
var apiKeyHeader = defaultClient.authentications['apiKeyHeader'];
apiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: apiKeyQuery
var apiKeyQuery = defaultClient.authentications['apiKeyQuery'];
apiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyQuery.apiKeyPrefix['subscription-key'] = "Token"

var api = new SpeechToTextApiV30.DefaultApi()

var id = "id_example"; // {String} Format - uuid. The identifier of the model that will be copied.

var opts = { 
  'modelCopy': new SpeechToTextApiV30.ModelCopy() // {ModelCopy} The body contains the subscription key of the target subscription.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copyModelToSubscription(id, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://westus.api.cognitive.microsoft.com/speechtotext/v3.0

Documentation for Models

• SpeechToTextApiV30.ApiSpeechtotextV30DatasetsLocalesGet200ApplicationJsonResponse
• SpeechToTextApiV30.ApiSpeechtotextV30EndpointsLocalesGet200ApplicationJsonResponse
• SpeechToTextApiV30.ApiSpeechtotextV30EvaluationsLocalesGet200ApplicationJsonResponse
• SpeechToTextApiV30.ApiSpeechtotextV30ModelsLocalesGet200ApplicationJsonResponse
• SpeechToTextApiV30.ApiSpeechtotextV30ProjectsLocalesGet200ApplicationJsonResponse
• SpeechToTextApiV30.ApiSpeechtotextV30TranscriptionsLocalesGet200ApplicationJsonResponse
• SpeechToTextApiV30.Component
• SpeechToTextApiV30.Dataset
• SpeechToTextApiV30.DatasetProperties
• SpeechToTextApiV30.DatasetUpdate
• SpeechToTextApiV30.Endpoint
• SpeechToTextApiV30.EndpointLinks
• SpeechToTextApiV30.EndpointProperties
• SpeechToTextApiV30.EndpointPropertiesUpdate
• SpeechToTextApiV30.EndpointUpdate
• SpeechToTextApiV30.EntityError
• SpeechToTextApiV30.EntityReference
• SpeechToTextApiV30.Error
• SpeechToTextApiV30.ErrorContent
• SpeechToTextApiV30.ErrorDetail
• SpeechToTextApiV30.Evaluation
• SpeechToTextApiV30.EvaluationProperties
• SpeechToTextApiV30.EvaluationUpdate
• SpeechToTextApiV30.File
• SpeechToTextApiV30.FileLinks
• SpeechToTextApiV30.FileProperties
• SpeechToTextApiV30.HealthStatus
• SpeechToTextApiV30.InnerError
• SpeechToTextApiV30.InnerErrorV2
• SpeechToTextApiV30.InternalModel
• SpeechToTextApiV30.Links
• SpeechToTextApiV30.ManagementModel
• SpeechToTextApiV30.ManagementModelArray
• SpeechToTextApiV30.ManagementModelProperties
• SpeechToTextApiV30.Model
• SpeechToTextApiV30.ModelCopy
• SpeechToTextApiV30.ModelDeprecationDates
• SpeechToTextApiV30.ModelFile
• SpeechToTextApiV30.ModelLinks
• SpeechToTextApiV30.ModelManifest
• SpeechToTextApiV30.ModelProperties
• SpeechToTextApiV30.ModelUpdate
• SpeechToTextApiV30.PaginatedDatasets
• SpeechToTextApiV30.PaginatedEndpoints
• SpeechToTextApiV30.PaginatedEvaluations
• SpeechToTextApiV30.PaginatedFiles
• SpeechToTextApiV30.PaginatedModels
• SpeechToTextApiV30.PaginatedProjects
• SpeechToTextApiV30.PaginatedTranscriptions
• SpeechToTextApiV30.PaginatedWebHooks
• SpeechToTextApiV30.Project
• SpeechToTextApiV30.ProjectLinks
• SpeechToTextApiV30.ProjectProperties
• SpeechToTextApiV30.ProjectUpdate
• SpeechToTextApiV30.Transcription
• SpeechToTextApiV30.TranscriptionProperties
• SpeechToTextApiV30.TranscriptionUpdate
• SpeechToTextApiV30.WebHook
• SpeechToTextApiV30.WebHookLinks
• SpeechToTextApiV30.WebHookProperties
• SpeechToTextApiV30.WebHookPropertiesUpdate
• SpeechToTextApiV30.WebHookUpdate

Documentation for Authorization

apiKeyHeader

• Type: API key
• API key parameter name: Ocp-Apim-Subscription-Key
• Location: HTTP header

apiKeyQuery

• Type: API key
• API key parameter name: subscription-key
• Location: URL query string