v0.2.0-beta

OpenAPI 3.1.0

Live-відповіді Perplexity LLM

Felo API Support

MIT

Сервер

https://openapi.felo.ai

Клієнтські бібліотеки

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Операції

post/v1/beta/dataforseo/ai_optimization/perplexity/llm_responses/live

Live-відповіді Perplexity LLM

Синхронно надсилає user_prompt моделі Perplexity і повертає її відповідь. model_name має бути взятий з get_dataforseo_ai_perplexity_llm_responses_models — sonar, sonar-pro і sonar-reasoning-pro. web_search_country_iso_code обмежує пошук країною; інші три постачальники цього не пропонують. Повертає model_name, input_tokens, output_tokens, reasoning_tokens, web_search, money_spent, datetime, items і fan_out_queries. Прочитайте money_spent у відповіді, щоб дізнатися фактичну вартість промпту. Упаковано в конверт DataForSEO: дані в tasks[0].result, результат у tasks[0].status_code — відхилений запит усе одно повертає HTTP 200.

Довідкова інформація про ціну

Тарифікація: за заявленою вартістю відповіді.
Орієнтовна вартість запиту: 0.0163 USD.
Довідковий коефіцієнт клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Лише довідкові метадані, а не пропозиція для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — не кредити Felo. Остаточні списання визначаються записами білінгу Felo.

Тіло

application/json

Тип: array (object | null)[]
- max_output_tokens
  Тип: integer | null
  
  максимальна кількість токенів у відповіді AI
  необов'язкове поле
  мінімальне значення: 1
  максимальне значення: 4096;
  значення за замовчуванням: 2048;
  Примітка: якщо в запиті вказано модель міркування, кількість вихідних токенів може перевищити вказаний ліміт max_output_tokens
- message_chain
  Тип: array (object | null)[] | null
  
  історія діалогу необов'язкове поле масив об'єктів повідомлень, що представляють попередні репліки діалогу; кожен об'єкт має містити: role — рядок з роллю user або ai; message — рядок з текстом повідомлення (не більше 500 символів); у масиві можна вказати не більше 10 об'єктів повідомлень; Примітка: для моделей Perplexity повідомлення мають строго чергуватися за ролями user і AI (user → ai); приклад: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
  
  message
  Тип: string | null
  
  текст повідомлення
  
  role
  Тип: string | null
  
  роль користувача, від якого надходить повідомлення
- model_name
  Тип: string
  
  назва моделі AI
  обов'язкове поле
  model_nameскладається з фактичної назви моделі та назви версії;
  якщо вказано базову назву моделі, за замовчуванням буде встановлено її останню версію;
  список доступних моделей LLM можна отримати, зробивши окремий запит до такого ендпоінта: https://api.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/models
- system_message
  Тип: string | null
  
  інструкції для поведінки AI
  необов'язкове поле
  визначає роль, тон або конкретну поведінку AI
  у полі system_message можна вказати до 500 символів
- tag
  Тип: string | null
  
  визначений користувачем ідентифікатор завдання
  необов'язкове поле
  обмеження — 255 символів
  цей параметр дає змогу ідентифікувати завдання й зіставити його з результатом
  вказане значення tag ви знайдете в об'єкті data відповіді
- temperature
  Тип: number | null
  
  ступінь випадковості відповіді AI
  необов'язкове поле
  вищі значення роблять вивід різноманітнішим
  нижчі значення роблять вивід сфокусованішим
  мінімальне значення: 0
  максимальне значення: 1.9
  значення за замовчуванням: 0.77
- top_p
  Тип: number | null
  
  різноманітність відповіді AI
  необов'язкове поле
  керує різноманітністю відповіді, обмежуючи вибір токенів
  мінімальне значення: 0
  максимальне значення: 1
  значення за замовчуванням: 0.9
- user_prompt
  Тип: string
  
  промпт для AI-моделі
  обов'язкове поле
  питання або завдання, яке потрібно надіслати AI-моделі;
  у полі user_prompt можна вказати до 500 символів
- web_search_country_iso_code
  Тип: string | null
  
  код країни для локалізації вебпошуку
  необов'язкове поле
  вкажіть код країни ISO, щоб отримувати локалізовані результати вебпошуку
  Примітка: доступно лише для моделей Perplexity Sonar
  приклад: US

Відповіді

200
Тип: object | null · Response36Afe1097B20_AiOptimizationPerplexityLlmResponsesLiveResponseInfo
cost
Тип: number | null Формат: double

загальна вартість завдань, USD

status_code
Тип: integer | null

загальний код стану. Повний список кодів відповіді можна знайти тут.

status_message
Тип: string | null

загальне інформаційне повідомлення. Повний список загальних інформаційних повідомлень можна знайти тут.

tasks
Тип: array (object | null)[] | null

масив завдань

Тип: object | null · Response36Afe1097B20_AiOptimizationPerplexityLlmResponsesLiveTaskInfo
cost
Тип: number | null Формат: double

загальна вартість завдань, USD

data
Тип: object | null

містить ті самі параметри, які ви вказали в POST-запиті

propertyName
Тип: object | null
id
Тип: string | null

ідентифікатор завдання унікальний ідентифікатор завдання в нашій системі у форматі UUID

