Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Explain search results

伺服器:https://openapi.felo.ai
用戶端程式庫

Explain search results

​

Explain previously fetched search results. Supply the search_id returned by a Scholar search, with optional detail_level and language. response_mode=NON_STREAMING returns JSON with message; COMPLETE and INCREMENTAL return text/event-stream, where each event contains the accumulated explanation. This operation explains an existing search and does not start another search.

請求本文·ExplainSearchRequest
必填
application/json
  • search_id
    類型: string
    必填

    ID of the search to explain

  • detail_level
    類型: string 列舉

    Level of detail in the explanation

    值
    • BRIEF
    • MODERATE
    • DETAILED
  • language
    類型: string

    Language code for the explanation (e.g., en, zh, ar)

  • response_mode
    類型: string 列舉

    Format of the explanation response. COMPLETE and INCREMENTAL stream server-sent events; NON_STREAMING returns a JSON response.

    值
    • COMPLETE
    • INCREMENTAL
    • NON_STREAMING
回應
  • 200
    類型: object · ExplainSearchResponse

    Successful explanation response. COMPLETE/INCREMENTAL stream text/event-stream; NON_STREAMING returns application/json.

    JSON explanation response returned when response_mode is NON_STREAMING.

    • message
      類型: string
      必填

      Generated explanation text.

  • 400
    類型: object · ErrorResponse

    Bad request - invalid parameters

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 401
    類型: object · ErrorResponse

    Unauthorized - invalid or missing API key

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 404
    類型: object · ErrorResponse

    Search ID not found

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 429
    類型: object · ErrorResponse

    Rate limit exceeded

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 500
    類型: object · ErrorResponse

    Internal server error

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

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