ガイド

アカウント設定とAPIの動作

アカウントの動作の一部は、このAPIではなく、Webアプリの プロフィール設定ページで一度だけ設定します。このページでは、そのような設定のそれぞれについて、v1でどのように動作するかを正確に説明します。APIがそれを無条件に従うか、リクエストごとに上書きできるようにするかについてです。この情報は個々のエンドポイントのドキュメントに分散させるのではなく、ここにまとめています。なぜなら、一度に1つのエンドポイントのリファレンスページだけを読むと、この横断的な動作を見逃しやすいからです。

基本ルール

v1はアカウントの現在の設定を直接読み取り、それを適用します。個別のAPIレイヤーの設定システムはなく、(後述の意図的な例外を除き)単一のリクエストのためにアカウント設定を上書きする方法もありません。これは意図的なものです。同じ動作を設定するための2つの独立した場所(Webアプリと並行するAPI設定)を維持すると、必然的に同期が取れなくなるため、処理を開始したのがWebアプリ、このAPI、Google Sheetsアドオンのいずれであっても、同じアカウントが同じように動作することを目標としています。

設定とAPIの動作

設定Webアプリの動作v1 APIの動作リクエストごとに上書き可能?
bbox自動アノテート
auto_annotate_bbox
アカウントレベルのトグルです。オンにすると、完了した抽出ごとに有料のbboxアノテーションパスが自動的に実行されます。そのまま適用されます — v1で作成・処理されたバッチは、このトグルに例外なく従います。トグルがオンの場合、自分でPOST /documents/{document_id}/bboxを呼び出さなくても、bboxアノテーションの料金が発生する可能性があります。いいえ。リクエストレベルでスキップしたり強制したりする方法はありません。
処理品質
thinking_type
処理の速度/品質の階層を選択するアカウントレベルの設定です。上記ルールの唯一の例外です。POST /batches/{batch_name}/processqualityを省略すると、アカウントの現在の設定にフォールバックします — Webアプリと同じ動作です。ただし、そのリクエストでquality: "fast"またはquality: "high"を渡すことで、その呼び出しのみ上書きすることもできます。はい — このページでリクエストごとに上書きできる唯一の設定です。
データ保持
auto_delete / auto_delete_after
処理後N日経過した元画像を自動的に削除するアカウントレベルの設定です。そのまま適用されます — v1で作成されたドキュメントも、Webアプリにアップロードされたものと同じ保持ポリシーの対象となります。いいえ。
処理モード
(内部rec_modemodeとして公開)
Webアプリは現在、テーブル形式の抽出と文書全体のWord変換をサポートしています。v1は現在、mode=table(構造化フィールド抽出)のみをサポートしています。文書全体の変換は計画中ですが、APIではまだ利用できません。まだ該当しません — 選択できる値は1つだけです。より多くのモードがリリースされた場合、これは既存の値の動作変更ではなく、純粋な追加となります。

なぜリクエストレベルのオーバーライドを追加しないのか

bbox自動アノテートと保持ポリシーは、アカウントレベルのガバナンスとして扱われており、呼び出しごとの設定ではありません。これらは「すべての処理でオン、またはすべての処理でオフ」という種類のスイッチであり、1つのAPI呼び出しがアカウントの標準設定から静かに逸脱することを許せば、この設計が回避しようとしているまさに「2つの設定ソース間のずれ」という問題を引き起こします。 qualityは異なります。どの速度/品質の階層が適切かは、呼び出しごとに実際に変わります(このバッチは高速に処理する必要がある、あのバッチは最大精度が必要など)。そのため、ガバナンス設定ではなく運用上の選択として扱われ、唯一のオーバーライドとして開放されています。

📮 contact email: [email protected]