MiiTel Speech API (2020-10-22)

Download OpenAPI specification:Download

本ドキュメントは、MiiTel Speech API の利用方法を記したものです。

認証

トークン取得

API キーを送るとトークンを取得します。取得したトークンは、24 時間有効です。

Request Body schema: application/json

API キー

api_key
string <uuid>

事前に取得した API キーです

Responses

Response Schema: application/json
object
metadata
object
Response Schema: application/json
error
boolean
message
string

エラーメッセージ

Request samples

Content type
application/json
{
  • "api_key": "abcd1234-abcd-1234-5678-abcd123456"
}

Response samples

Content type
application/json
{
  • "records": {
    • "response": "OK",
    • "token": "abcd1234-abcd-1234-5678-abcd123456"
    },
  • "metadata": { }
}

ジョブ

ジョブ登録

ジョブを登録します。登録可能なファイル形式は、wav, mp3, m4a の 3 形式です。

header Parameters
Authorization
required
string <uuid>
Example: Token abcd1234-abcd-1234-5678-abcd123456

トークン取得 API で取得したトークン

Request Body schema: application/json

登録するジョブの詳細を記載します

job_type
required
string

ジョブ種別 ( "ASR_S3" (S3 にアップロードしたファイルの音声認識) または "ASR_UPLOAD" (直接アップロードしたファイルの音声認識) のみ指定可能)

credential
string <uuid>

外部サービス認証情報 ID (ASR_S3 の場合に必須)

s3_path
string

ファイル格納先 (ASR_S3 の場合に必須)

file_id
string

ファイル ID (ASR_UPLOAD の場合に必須)

job_memo
string

メモ

webhook_url
string

Webhook 送信先 URL (指定した場合、解析終了後に、ジョブ一件取得 APIの records > output_result の情報を HTTP POST します)

speaker
integer

話者の数 (指定した場合、話者ダイヤリゼーションを行います)

Responses

Response Schema: application/json
object
metadata
object
Response Schema: application/json
error
boolean
message
string

エラーメッセージ

Request samples

Content type
application/json
{
  • "job_type": "ASR_S3",
  • "credential": "abcd1234-abcd-1234-5678-abcd123456",
  • "s3_path": "s3://bucket_name/dir_name/file_name.wav",
  • "file_id": "abcd1234-abcd-1234-5678-abcd123456",
  • "job_memo": "これは xx の件に関するジョブです",
  • "webhook_url": "https://domain/path",
  • "speaker": 2
}

Response samples

Content type
application/json
{
  • "records": {
    • "job_id": "abcd1234-abcd-1234-5678-abcd123456"
    },
  • "metadata": { }
}

ジョブ編集

ジョブ情報を編集します。メモのみ編集可能です。

header Parameters
Authorization
required
string <uuid>
Example: Token abcd1234-abcd-1234-5678-abcd123456

トークン取得 API で取得したトークン

Request Body schema: application/json

更新後のメモを記載します

job_id
required
string <uuid>

ジョブ ID

job_memo
required
string

メモ

Responses

Request samples

Content type
application/json
{
  • "job_id": "abcd1234-abcd-1234-5678-abcd123456",
  • "job_memo": "これは xx の件に関するジョブです"
}

ジョブ削除

ジョブ情報を削除します。

header Parameters
Authorization
required
string <uuid>
Example: Token abcd1234-abcd-1234-5678-abcd123456

トークン取得 API で取得したトークン

Request Body schema: application/json

削除するジョブを指定します

job_id
required
string <uuid>

ジョブ ID

Responses

Response Schema: application/json
success
boolean
Response Schema: application/json
error
boolean
message
string

エラーメッセージ

Request samples

Content type
application/json
{
  • "job_id": "abcd1234-abcd-1234-5678-abcd123456"
}

Response samples

Content type
application/json
{
  • "success": true
}

ジョブ一覧取得

最新のジョブから順に 100 件取得します。

query Parameters
p
int
Default: 1

ページ番号(1, 2, 3, ...)。
unit を超えるデータを取得する場合に使用します。
例)p=3, unit=100 の場合: 201 〜 300 番目のデータを取得できます。

unit
int
Default: 100

一度に取得するレコード数。上限は 100 件です。

header Parameters
Authorization
required
string <uuid>
Example: Token abcd1234-abcd-1234-5678-abcd123456

トークン取得 API で取得したトークン

Responses

Response Schema: application/json
Array of objects
object

Response samples

Content type
application/json
{
  • "records": [
    • {
      • "job_id": "abcd1234-abcd-1234-5678-abcd123456",
      • "created_at": "2019-10-24T12:35:17.734169+00:00",
      • "status": "FINISHED",
      • "job_memo": "これは xx の件に関するジョブです"
      }
    ],
  • "metadata": {
    • "total_pages": 10,
    • "total_records": 100
    }
}

ジョブ一件取得

ジョブ ID を直接指定して結果を 1 件取得します。

header Parameters
Authorization
required
string <uuid>
Example: Token abcd1234-abcd-1234-5678-abcd123456

トークン取得 API で取得したトークン

Responses

Response Schema: application/json
Array of objects
metadata
object

Response samples

Content type
application/json
{
  • "records": [
    • {
      • "job_id": "abcd1234-abcd-1234-5678-abcd123456",
      • "job_type": "ASR_S3",
      • "created_at": "2019-10-24T12:35:17.734169+00:00",
      • "status": "FINISHED",
      • "process_begin_at": "2019-10-24T12:35:17.734169+00:00",
      • "process_end_at": "2019-10-24T12:35:17.734169+00:00",
      • "job_memo": "これは xx の件に関するジョブです",
      • "output_result": {
        • "tlr": 0.9022,
        • "overlap_position": [
          • [
            • "12.69 14.01"
            ],
          • [
            • 30.24,
            • 36.01
            ],
          • [
            • 54.85,
            • 59.6
            ]
          ],
        • "silence_position": [
          • [
            • 27.52,
            • 33.73
            ],
          • [
            • 46.35,
            • 51.86
            ],
          • [
            • 68.62,
            • 73.99
            ]
          ],
        • "left_f0": 161.33,
        • "right_f0": 60.78,
        • "left_intonation": 23.21,
        • "right_intonation": 27.72,
        • "left_speechrate": 8.8353,
        • "right_speechrate": 7.8598,
        • "rally": 12,
        • "speech_recognition": {
          • "L": {
            • "phrase": [
              • {
                • "phrase": "はい、お世話になっております。",
                • "phrase_nofiller": "はい、お世話になっております。",
                • "yomi": "ハイオセワニナッテオリマス",
                • "start_at": 5.495,
                • "end_at": 6.74
                }
              ]
            },
          • "R": {
            • "phrase": [
              • null
              ]
            }
          },
        • "speech_recognition_summary": {
          • "L": [
            • "見積もりを先日のお送りくださった条件でいただきたいです。"
            ],
          • "R": [
            • "かしこまりました。メールにて本日中にお送りいたしますので、届くまでお待ちいただけますようお願いいたします。"
            ]
          }