Skip to main content

概要

Tiro には NoteDocumentNoteSummary があります。用途と作成方法が異なります。 Note 全体の構造は Note Data Model をご覧ください。 Template-based document types in Tiro

NoteDocument と NoteSummary の比較

NoteDocument

NoteDocument はセクションに分かれた文書です。API から作成・取得できます。 主な特徴:
  • セクションが定義されたテンプレートを使って作成
  • ユーザーの指示によるカスタムテンプレートに対応
  • 作成・取得(一覧/単体)のみ API で提供されます。更新・削除はまだ API で提供されていません。
  • リアルタイム通知のための Webhook イベント
テンプレートの例:
  • 회의록 (Meeting Minutes)
  • ご自身で作成するカスタムテンプレート
API エンドポイント:
  • POST /v1/external/notes/{noteGuid}/documents - ドキュメントを生成
  • GET /v1/external/notes/{noteGuid}/documents - ドキュメントの一覧を取得
  • GET /v1/external/notes/{noteGuid}/documents/{documentId} - ドキュメントを取得

NoteSummary

NoteSummary は、さまざまなプレゼンテーションスタイルに向けたクイックフォーマットのテンプレートを提供します。 主な特徴:
  • 特定のユースケース(pitch、one-pager など)に最適化
  • 要約を取得するためのフルの API サポート
  • リアルタイム通知のための Webhook イベント
  • 現在は Tiro アプリのインターフェースからのみ作成可能
テンプレートの例:
  • One-Pager
  • Pitch
  • その他、フォーマット別のテンプレート
API エンドポイント:
  • GET /v1/external/notes/{noteGuid}/summaries - 要約の一覧を取得
  • GET /v1/external/notes/{noteGuid}/summaries/{summaryId} - コンテンツ付きで要約を取得
Webhook イベント:
  • note_summary.generated - 要約の作成が完了
  • note_summary.updated - 要約が変更された
  • note_summary.deleted - 要約が削除された