← 開発者ガイド

ツールリファレンス

すべての組み込みツールの入力、有効な値、出力の形、そして各呼び出し経路が返しうるエラー — クイックスタートガイドの背後にある完全なリファレンスです。

これまでのガイドは、素早く動く呼び出しにたどり着くためのものでした。このページは、実際に統合を 進める段階になったときに立ち返るリファレンスです — すべてのツールの入力と有効な値、それぞれが何を 出力するか、そして具体的にどんなエラーが返ってくるか — 匿名呼び出しかキー付き呼び出しかで分けて 説明します。この 2 つの経路は挙動が異なるためです。

ツール一覧

以下のツールはすべて、API キーなしで匿名で呼び出せます（レート制限あり）。 はじめての SDK 呼び出し のパターンで利用でき、公開 Tools ページにも表示されるものと同じです。認証済み（API キー/JWT）でも呼び出せます — API キーを取得する と 認証モードを選ぶ を参照してください。

Credits は、1 回の実行があなたのプラン/wallet に対して実際に課す費用です — 機能を組み立てる前に この数字を確認してください。

translate

Output: translation（翻訳されたテキスト）、applied_terms（適用された glossary 用語があればそれ）。

const out = await ai.run({
  pipeline: "translate-string",
  inputs: { text: "Hello", target_language: "de" },
});
// out.translation === "Hallo"

summarize

Output: tldr、key_points、そして extract で指定した action_items / decisions / risks / timeline のうち該当するもの。

rewrite

Output: rewrite（書き換えられたテキスト）、applied_terms。

grammar-fix

Output: corrected（添削後のテキスト）、changes（変更点のリスト）、applied_terms。

email-generator

Output: subject、body、applied_terms。

knowledge-base-qa

Output: answer、grounded（回答が実際に context によって裏付けられているかどうか）、citation（回答の根拠が context のどこにあるか）。

このツールの背後には検索インデックスや外部知識はありません — 同じリクエスト内の context テキストのみをもとに回答します。約 6000 文字を超える単一ドキュメントを扱いたい場合は、元のテキストを チャンクに分割し、チャンクごとに呼び出してください。

Errors

どのエラーが返ってくるかはどう呼び出しているか によって決まります — 匿名呼び出しと認証済み 呼び出しでは検証方法が異なります。一方の経路のエラー挙動がもう一方にも当てはまると考えないでください。

Calling anonymously (no API key)

はじめての SDK 呼び出し のパターンです — 上記のツールすべてが 対象で、IP ごとにレート制限されます。

Important: この経路では、呼び出しが受け付けられる前に inputs が上記のテーブルに照らして 検証されることはありません — 必須フィールドの欠落や無効な値があっても 400 にはなりません。代わりに 実行自体が失敗し、結果をポーリングした際にそれが分かります。API キーを取得したら、事前に検証を行う 下記の認証済み経路に切り替えてください。

Calling with an API key or session token

認証モードを選ぶ のパターンです — あなたがアクセス権を 持つツールすべてが対象です。

資格情報の仕組みや 401/403/429 の認証判定についてさらに詳しくは、 認証モードを選ぶ を参照してください。