A análise de respostas cai para 1 crédito

Uma tarefa de resposta com include.analysis retorna cada marca que a resposta cita com posição, recomendação e sentimento, mais o tipo de cada site citado, pela metade do preço anterior.

O que muda

• A análise de respostas custa 1 crédito por tarefa além do preço do motor (antes: 2). Uma resposta do ChatGPT com análise custa 2 créditos no total.
• Cada site citado recebe um kind mais detalhado: editorial, review_media, pr_wire, reviews, commerce, social, blog, community, video e institution para sites conhecidos. Qualquer outro site é classificado uma vez como brand, content ou um desses tipos, e o resultado é reaproveitado.
• Uma grafia que a análise confirma como o nome próprio de uma marca, como 컬리 para Kurly, é guardada e encontrada por regra nas respostas seguintes.
• A análise funciona nas tarefas CHATGPT, GEMINI, PERPLEXITY, GOOGLE, AIMODE, NAVER_AI_BRIEF e NAVER_AI_TAB.

Como funciona

Um modelo decide quais nomes são marcas, qual delas é a sua, e recommended e sentiment. Posições, ranking, correspondência de nomes e tipos de fonte são calculados por regras, então a mesma leitura dá o mesmo resultado.

Sua marca e seus concorrentes são encontrados por nome e alias com as regras de um monitor: palavras inteiras em alfabeto latino, em qualquer posição em coreano, japonês, chinês e tailandês. O modelo lê os primeiros 40.000 caracteres da resposta, e a análise acrescenta alguns segundos antes de a tarefa terminar.

Onde ajuda

• Calcule a taxa de menção, a posição média e o share of voice de todos os seus prompts direto de analysis.targets.
• Compare como cada motor fala da sua marca e dos seus concorrentes com recommended e sentiment.
• Veja que tipos de sites os motores citam na sua categoria com sources[].kind, e onde o seu site aparece como owned.

Envie a requisição

Envie a requisição com a sua chave de API no cabeçalho Authorization.

curl -X POST https://api.querying.ai/v1/async/task \
  -H "Authorization: Bearer $QUERYING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "taskType": "CHATGPT",
    "payload": {
      "prompt": "best CRM for a small team",
      "country": "US",
      "include": { "analysis": true },
      "brand": "Acme CRM",
      "brandAliases": ["Acme"],
      "brandDomains": ["acme-crm.example"],
      "competitors": [
        "Northwind",
        {
          "name": "Contoso CRM",
          "aliases": ["Contoso"],
          "domains": ["contoso-crm.example"]
        }
      ]
    }
  }'

Campos da requisição

taskTypestringObrigatório

O motor que executa a tarefa, como CHATGPT ou GOOGLE.

payload.promptstringObrigatório

A pergunta, escrita como o usuário digita no chat. Até 100.000 caracteres.

payload.countrystring

Código de país de duas letras do mercado de onde a pergunta parte, como US, KR ou JP. Padrão US.

payload.include.analysisbooleanObrigatório

Com true, chega também analysis: cada marca que a resposta cita, com posição, recomendação, sentimento e o tipo de cada site citado. 1 crédito além do preço do motor.

payload.brandstring

O nome da sua marca, até 200 caracteres. Aparece em analysis.targets com o papel brand.

payload.brandAliasesarray

Até 20 outros nomes que a resposta pode usar para a sua marca. Só com brand.

payload.brandDomainsarray

Até 20 dos seus sites, como acme-crm.example. Uma citação em um deles ou em um subdomínio tem kind owned. Só com brand.

payload.competitorsarray

Até 50 concorrentes. Cada um é um nome ou { name, aliases, domains } com até 20 aliases e 20 domínios. Aparecem em analysis.targets com o papel competitor.

Resposta

Uma tarefa concluída chega assim, resumida para facilitar a leitura.

{
  "success": true,
  "task": {
    "id": "…",
    "taskType": "CHATGPT",
    "status": "COMPLETED",
    "createdAt": "…"
  },
  "credits": { "creditsToCharge": 2, "creditsCharged": 2 },
  "response": {
    "text": "…",
    "analysis": {
      "version": 1,
      "status": "ok",
      "brands": [
        {
          "name": "Northwind",
          "rank": 1,
          "role": "competitor",
          "recommended": true,
          "sentiment": "positive",
          "sentimentScore": 0.9
        },
        {
          "name": "Acme CRM",
          "rank": 2,
          "role": "brand",
          "recommended": true,
          "sentiment": "positive",
          "sentimentScore": 0.5
        },
        {
          "name": "Fabrikam",
          "rank": 3,
          "role": null,
          "recommended": false,
          "sentiment": "neutral",
          "sentimentScore": 0
        }
      ],
      "targets": [
        {
          "name": "Acme CRM",
          "role": "brand",
          "mentioned": true,
          "rank": 2,
          "recommended": true,
          "sentiment": "positive",
          "sentimentScore": 0.5,
          "cited": true
        },
        {
          "name": "Northwind",
          "role": "competitor",
          "mentioned": true,
          "rank": 1,
          "recommended": true,
          "sentiment": "positive",
          "sentimentScore": 0.9,
          "cited": false
        },
        {
          "name": "Contoso CRM",
          "role": "competitor",
          "mentioned": false,
          "rank": null,
          "recommended": null,
          "sentiment": null,
          "sentimentScore": null,
          "cited": false
        }
      ],
      "sources": [
        {
          "position": 1,
          "url": "https://www.acme-crm.example/pricing",
          "domain": "acme-crm.example",
          "kind": "owned",
          "brand": "Acme CRM"
        },
        {
          "position": 2,
          "url": "https://www.g2.com/categories/crm",
          "domain": "g2.com",
          "kind": "reviews",
          "brand": null
        }
      ]
    }
  }
}

response.analysis.statusstring

ok quando a análise rodou, no_answer quando o motor não retornou texto de resposta e failed quando a análise não pôde rodar. Só ok é cobrado.

response.analysis.brandsarray

Cada marca que a resposta cita, na ordem em que aparece pela primeira vez. rank começa em 1, e um produto conta para o fabricante. Cada uma traz recommended, sentiment e sentimentScore.

response.analysis.targetsarray

As marcas que você enviou, na sua ordem, cada uma com mentioned, o rank em brands e cited quando um dos seus domínios é citado.

response.analysis.sources[].kindstring

O tipo de cada site citado: owned e competitor pelos seus domínios, e depois editorial, review_media, pr_wire, reviews, commerce, social, blog, community, video, institution, brand, content ou other.

Receba o resultado

A requisição devolve a tarefa na hora, com status QUEUED. Consulte GET /v1/async/task/{id} até status virar COMPLETED ou FAILED, ou adicione webhook.url e a tarefa concluída chega ao seu servidor com os mesmos task, credits e response. Os resultados ficam disponíveis por 24 horas após o fim da tarefa.

curl https://api.querying.ai/v1/async/task/$TASK_ID \
  -H "Authorization: Bearer $QUERYING_API_KEY"

Preço

A tarefa reserva 1 crédito para a análise no envio e só o cobra quando analysis.status é ok. Com no_answer ou failed, o crédito é liberado e a tarefa termina com a resposta. Os planos e os preços dos créditos estão em https://querying.ai/pricing .