Felo API PlatformFelo API Platform
Todos os endpoints de Scholar Search
v0.2.0-beta
OpenAPI 3.1.0

Explicar resultados de pesquisa

Servidor:https://openapi.felo.ai
Bibliotecas Cliente

Explicar resultados de pesquisa

​

Explica resultados de pesquisa obtidos anteriormente. Informe o search_id retornado por uma pesquisa Scholar, com detail_level e language opcionais. response_mode=NON_STREAMING retorna JSON com message; COMPLETE e INCREMENTAL retornam text/event-stream, em que cada evento contém a explicação acumulada. Esta operação explica uma pesquisa existente e não inicia outra.

Referência de preços

  • Medição: base de custo fixa por requisição bem-sucedida.
  • Estimativa de referência por requisição: USD 0.01.
  • Multiplicador de referência do cliente: 1.0. Não o aplique novamente a um valor de cliente já liquidado.

Apenas metadados de referência, não uma cotação da conta, um preço garantido ou um limite de gastos. Créditos de recursos não são créditos Felo. As cobranças finais seguem os registros de cobrança da Felo.

Corpo
obrigatório
application/json
  • search_id
    Tipo: string
    obrigatório

    ID da pesquisa a explicar

  • detail_level
    Tipo: string enum

    Nível de detalhe da explicação

    valores
    • BRIEF
    • MODERATE
    • DETAILED
  • language
    Tipo: string

    Código de idioma da explicação (por exemplo, en, zh, ar)

  • response_mode
    Tipo: string enum

    Formato da resposta de explicação. COMPLETE e INCREMENTAL transmitem server-sent events; NON_STREAMING retorna uma resposta JSON.

    valores
    • COMPLETE
    • INCREMENTAL
    • NON_STREAMING
Respostas
  • 200
    Tipo: object · Response8Da310D1D213_ExplainSearchResponse

    Resposta de explicação bem-sucedida. COMPLETE/INCREMENTAL transmitem text/event-stream; NON_STREAMING retorna application/json.

    Resposta de explicação em JSON retornada quando response_mode é NON_STREAMING.

    • message
      Tipo: string
      obrigatório

      Texto de explicação gerado.

  • 400

    Não foi possível processar a requisição. Verifique os parâmetros da requisição.

  • 401

    É necessária uma chave de API da Felo válida.

  • 402

    A requisição não pode prosseguir porque um requisito de cobrança não foi atendido.

  • 403

    A conta não tem permissão para realizar esta operação.

  • 429

    Um limite de requisições ou de gastos foi atingido.

  • 502

    O serviço não pôde concluir a requisição.

  • 503

    A API ou o serviço de cobrança está temporariamente indisponível.

  • 504

    O serviço atingiu o tempo limite ao processar a requisição.

  • default

    Resposta de erro; respostas repassadas do upstream podem usar formatos do provedor

    application/json
Request Example for post/v1/beta/scholar/search/explain
curl https://openapi.felo.ai/v1/beta/scholar/search/explain \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "search_id": "",
  "response_mode": "NON_STREAMING",
  "language": "ar",
  "detail_level": "MODERATE"
}'
{
  "message": "string"
}
Explain search results