学習のためのAPI
mimi SRS を利用するには、事前に話者グループや話者を登録し、音声を学習させておく必要があります。ここで説明するAPIを利用し、事前準備を行います。
接続情報
ドメイン
ベース URL
/v1/applications/<applicationId>/clients/<clientId>/ |
ただし「<変数名>」の表記は、変数に置き換えて下さい。
applicationIdとclientIdは、mimi SRS サービスを利用するために作成されたアプリケーションとクライアントのIDです。
事前準備として、mimi API Console や mimi API で 、 mimi SRS サービスやAPIを利用するためのアプリケーションとクライアントを作成しIDを取得しておいてください。注意事項として、アプリケーションやクライアントを作成する際には、mimi SRS サービスやAPI の利用に合わせて必要な範囲(scope)を設定するようにしてください。
Authorization
全ての HTTP リクエストの際に、事前に発行しておいた mimi のアクセストークンをBearer トークン(アクセストークン)として与えて下さい。注意事項として、mimi SRS サービスやAPIの利用に合わせて必要な範囲(scope)の権限を付与されたアクセストークンを発行し使用するようにしてください。
Authorization: Bearer <accessToken> |
API一覧
| 話者グループの操作 |
API |
|---|---|
| 話者グループ一覧の取得 | GET /srs/speaker_groups returns 話者グループリソース |
| 指定された話者グループの取得 | GET /srs/speaker_groups/<speakerGroupId> returns 話者グ ループリソース |
| 話者グループの新規作成 | POST /srs/speaker_groups returns オペレーションリソース -name=話者グループの名称(required), 例: %E7%B5%8C%E7%90%86%E9%83%A8（＝「経理部」） -description=話者グループの説明(optional), 例: %E6%9C%80%E5%88%9D%E3%81%AE%E8%A9%B1%E8%80%85%E3%82%AF%E3%82%99%E3%83%AB%E3%83%BC%E3%83%95%E3%82%9A（＝「最初の話者グループ」） |
| 指定された話者グループの修正 | PUT /srs/speaker_groups/<speakerGroupId> returns オペレー ションリソース |
| 指定された話者グループの削除 | DELETE /srs/speaker_groups/<speakerGroupId> returns オペ レーションリソース |
| 指定された話者グループに登録された 話者一覧の取得 | GET /srs/speaker_groups/<speakerGroupId>/speakers returns 話者リソース |
| 指定された話者グループ への指定された話者の登録 | POST /srs/speaker_groups/<speakerGroupId>/speakers/<speakerId> returns オペレーションリソース |
| 指定された話者グルー プから指定された話者の登録解除 | DELETE /srs/speaker_groups/<speaerGroupId>/speakers/<speakerId> returns オペレーションリソース |
| 話者の操作 |
API |
|---|---|
| 話者一覧の取得 | GET /srs/speakers 話者一覧の取得 returns 話者リソース |
| 指定された話者の取得 | GET /srs/speakers/<speakerId> returns 話者リソース POST |
| 話者の新規作成 | POST /srs/speakers returns オペレーションリソース - name=話者名(required), 例: %E5%B1%B1%E7%94%B0%E5%A4%AA%E9%83%8E（＝「山田太郎」） - lang=言語コード(required), 例: ja_JP - sex=性別(optional) 0: 男性, 1: 女性 - age=年齢(optional) 例: 27 - description=話者グループの説明(optional), 例:%E5%B1%B1%E7%94%B0%E5%A4%AA%E9%83%8E%E3%81%AE%E8%AA%AC%E6%98%8E（＝ 「山田太郎の説明」） |
| 指定された話者の修正 | PUT /srs/speakers/<speakerId> returns オペレーションリソース - enable=識別対象とするかどうか(optional): 学習状況によって自動で決まるため設定不要だが、一時的に話者を識別対象から外したい時に便利 |
| 指定された話者の削除 | DELETE /srs/speakers/<speakerId> returns オペレーションリソース |
| 指定された話者が所属する話者グループ一覧の取得(逆引き) | GET /srs/speakers/<speakerId>/speaker_groups returns 話者グループリソース |
| 指定された話者の学習器を取得する | GET /srs/speakers/<speakerId>/trainer returns 学習器リ ソース |
| 指定された話者の学習を開始する | POST /srs/speakers/<speakerId>/trainer/commit returns オペレーションリソース |
| 指定された話者の学習を中断する | DELETE /srs/speakers/<speakerId>/trainer/commit returns オペレーションリソース |
話者データの操作 | API |
|---|---|
発話一覧の取得 | GET /srs/speeches returns 発話リソース |
指定された発話の取得 | GET /srs/speeches/<speechId> returns 発話リソース |
指定された話者に登録された発話一覧の取得 | GET /srs/speakers/<speakerId>/speeches returns 発話リソース |
指定された話者に発話を新規作成する | POST /srs/speakers/<speakerId>/speeches returns オペ レーションリソース
|
指定された発話を削除する | DELETE /srs/speeches/<speechId> |
利用例
話者識別 を参照してください。
Updated 4 months ago