レスポンスオプション: Markdown、生レスポンス、include フラグ

payload.include はタスクのレスポンスに任意のフィールドを追加します。各フラグはブール値で、各エンジンが効かせるのはその一部だけです。

{
  "taskType": "PERPLEXITY",
  "payload": {
    "prompt": "best CRM for a small team",
    "country": "US",
    "include": { "markdown": true, "rawResponse": true }
  }
}

フラグ

フラグ	追加するもの
`markdown`	回答のMarkdown。`markdown` に入ります(`GOOGLE` と `BING_SEARCH` では `aioverview.markdown`)。
`rawResponse`	エンジンの生の出力。`rawResponse` または `rawContent` に入ります(下記参照)。
`searchQueries`	エンジンが実行した検索。`searchQueries` に入ります。
`ads`、`shopping`	広告と商品カード。`CHATGPT` のみ。
`html`	エンジンが表示した画面。HTMLページを参照してください。
`analysis`	ブランド、推薦、センチメント、出典の種類。回答の分析を参照してください。
`entityDetails`	回答のカードごとの詳細パネル。無料、`CHATGPT` のみ。ChatGPTを参照してください。
`citationAnalysis`	回答のCitation Analysis。下記を参照してください。

対応表

✓ 有効、always フラグなしでも常に返す、— 効果なし(無視)、✗ 拒否。

taskType	`markdown`	`rawResponse`	`searchQueries`	`html`	`analysis`	`citationAnalysis`
`CHATGPT`	✓(既定でオン)	✓	✓(既定でオン)	✓	✓	✓
`GEMINI`	✓	✓	—	✓	✓	✓
`PERPLEXITY`	✓	✓	✓	✓	✓	✓
`GOOGLE`	✓	✓ `rawContent`	—	✓	✓	✓
`AIMODE`	always	✓ `rawContent`	—	✓	✓	✓
`BING_COPILOT`	✓	✓	always	✗	✗	✓
`NAVER_AI_BRIEF`	always	✓ `rawContent`	—	✗	✓	✓
`NAVER_AI_TAB`	always	✓ `rawContent`	—	✗	✓	✓
`META_AI`	always	✓	always	✓	✗	✗
`QWEN`	always	✓	always	✗	✗	✗
`DOUBAO`	always	✓	always	✗	✗	✗
`GOOGLE_SERP`	—	✓ `rawContent`	—	✗	✗	✗
`BING_SEARCH`	✓	✓ `rawContent`	—	✗	✗	✓
`NAVER_SERP`, `COMMERCE_SERP`, `COMMERCE_PRODUCT`, `REDDIT`, `WEB_SCRAPE`, `WEB_MAP`, `WEB_CRAWL`, `KEYWORD_VOLUME`	—	—	—	✗	✗	✗

ads と shopping は CHATGPT でのみ効き、既定でオンです。他のエンジンはすべて無視します。searchQueries の「always」は、フラグの設定に関係なくエンジンがそのフィールドを返すことを意味します。

フラグなしのMarkdown

AIMODE、NAVER_AI_BRIEF、NAVER_AI_TAB、META_AI、QWEN、DOUBAO はすべての回答で markdown を返します。これらのエンジンではMarkdownが回答の本来の形(見出し、リスト、表、カードがその位置にある)で、text のコピーではありません。CHATGPT も既定で返します。不要なら "markdown": false を送ってください。 GOOGLE は旧フラグ include.aioverview.markdown も受け付け、include.markdown と同じ働きをします。

生レスポンス

rawResponse は CHATGPT を含むすべてのエンジンで既定でオフです。生の出力は次の2つのフィールドのいずれかに入ります。

rawResponse: 解析済みストリームイベントの配列(CHATGPT、GEMINI、PERPLEXITY、BING_COPILOT、META_AI、QWEN、DOUBAO)。
rawContent: 文字列。GOOGLE、AIMODE、GOOGLE_SERP、BING_SEARCH ではレンダリングされた結果ページ全体のHTML、NAVER_AI_BRIEF と NAVER_AI_TAB では NAVER の元のイベントストリームです。

これらのフィールドは数百KBになることがあるため、必要なときだけリクエストしてください。

未対応のフラグ

扱いはフラグによって異なります。

フラグ	対応していないエンジンでは
`markdown`、`rawResponse`、`searchQueries`、`ads`、`shopping`	黙って無視されます。エラーもフィールドもありません。
`html`	`422 EVIDENCE_UNSUPPORTED`。
`analysis`	`payload.include.analysis` についての `422 VALIDATION_ERROR`。
`citationAnalysis`	`payload.include.citationAnalysis` についての `400 VALIDATION_ERROR`。
`entityDetails`	`payload.include.entityDetails` についての `422 VALIDATION_ERROR`。
`screenshot`	すべてのエンジンで `400 VALIDATION_ERROR`。提供を終了しています。`html` を使ってください。

html、screenshot、citationAnalysis はブール値でなければならず(それ以外は 400 VALIDATION_ERROR)、analysis も同様です(422 VALIDATION_ERROR)。拒否はすべて送信時、クレジットを確保する前に行われます。

Citation Analysis

include.citationAnalysis: true を指定すると、回答の完了後にその回答のCitation Analysisを開始します。これは別の従量課金タスクで、回答の Webhook はその完了を待ち、読み取り時には response.citationAnalysis に埋め込まれます。CHATGPT、GEMINI、PERPLEXITY、GOOGLE、AIMODE、BING_SEARCH、BING_COPILOT、NAVER_AI_BRIEF、NAVER_AI_TAB で使えます。APIキーにも CITATION_ANALYSIS の送信が許可されている必要があります(なければ 403)。結果と料金は Citation Analysis を参照してください。

はじめに

基本概念

回答エンジン

検索とウェブデータ

リクエストオプション

リサーチ

GEOモニタリング

アカウントとデータ

レスポンスオプション: Markdown、生レスポンス、include フラグ

フラグ

対応表

フラグなしのMarkdown

生レスポンス

未対応のフラグ

Citation Analysis

関連

​フラグ

​対応表

​フラグなしのMarkdown

​生レスポンス

​未対応のフラグ

​Citation Analysis

​関連

フラグ

対応表

フラグなしのMarkdown

生レスポンス

未対応のフラグ

Citation Analysis

関連