音声文字起こし

文字起こしモードの選択

シナリオ	model	返却形式
通常の音声文字起こし	`moss-transcribe-1.0`	JSON / text
複数話者の文字起こし	`moss-transcribe-diarize-pro`	JSON（`segments`を含む）。`stream=true`でSSEを返すこともできます

リクエストパラメータ

フィールド型必須説明

model: string必須

モデルID。通常の文字起こしにはmoss-transcribe-1.0を使用し、複数話者の文字起こし、ホットワード、SSEストリーミング出力にはmoss-transcribe-diarize-proを使用します。

file: multipart file4つから1つ

multipart/form-dataでローカルの音声ファイルまたは動画ファイルを直接アップロードします。先にファイルアップロードAPIを呼び出す必要はありません。async=trueを指定しない場合は、文字起こし結果を同期的に返します。1ファイルあたり最大512 MB。

file_id: string4つから1つ

POST /v1/filesが返すファイルIDを参照します。

url: string4つから1つ

サーバーからアクセス可能なパブリックな音声URL。localhost、ループバックアドレス、プライベートネットワークのアドレスを指定することはできません。

audio_url: string4つから1つ

urlの互換フィールドで、アクセス制限も同じです。新規の呼び出しではurlの使用を推奨します。

diarize: boolean任意

trueに設定すると話者分離の結果を返します。moss-transcribe-diarize-proのみ対応しています。指定しない場合またはfalseの場合は、完全なテキストのみを返します。

keyterms: string[]任意

ホットワードのリスト。固有名詞、人名、ブランド名、業務用語の認識精度を向上させるために使用します。moss-transcribe-diarize-proのみ対応しています。最大20個、各30文字までです。指定しない場合または[]の場合は無効になります。multipart/form-dataを使用する場合は、JSON文字列配列として渡します（例：["MOSS","SGLang"]）。

stream: boolean任意

trueの指定にはmoss-transcribe-diarize-proのみが対応しており、SSEの文字起こしイベントを返すために使用します。async=trueと同時に指定することはできません。

response_format: string任意

文字起こし結果のフォーマット。非ストリーミングのデフォルトはjsonです。ストリーミングでは常にSSEイベントを返すため、verbose_jsonを明示的に指定することを推奨します。

async: boolean任意

trueに設定すると非同期タスクを作成し、タスクオブジェクトを即座に返します。stream=trueと同時に使用することはできません。

webhook_url: string任意

非同期タスクの完了後にコールバックするHTTPS URL。

対応フォーマットとアップロード制限

項目	説明
1ファイルのサイズ	最大512 MB。直接アップロードと`/v1/files`で同じ制限です。
対応フォーマット	AAC、AMR、FLAC、M4A、ALAC、MOV、MP3、MP4、MPG、OGG、OPUS、WAV、WebM、WMA
音声・動画コンテナ	MOV、MP4、MPG、WebMはいずれも文字起こしできます

戻り値

通常のJSON: object

response_format=jsonでdiarizeを有効にしていない場合、文字起こしの完全なテキストを返します。

話者分離: object

diarizeを有効にした場合、またはresponse_format=diarized_jsonを使用した場合、完全なテキストと話者ごとのセグメントを返します。

Text: string

response_format=textの場合、プレーンテキストを直接返します。

SSE: event stream

stream=trueの場合、完了または失敗するまでサーバーイベントを継続的に返します。例ではストリーミング専用のverbose_jsonを使用しています。

非同期タスク: object

async=trueの場合、タスクオブジェクトを即座に返します。結果はタスク照会APIで取得します。

エラーコード

HTTPerror.code発生条件と対処方法

400: 4件のerror.code

入力ソース、ストリーミング / 非同期の組み合わせ、またはホットワードが不正です。

エラーの説明

以下の場合はパラメータエラーを返します。

keytermsが文字列の配列ではない。
keytermsに文字列以外の要素が含まれている。
通常のmoss-transcribe-1.0で空でないkeytermsを指定している。

