Felo API PlatformFelo API Platform
Wszystkie endpointy Scholar Search
v0.2.0-beta
OpenAPI 3.1.0

Wyjaśnij wyniki wyszukiwania

Serwer:https://openapi.felo.ai
Biblioteki klienckie

Wyjaśnij wyniki wyszukiwania

​

Wyjaśnia wcześniej pobrane wyniki wyszukiwania. Podaj search_id zwrócone przez wyszukiwanie Scholar, z opcjonalnymi detail_level i language. response_mode=NON_STREAMING zwraca JSON z message; COMPLETE i INCREMENTAL zwracają text/event-stream, gdzie każde zdarzenie zawiera skumulowane wyjaśnienie. Ta operacja objaśnia istniejące wyszukiwanie i nie rozpoczyna kolejnego.

Cennik referencyjny

  • Rozliczanie: stała podstawa kosztu za udane żądanie.
  • Szacunek referencyjny dla żądania: USD 0.01.
  • Referencyjny mnożnik klienta: 1.0. Nie stosuj go ponownie do rozliczonej kwoty klienta.

Wyłącznie metadane referencyjne, a nie wycena konta, gwarantowana cena lub limit wydatków. Kredyty zasobów nie są kredytami Felo. Ostateczne obciążenia są zgodne z zapisami rozliczeniowymi Felo.

Treść
wymagane
application/json
  • search_id
    Typ: string
    wymagane

    Identyfikator wyszukiwania do wyjaśnienia

  • detail_level
    Typ: string enum

    Poziom szczegółowości wyjaśnienia

    wartości
    • BRIEF
    • MODERATE
    • DETAILED
  • language
    Typ: string

    Kod języka wyjaśnienia (np. en, zh, ar)

  • response_mode
    Typ: string enum

    Format odpowiedzi z wyjaśnieniem. COMPLETE i INCREMENTAL strumieniują zdarzenia wysyłane przez serwer; NON_STREAMING zwraca odpowiedź JSON.

    wartości
    • COMPLETE
    • INCREMENTAL
    • NON_STREAMING
Odpowiedzi
  • 200
    Typ: object · Response8Da310D1D213_ExplainSearchResponse

    Pomyślna odpowiedź z wyjaśnieniem. COMPLETE/INCREMENTAL przesyłają strumień text/event-stream; NON_STREAMING zwraca application/json.

    Odpowiedź wyjaśnienia JSON zwracana, gdy response_mode ma wartość NON_STREAMING.

    • message
      Typ: string
      wymagane

      Wygenerowany tekst wyjaśnienia.

  • 400

    Nie można przetworzyć żądania. Sprawdź parametry żądania.

  • 401

    Wymagany jest prawidłowy klucz API Felo.

  • 402

    Nie można kontynuować żądania, ponieważ nie spełniono wymogu rozliczeniowego.

  • 403

    Konto nie ma uprawnień do wykonania tej operacji.

  • 429

    Osiągnięto limit żądań lub wydatków.

  • 502

    Usługa nie mogła ukończyć żądania.

  • 503

    API lub usługa rozliczeniowa jest tymczasowo niedostępna.

  • 504

    Upłynął limit czasu usługi podczas przetwarzania żądania.

  • default

    Odpowiedź błędu; odpowiedzi przekazywane bezpośrednio od dostawcy upstream mogą używać formatów dostawcy

    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