Saltar al contenido principal
payload.include añade campos opcionales a la respuesta de una tarea. Cada flag es un booleano, y cada motor respeta solo algunos.

Flags

Matriz de compatibilidad

✓ respetado, always devuelto sin el flag, — sin efecto (se ignora), ✗ rechazado. ads y shopping solo funcionan en CHATGPT, donde están activados por defecto; los demás motores los ignoran. searchQueries marcado como “always” significa que el motor devuelve el campo tanto si pones el flag como si no.

Markdown sin flag

AIMODE, NAVER_AI_BRIEF, NAVER_AI_TAB, META_AI, QWEN y DOUBAO devuelven markdown en cada respuesta. Para estos motores, el Markdown es la forma real de la respuesta (títulos, listas, tablas y tarjetas en su sitio), no una copia de text. CHATGPT también lo devuelve por defecto; envía "markdown": false para quitarlo. GOOGLE también acepta el flag antiguo include.aioverview.markdown, que hace lo mismo que include.markdown.

Respuestas en bruto

rawResponse está desactivado por defecto en todos los motores, incluido CHATGPT. La salida en bruto llega en uno de dos campos:
  • rawResponse: un array de eventos de stream ya parseados (CHATGPT, GEMINI, PERPLEXITY, BING_COPILOT, META_AI, QWEN, DOUBAO).
  • rawContent: una cadena. En GOOGLE, AIMODE, GOOGLE_SERP y BING_SEARCH es el HTML completo de la página de resultados renderizada; en NAVER_AI_BRIEF y NAVER_AI_TAB es el stream de eventos original de Naver.
Estos campos pueden ocupar cientos de kilobytes, así que pídelos solo cuando los necesites.

Flags no admitidos

Lo que ocurre depende del flag: html, screenshot y citationAnalysis deben ser booleanos (400 VALIDATION_ERROR en otro caso), igual que analysis (422 VALIDATION_ERROR). Todos los rechazos ocurren al enviar, antes de reservar ningún crédito.

Citation Analysis

include.citationAnalysis: true inicia un Citation Analysis de la respuesta cuando esta se completa. Es una tarea aparte y medida: el webhook de la respuesta la espera, y las lecturas la incluyen en response.citationAnalysis. Funciona en CHATGPT, GEMINI, PERPLEXITY, GOOGLE, AIMODE, BING_SEARCH, BING_COPILOT, NAVER_AI_BRIEF y NAVER_AI_TAB. La clave de API también debe tener permiso para enviar CITATION_ANALYSIS (403 en otro caso). Consulta Citation Analysis para ver el resultado y su precio.

Relacionado