次のステップ

ファイルのアップロード

音声ファイルをアップロードしてfile_idを取得します。

ボイス一覧の取得

現在のアカウントで利用可能なボイスの一覧を取得します。

リクエスト例

curl -X POST "https://api.mosi.cn/v1/audio/transcriptions" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -F "model=moss-transcribe-1.0" \
  -F "file=@./audio.mp3" \
  -F "response_format=json"

import os
import requests

with open("./audio.mp3", "rb") as file:
    response = requests.post(
        "https://api.mosi.cn/v1/audio/transcriptions",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        },
        data={
            "model": "moss-transcribe-1.0",
            "response_format": "json",
        },
        files={"file": file},
    )

response.raise_for_status()
print(response.json())

import { readFile } from "node:fs/promises"

const bytes = await readFile("./audio.mp3")
const form = new FormData()
form.append("model", "moss-transcribe-1.0")
form.append("file", new Blob([bytes]), "audio.mp3")
form.append("response_format", "json")

const response = await fetch("https://api.mosi.cn/v1/audio/transcriptions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
  },
  body: form,
})

if (!response.ok) throw new Error(`HTTP ${response.status}`)
console.log(await response.json())

curl -X POST "https://api.mosi.cn/v1/audio/transcriptions" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "moss-transcribe-1.0",
  "file_id": "<file_id>",
  "response_format": "json"
}'

import os
import requests

response = requests.post(
        "https://api.mosi.cn/v1/audio/transcriptions",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        "Content-Type": "application/json",
        },
        json={
            "model": "moss-transcribe-1.0",
            "file_id": "<file_id>",
            "response_format": "json",
        },
)

response.raise_for_status()
print(response.json())

const response = await fetch("https://api.mosi.cn/v1/audio/transcriptions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "moss-transcribe-1.0",
    "file_id": "<file_id>",
    "response_format": "json"
  }),
})

if (!response.ok) throw new Error(`HTTP ${response.status}`)
console.log(await response.json())

curl -X POST "https://api.mosi.cn/v1/audio/transcriptions" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "moss-transcribe-diarize-pro",
  "file_id": "<file_id>",
  "diarize": true,
  "response_format": "json"
}'

import os
import requests

response = requests.post(
        "https://api.mosi.cn/v1/audio/transcriptions",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        "Content-Type": "application/json",
        },
        json={
            "model": "moss-transcribe-diarize-pro",
            "file_id": "<file_id>",
            "diarize": True,
            "response_format": "json",
        },
)

response.raise_for_status()
print(response.json())

const response = await fetch("https://api.mosi.cn/v1/audio/transcriptions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "moss-transcribe-diarize-pro",
    "file_id": "<file_id>",
    "diarize": true,
    "response_format": "json"
  }),
})

if (!response.ok) throw new Error(`HTTP ${response.status}`)
console.log(await response.json())

curl -X POST "https://api.mosi.cn/v1/audio/transcriptions" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "moss-transcribe-diarize-pro",
  "file_id": "<file_id>",
  "diarize": true,
  "response_format": "json",
  "keyterms": [
    "MOSS",
    "SGLang",
    "矩池云"
  ]
}'

import os
import requests

response = requests.post(
        "https://api.mosi.cn/v1/audio/transcriptions",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        "Content-Type": "application/json",
        },
        json={
            "model": "moss-transcribe-diarize-pro",
            "file_id": "<file_id>",
            "diarize": True,
            "response_format": "json",
            "keyterms": [
                "MOSS",
                "SGLang",
                "矩池云",
            ],
        },
)

response.raise_for_status()
print(response.json())

const response = await fetch("https://api.mosi.cn/v1/audio/transcriptions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "moss-transcribe-diarize-pro",
    "file_id": "<file_id>",
    "diarize": true,
    "response_format": "json",
    "keyterms": [
      "MOSS",
      "SGLang",
      "矩池云"
    ]
  }),
})

