> ## Documentation Index
> Fetch the complete documentation index at: https://docs.benzinga.com/llms.txt
> Use this file to discover all available pages before exploring further.
# トランスクリプト ストリーム
> 決算説明会コールの発言内容を、話されたそばから1文ごとのトランスクリプトとしてリアルタイム配信します。
## 概要
リアルタイムの決算発表コール書き起こしを購読し、ライブの決算発表コール中に話された内容を一文単位でリアルタイムに受信できます。リアルタイムのトランスクリプトビューアや分析ツールを構築するのに最適です。
### 主要な機能
* **ライブ文字起こし**: 決算説明会中の発言を、話された内容に応じてリアルタイムで文単位に更新
* **単語レベルのタイミング**: 各文に、単語ごとのタイムスタンプと信頼度スコアを付与
* **話者識別**: 誰が発言しているかを把握可能（経営陣、アナリストなど）
* **ステータス追跡**: 文字起こしが進行中か完了済みかを監視
* **柔軟なサブスクリプション**: 特定のティッカー、または `*` を指定してすべての文字起こしを購読
* **モックテスト**: ライブコールがない場合でも、モックデータを使って連携をテスト可能
### ユースケース
* 決算説明会のリアルタイム文字起こしビューアの構築
* ライブ字幕やアクセシビリティ向けツールの作成
* 決算説明会に対するリアルタイムなセンチメント分析
* 発言と同時に重要なフレーズや指標を抽出
* ライブコール中の特定のキーワードやトピックに基づくアラート
* 精密なタイミングデータ付きでの完全なトランスクリプトのアーカイブ
## クイックスタート
上部のインタラクティブなウェブソケットテスターを使用して、リアルタイムでストリームへの接続をテストします。
### 接続 URL
```
wss://api.benzinga.com/api/v1/transcripts/stream?token=YOUR_TOKEN
```
### クエリパラメータ
| パラメータ | 必須 | 説明 |
| ------- | -- | --------------------------- |
| `token` | はい | Benzinga の ウェブソケット API トークン |
## サブスクリプションコマンド
サブスクリプションを制御するには、JSON形式のコマンドを送信します。
### 特定の ticker を購読する
```json theme={null}
{
"action": "subscribe",
"ticker": "AAPL"
}
```
### すべてのトランスクリプトを購読する
```json theme={null}
{
"action": "subscribe",
"ticker": "*"
}
```
### Ticker の購読を解除
```json theme={null}
{
"action": "unsubscribe",
"ticker": "AAPL"
}
```
### アクティブなトランスクリプトを一覧する
```json theme={null}
{
"action": "list"
}
```
### 接続の維持
```json theme={null}
{
"action": "ping"
}
```
### モックデータでのテスト
ライブのトランスクリプトが利用できない場合は、テストにはモックモードを使用します：
```json theme={null}
{
"action": "subscribe",
"ticker": "AAPL",
"mock": true
}
```
サポートされているモック ticker: `AAPL`, `MSFT`, `TSLA`
## メッセージの例
```json theme={null}
{
"call_id": "call_123456",
"transcript_id": "550e8400-e29b-41d4-a716-446655440000",
"call_title": "Apple Inc. Q4 2024 Earnings Call",
"sentence": "Revenue for the quarter was 89.5 billion dollars.",
"start_time": "2024-01-15T16:30:15Z",
"end_time": "2024-01-15T16:30:19Z",
"symbol": "AAPL",
"exchange": "NASDAQ",
"name": "Apple Inc.",
"sequence": 42,
"status": "IN_PROGRESS",
"speaker": "Tim Cook, CEO",
"type": "LIVE",
"language": "en",
"confidence": 0.98,
"words": [
{
"text": "Revenue",
"confidence": 0.99,
"start": 0,
"end": 450
},
{
"text": "for",
"confidence": 0.98,
"start": 450,
"end": 600
}
],
"created_time": "2024-01-15T16:30:19Z"
}
```
### 主要フィールド
| Field | Description |
| ------------------------- | --------------------------------------- |
| `sentence` | 発話された文全体のテキスト |
| `sequence` | トランスクリプト内でのこの文の順序 (0, 1, 2...) |
| `speaker` | 発話者の名前/識別子 |
| `status` | `IN_PROGRESS`（リアルタイム）または `COMPLETE`（完了） |
| `confidence` | 全体的な認識精度に対する信頼度 (0.0 - 1.0) |
| `words` | タイミングおよび信頼度情報を含む単語ごとの配列 |
| `start_time` / `end_time` | 文のタイミングを表す ISO 8601 タイムスタンプ |
### Transcript ステータス
| ステータス | 説明 |
| ------------- | ------------------------------------- |
| `IN_PROGRESS` | Transcript は現在進行中で、更新がリアルタイムに反映されています |
| `COMPLETE` | Transcript は完了しており、これ以上の更新は行われません |
## 単語レベルのデータ
各文には、単語ごとの詳細な情報が含まれます。
```json theme={null}
{
"text": "Revenue",
"confidence": 0.99,
"start": 0,
"end": 450
}
```
* **text**: 単語自体
* **confidence**: 認識信頼度（0.0〜1.0）
* **start/end**: 文頭からのタイミングオフセット（ミリ秒単位）
## インタラクティブコマンド
| Command | Parameters | Description |
| ------------- | ---------- | -------------------------------- |
| `subscribe` | `ticker` | 指定した ticker のトランスクリプト更新を購読します |
| `unsubscribe` | `ticker` | 指定した ticker のトランスクリプト更新の購読を解除します |
| `list` | - | 有効/利用可能なトランスクリプトの一覧を取得します |
| `subscribed` | - | 現在購読中の一覧を取得します |
| `ping` | - | 接続維持用のコマンドです（`pong` が返されます） |
| `echo` | `message` | エコー テスト（送信したメッセージがそのまま返されます） |
## ベストプラクティス
### リアルタイム表示
* **バッファ管理**: `sequence` フィールドを使用して、文を順序どおりに表示する
* **話者ごとのフォーマット**: `speaker`（経営陣 vs アナリスト）に応じて表示形式を変える
* **ステータスインジケーター**: `IN_PROGRESS` と `COMPLETE` のステータスを視覚的に区別して表示する
### パフォーマンス
* **ワイルドカードの注意**: `ticker: "*"` を使用すると、すべてのトランスクリプトを対象としたサブスクリプションとなり、非常に大量のデータが配信される可能性があります
* **対象を絞ったサブスクリプション**: 帯域幅の消費を抑えるため、必要なティッカーに対してのみサブスクライブしてください
* **ハートビート**: 接続を維持するために、30〜60秒ごとに `ping` を送信します
### データ品質
* **信頼度によるフィルタリング**: 信頼度スコアが低い文は無視するかフラグを付けることを検討してください
* **単語レベルの精度**: 単語レベルの信頼度を使用して、不確実な文字起こしを特定してください
* **言語処理**: テキストが適切にレンダリングされているか確認するために `language` フィールドをチェックしてください
### テスト
* **モックモード**: ライブ API 呼び出しを行わない開発時は `mock: true` を指定します
* **エコーテスト**: 接続およびメッセージ処理を確認するには `echo` アクションを使用します
* **リストコマンド**: 現在利用可能なものを確認するには `list` を実行します
## 統合の例
```javascript theme={null}
const ws = new WebSocket(
'wss://api.benzinga.com/api/v1/transcripts/stream?token=YOUR_TOKEN'
);
ws.onopen = () => {
// Appleのトランスクリプトをサブスクライブ
ws.send(JSON.stringify({
action: 'subscribe',
ticker: 'AAPL'
}));
};
ws.onmessage = (event) => {
const data = JSON.parse(event.data);
// 話者と文を表示
console.log(`[${data.sequence}] ${data.speaker}: ${data.sentence}`);
// トランスクリプトが完了しているか確認
if (data.status === 'COMPLETE') {
console.log('Transcript finished');
}
};
// 接続を維持
setInterval(() => {
ws.send(JSON.stringify({ action: 'ping' }));
}, 30000);
```
## 関連ドキュメント
* [WebSocket Introduction](../introduction) - 一般的なウェブソケットの概念と接続の基本
* [Authentication](../authentication) - API トークンの取得方法と使用方法
## AsyncAPI
````yaml asyncapi/transcripts-stream.yml transcripts
id: transcripts
title: Transcripts
description: Send action commands; receive real-time transcript updates
servers:
- id: production
protocol: wss
host: api.benzinga.com/api/v1/transcripts
bindings: []
variables: []
address: stream
parameters: []
bindings: []
operations:
- &ref_1
id: transcripts.publish
title: Transcripts.publish
description: Send commands to the server
type: receive
messages:
- &ref_3
id: publish
contentType: application/json
payload:
- name: publish
description: WebSocket command to interact with transcript stream
type: object
properties:
- name: action
type: string
description: Action to perform
enumValues:
- list
- subscribe
- unsubscribe
- subscribed
- echo
- ping
required: true
- name: ticker
type: string
description: Stock ticker symbol (e.g., AAPL) or '*' for all transcripts
required: false
- name: message
type: string
description: Optional message for echo testing
required: false
- name: mock
type: boolean
description: Optional boolean for mock testing when no live transcripts
required: false
headers: []
jsonPayloadSchema:
type: object
required:
- action
properties:
action:
type: string
enum:
- list
- subscribe
- unsubscribe
- subscribed
- echo
- ping
description: Action to perform
x-parser-schema-id:
ticker:
type: string
description: Stock ticker symbol (e.g., AAPL) or '*' for all transcripts
x-parser-schema-id:
message:
type: string
description: Optional message for echo testing
x-parser-schema-id:
mock:
type: boolean
description: Optional boolean for mock testing when no live transcripts
x-parser-schema-id:
x-parser-schema-id:
title: Publish
description: WebSocket command to interact with transcript stream
example: |-
{
"action": "list"
}
bindings: []
extensions:
- id: x-parser-unique-object-id
value: publish
- id: x-parser-message-name
value: ActionRequest
bindings: []
extensions: &ref_0
- id: x-parser-unique-object-id
value: transcripts
- &ref_2
id: transcripts.subscribe
title: Transcripts.subscribe
description: Receive real-time transcript data
type: send
messages:
- &ref_4
id: subscribe
contentType: application/json
payload:
- name: subscribe
description: Real-time transcript message
type: object
properties:
- name: call_id
type: string
description: Unique identifier for the earnings call
required: true
- name: transcript_id
type: string
description: Unique identifier for this transcript
required: true
- name: call_title
type: string
description: Title of the earnings call
required: false
- name: sentence
type: string
description: The spoken sentence text
required: true
- name: start_time
type: string
description: When this sentence started
required: false
- name: end_time
type: string
description: When this sentence ended
required: false
- name: symbol
type: string
description: Stock ticker symbol (e.g., AAPL)
required: true
- name: exchange
type: string
description: Exchange where security is listed
required: false
- name: isin
type: string
description: International Securities Identification Number
required: false
- name: cusip
type: string
description: CUSIP identifier
required: false
- name: name
type: string
description: Company name
required: false
- name: sequence
type: integer
description: Sequence number of this sentence in the transcript
required: true
- name: status
type: string
description: Status of the transcript
enumValues:
- IN_PROGRESS
- COMPLETE
required: true
- name: words
type: array
description: Individual words with timing and confidence
required: false
properties:
- name: confidence
type: number
description: Confidence score for word recognition
required: false
- name: start
type: integer
description: Start time offset in milliseconds
required: false
- name: end
type: integer
description: End time offset in milliseconds
required: false
- name: text
type: string
description: The word text
required: false
- name: confidence
type: number
description: Overall confidence score for the sentence
required: false
- name: speaker
type: string
description: Name or identifier of the speaker
required: false
- name: type
type: string
description: Type of transcript (LIVE for real-time)
enumValues:
- LIVE
required: false
- name: language
type: string
description: Language code (e.g., en, en-US)
required: false
- name: participants
type: array
description: List of call participants
required: false
properties:
- name: item
type: object
required: false
- name: created_time
type: string
description: When this transcript entry was created
required: false
headers: []
jsonPayloadSchema:
type: object
required:
- call_id
- transcript_id
- sentence
- symbol
- sequence
- status
properties:
call_id:
type: string
description: Unique identifier for the earnings call
x-parser-schema-id:
transcript_id:
type: string
format: uuid
description: Unique identifier for this transcript
x-parser-schema-id:
call_title:
type: string
description: Title of the earnings call
x-parser-schema-id:
sentence:
type: string
description: The spoken sentence text
x-parser-schema-id:
start_time:
type: string
format: date-time
description: When this sentence started
x-parser-schema-id:
end_time:
type: string
format: date-time
description: When this sentence ended
x-parser-schema-id:
symbol:
type: string
description: Stock ticker symbol (e.g., AAPL)
x-parser-schema-id:
exchange:
type: string
description: Exchange where security is listed
x-parser-schema-id:
isin:
type: string
description: International Securities Identification Number
x-parser-schema-id:
cusip:
type: string
description: CUSIP identifier
x-parser-schema-id:
name:
type: string
description: Company name
x-parser-schema-id:
sequence:
type: integer
description: Sequence number of this sentence in the transcript
x-parser-schema-id:
status:
type: string
enum:
- IN_PROGRESS
- COMPLETE
description: Status of the transcript
x-parser-schema-id:
words:
type: array
description: Individual words with timing and confidence
items:
type: object
properties:
confidence:
type: number
description: Confidence score for word recognition
x-parser-schema-id:
start:
type: integer
description: Start time offset in milliseconds
x-parser-schema-id:
end:
type: integer
description: End time offset in milliseconds
x-parser-schema-id:
text:
type: string
description: The word text
x-parser-schema-id:
x-parser-schema-id:
x-parser-schema-id:
confidence:
type: number
description: Overall confidence score for the sentence
x-parser-schema-id:
speaker:
type: string
description: Name or identifier of the speaker
x-parser-schema-id:
type:
type: string
enum:
- LIVE
description: Type of transcript (LIVE for real-time)
x-parser-schema-id:
language:
type: string
description: Language code (e.g., en, en-US)
x-parser-schema-id:
participants:
type: array
nullable: true
description: List of call participants
items:
type: object
x-parser-schema-id:
x-parser-schema-id:
created_time:
type: string
format: date-time
description: When this transcript entry was created
x-parser-schema-id:
x-parser-schema-id:
title: Subscribe
description: Real-time transcript message
example: No examples found
bindings: []
extensions:
- id: x-parser-unique-object-id
value: subscribe
- id: x-parser-message-name
value: TranscriptMessage
bindings: []
extensions: *ref_0
sendOperations:
- *ref_1
receiveOperations:
- *ref_2
sendMessages:
- *ref_3
receiveMessages:
- *ref_4
extensions:
- id: x-parser-unique-object-id
value: transcripts
securitySchemes:
- id: tokenAuth
name: token
type: httpApiKey
description: Benzinga WebSocket API token
in: query
extensions: []
````