mtutor_one_api_client_proxy v1.0.3
mtutor_one_api_client_proxy
MtutorOneApiClientProxy - JavaScript client for mtutor_one_api_client_proxy No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.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 mtutor_one_api_client_proxy --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 mtutor_one_api_client_proxy from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('mtutor_one_api_client_proxy')
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/mtutor_one_api_client_proxy then install it via:
npm install YOUR_USERNAME/mtutor_one_api_client_proxy --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 MtutorOneApiClientProxy = require('mtutor_one_api_client_proxy');
var defaultClient = MtutorOneApiClientProxy.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"
var api = new MtutorOneApiClientProxy.KeywordsApi()
var jobId = "jobId_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.keywordsReceive(jobId, callback);
Documentation for API Endpoints
All URIs are relative to http://api-app.mtutor.engkoo.com
Class | Method | HTTP request | Description |
---|---|---|---|
MtutorOneApiClientProxy.KeywordsApi | keywordsReceive | GET /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&keywordspotting&friendly-score | |
MtutorOneApiClientProxy.KeywordsApi | keywordsSubmit | POST /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&keywordspotting&friendly-score | |
MtutorOneApiClientProxy.MiniPairApi | miniPairReceive | GET /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&&near-miss&friendly-score | |
MtutorOneApiClientProxy.MiniPairApi | miniPairSubmit | POST /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&&near-miss&friendly-score | |
MtutorOneApiClientProxy.NativeKidApi | nativeKidReceive | GET /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&native-kid-16k&friendly-score | |
MtutorOneApiClientProxy.NativeKidApi | nativeKidSubmit | POST /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&native-kid-16k&friendly-score | |
MtutorOneApiClientProxy.OauthApi | oauth | POST /proxy/oauth/login | |
MtutorOneApiClientProxy.PronunciationApi | pronunciationReceive | GET /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&friendly-score | |
MtutorOneApiClientProxy.PronunciationApi | pronunciationSubmit | POST /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&friendly-score | |
MtutorOneApiClientProxy.ProsodicApi | prosodicReceive | GET /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&prosodic&friendly-score | |
MtutorOneApiClientProxy.ProsodicApi | prosodicSubmit | POST /proxy/api/oneapi?engineId=D74DB453-4811-4D9C-83B4-D46AE2BA7DFE&prosodic&friendly-score | |
MtutorOneApiClientProxy.RateChatApi | rateChatReceive | GET /proxy/api/oneapi?engineId=10C8E4E1-BA22-4D03-B786-440BA085C06A&multi-model=rate-chat&modelName=rate-chat&friendly-score | |
MtutorOneApiClientProxy.RateChatApi | rateChatSubmit | POST /proxy/api/oneapi?engineId=10C8E4E1-BA22-4D03-B786-440BA085C06A&multi-model=rate-chat&modelName=rate-chat&friendly-score | |
MtutorOneApiClientProxy.RateEssayApi | essayReceive | GET /proxy/api/oneapi?engineId=68858D5B-4999-4099-A5B9-45F3EE222246&friendly-score | |
MtutorOneApiClientProxy.RateEssayApi | essaySubmit | POST /proxy/api/oneapi?engineId=68858D5B-4999-4099-A5B9-45F3EE222246&friendly-score | |
MtutorOneApiClientProxy.TtsApi | ttsReceive | GET /proxy/api/oneapi?engineId=FF44C9DF-0F0A-4581-992A-A97880ACFD45&friendly-score | |
MtutorOneApiClientProxy.TtsApi | ttsSubmit | POST /proxy/api/oneapi?engineId=FF44C9DF-0F0A-4581-992A-A97880ACFD45&friendly-score |
Documentation for Models
- MtutorOneApiClientProxy.AccessTokenResponse
- MtutorOneApiClientProxy.PronunciationRequest
- MtutorOneApiClientProxy.PronunciationRequestData
- MtutorOneApiClientProxy.PronunciationResponse
- MtutorOneApiClientProxy.PronunciationResponseData
- MtutorOneApiClientProxy.PronunciationResponseDataResult
- MtutorOneApiClientProxy.PronunciationResponseDataResultDetail
- MtutorOneApiClientProxy.PronunciationResponseDataResultDetailPhonDetails
- MtutorOneApiClientProxy.PronunciationResponseDataResultDetailSyllDetails
- MtutorOneApiClientProxy.PronunciationResponseDataResultDetailWordDetails
- MtutorOneApiClientProxy.RateChatRequest
- MtutorOneApiClientProxy.RateChatRequestData
- MtutorOneApiClientProxy.RateChatResponse
- MtutorOneApiClientProxy.RateChatResponseData
- MtutorOneApiClientProxy.RateChatResponseDataResult
- MtutorOneApiClientProxy.RateChatResponseDataResultSpeechDetails
- MtutorOneApiClientProxy.RateEssayRequest
- MtutorOneApiClientProxy.RateEssayRequestData
- MtutorOneApiClientProxy.RateEssayResponse
- MtutorOneApiClientProxy.RateEssayResponseData
- MtutorOneApiClientProxy.RateEssayResponseDataResult
- MtutorOneApiClientProxy.RateEssayResponseDataResultV1
- MtutorOneApiClientProxy.RateEssayResponseDataResultV2
- MtutorOneApiClientProxy.RateEssayResponseDataResultV2DetailAssessment
- MtutorOneApiClientProxy.RateEssayResponseDataResultV2ErrorInfo
- MtutorOneApiClientProxy.RateEssayResponseDataResultV2ErrorList
- MtutorOneApiClientProxy.RateEssayResponseDataResultV2Suggestions
- MtutorOneApiClientProxy.RateEssayResponseDataResultV2WordSuggestions
- MtutorOneApiClientProxy.RateEssayResponseDataResultV2WritingComments
- MtutorOneApiClientProxy.RateEssayResponseDataResultV2WritingSkills
- MtutorOneApiClientProxy.ResultResponse
- MtutorOneApiClientProxy.ResultResponseData
- MtutorOneApiClientProxy.TtsRequest
- MtutorOneApiClientProxy.TtsRequestData
- MtutorOneApiClientProxy.TtsRequestDataOutputOptions
- MtutorOneApiClientProxy.TtsResponse
- MtutorOneApiClientProxy.TtsResponseData
- MtutorOneApiClientProxy.TtsResponseDataResult
Documentation for Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header