if (!response.ok) throw new Error(`HTTP ${response.status}`)
console.log(await response.json())

curl -N -X POST "https://api.mosi.cn/v1/audio/transcriptions" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -d '{
  "model": "moss-transcribe-diarize-pro",
  "file_id": "<file_id>",
  "diarize": true,
  "stream": true,
  "response_format": "verbose_json"
}'

import os
import requests

with requests.post(
        "https://api.mosi.cn/v1/audio/transcriptions",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        "Content-Type": "application/json",
        "Accept": "text/event-stream",
        },
        json={
            "model": "moss-transcribe-diarize-pro",
            "file_id": "<file_id>",
            "diarize": True,
            "stream": True,
            "response_format": "verbose_json",
        },
        stream=True,
    ) as response:
    response.raise_for_status()
    for line in response.iter_lines(decode_unicode=True):
        if line:
            print(line)

const response = await fetch("https://api.mosi.cn/v1/audio/transcriptions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
    "Content-Type": "application/json",
    "Accept": "text/event-stream",
  },
  body: JSON.stringify({
    "model": "moss-transcribe-diarize-pro",
    "file_id": "<file_id>",
    "diarize": true,
    "stream": true,
    "response_format": "verbose_json"
  }),
})

if (!response.ok || !response.body) throw new Error(`HTTP ${response.status}`)
const reader = response.body.getReader()
const decoder = new TextDecoder()
while (true) {
  const { done, value } = await reader.read()
  if (done) break
  process.stdout.write(decoder.decode(value, { stream: true }))
}

レスポンス例

{
  "text": "This is a short transcription test audio."
}

{
  "task": "transcribe",
  "duration": 5.18,
  "text": "欢迎使用 Moss API。",
  "segments": [
    {
      "type": "transcript.text.segment",
      "id": "seg_001",
      "start": 0.16,
      "end": 5.18,
      "text": "欢迎使用 Moss API。",
      "speaker": "S01"
    }
  ]
}

data: {"type":"task.created","task_id":"task-123","object":"audio.transcription","status":"PROCESSING","model":"moss-transcribe-diarize-pro"}

data: {"type":"transcript.text.delta","delta":"欢迎"}

data: {"type":"transcript.segment.done","content_index":0,"speaker":"S01","start":0.16,"end":5.18,"text":"欢迎使用 Moss API。","session_usage":{"prompt_tokens":153,"completion_tokens":32,"total_tokens":185}}

data: {"type":"transcript.text.done","text":"欢迎使用 Moss API。","usage":{"prompt_tokens":153,"completion_tokens":32,"total_tokens":185}}

data: {"type":"task.created","task_id":"task-123","object":"audio.transcription","status":"PROCESSING","model":"moss-transcribe-diarize-pro"}

data: {"type":"transcript.text.delta","delta":"欢迎"}

data: {"type":"transcript.segment.done","content_index":0,"speaker":"S01","start":0.16,"end":5.18,"text":"欢迎使用 Moss API。","session_usage":{"prompt_tokens":153,"completion_tokens":32,"total_tokens":185}}

data: {"type":"transcript.text.done","text":"欢迎使用 Moss API。","usage":{"prompt_tokens":153,"completion_tokens":32,"total_tokens":185}}

data: {"type":"task.created","task_id":"task-123","object":"audio.transcription","status":"PROCESSING","model":"moss-transcribe-diarize-pro"}

data: {"type":"transcript.text.delta","delta":"欢迎"}

data: {"type":"transcript.segment.done","content_index":0,"speaker":"S01","start":0.16,"end":5.18,"text":"欢迎使用 Moss API。","session_usage":{"prompt_tokens":153,"completion_tokens":32,"total_tokens":185}}

data: {"type":"transcript.text.done","text":"欢迎使用 Moss API。","usage":{"prompt_tokens":153,"completion_tokens":32,"total_tokens":185}}