path
Тип: array (string | null)[] | null

шлях URL

result
Тип: array (object | null)[] | null

масив результатів

datetime
Тип: string | null

дата й час отримання результату
у форматі UTC: “yyyy-mm-dd hh-mm-ss +00:00”
приклад:
2019-11-15 12:57:46 +00:00

fan_out_queries
Тип: object | null

масив fan-out запитів
містить пов'язані пошукові запити, похідні від основного запиту, для повнішої відповіді

input_tokens
Тип: integer | null

кількість токенів у вхідних даних
загальна кількість оброблених токенів

items
Тип: array (object | null)[] | null

масив елементів відповіді
містить структуровані дані відповіді AI

Тип: object | null · Response36Afe1097B20_MessageAiOptimizationLlmResponseElementItem
Тип: object · Response36Afe1097B20_MessageAiOptimizationLlmResponseElementItem
type
Дискримінатор
Тип: string | null

тип елемента

sections
Тип: array (object | null)[] | null

розділи ланцюжка міркувань
масив об'єктів із розділами ланцюжка міркувань, згенерованими LLM

annotations
Тип: array (object | null)[] | null

масив посилань, використаних для генерації відповіді
дорівнює null, якщо параметр web_search не встановлено в true
Примітка: annotations може повернутися порожнім, навіть якщо web_search має значення true, оскільки ШІ намагатиметься отримати інформацію з інтернету, але може не знайти релевантних результатів

direct_url
Тип: string | null

прямий URL до цитованого джерела
містить URL вихідного джерела, на який веде перенаправлення Vertex AI у полі url

end_index
Тип: integer | null

кінець індексації анотації

start_index
Тип: integer | null

початок індексації анотації

text
Тип: string | null

текст розділу ланцюжка міркувань
текст розділу ланцюжка міркувань, що узагальнює процес мислення моделі

title
Тип: string | null

доменне ім'я або заголовок цитованого джерела

url
Тип: string | null

URL перенаправлення до цитованого джерела
містить перенаправлення Vertex AI, що веде до вихідного джерела

text
Тип: string | null

текст розділу ланцюжка міркувань
текст розділу ланцюжка міркувань, що узагальнює процес мислення моделі

type
Тип: string | null

тип елемента

model_name
Тип: string | null

назва використовуваної AI-моделі

money_spent
Тип: number | null

вартість AI-токенів, USD
ціна, яку сторонній постачальник AI-моделі стягує згідно зі своїми тарифами

output_tokens
Тип: integer | null

кількість токенів у вихідних даних
загальна кількість токенів, згенерованих у відповіді AI

reasoning_tokens
Тип: integer | null

Integer numbers.

web_search
Тип: boolean | null

указує, чи використовувався вебпошук
Примітка: у моделях Perplexity Sonar вебпошук увімкнено за замовчуванням

result_count
Тип: integer | null Формат: int64

кількість елементів у масиві result

status_code
Тип: integer | null

код стану завдання формується DataForSEO, може перебувати в діапазоні 10000-60000 Повний список кодів відповіді можна знайти тут.

status_message
Тип: string | null

інформаційне повідомлення завдання Повний список загальних інформаційних повідомлень можна знайти тут.

time
Тип: string | null

час виконання, секунди

tasks_count
Тип: integer | null Формат: int64

кількість завдань у масиві tasks

tasks_error
Тип: integer | null Формат: int64

кількість завдань у масиві tasks, повернутих з помилкою

time
Тип: string | null

загальний час виконання, секунди

version
Тип: string | null

поточна версія API
application/json
400

Не вдалося обробити запит. Перевірте параметри запиту.
401

Потрібен дійсний API-ключ Felo.
402

Запит неможливо виконати: умови білінгу не виконано.
403

Обліковий запис не має дозволу на цю операцію.
429

Досягнуто ліміту запитів або витрат.
502

Служба не змогла виконати запит.
503

API або служба білінгу тимчасово недоступні.
504

Час очікування обробки запиту вичерпано.
default

Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

application/json

post/v1/beta/dataforseo/ai_optimization/perplexity/llm_responses/live

curl https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/perplexity/llm_responses/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "system_message": "communicate as if we are in a business meeting",
    "message_chain": [
      {
        "role": "user",
        "message": "Hello, what’s up?"
      },
      {
        "role": "ai",
        "message": "Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"
      }
    ],
    "max_output_tokens": 200,
    "temperature": 0.3,
    "top_p": 0.5,
    "web_search_country_iso_code": "FR",
    "model_name": "sonar",
    "user_prompt": "provide information on how relevant the amusement park business is in France now"
  }
]'

Показати схему

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "model_name": null,
          "input_tokens": null,
          "output_tokens": null,
          "reasoning_tokens": null,
          "web_search": null,
          "money_spent": null,
          "datetime": null,
          "items": [
            {
              "type": "[Max Depth Exceeded]",
              "sections": "[Max Depth Exceeded]"
            }
          ],
          "fan_out_queries": null
        }
      ]
    }
  ]
}

Успішна операція

Live-відповіді Perplexity LLM

АвтентифікаціяRequired

DataForSEO

Live-відповіді Perplexity LLM

Довідкова інформація про ціну