Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 2.56 KB

WebsearchApi.md

File metadata and controls

75 lines (51 loc) · 2.56 KB
Raw

AskNews\WebsearchApi

All URIs are relative to https://api.asknews.app, except if the operation defines another base path.

Method HTTP request Description
liveWebSearch() GET /v1/chat/websearch Run a live websearch.

liveWebSearch()

liveWebSearch($queries, $lookback): \AskNews\Model\WebSearchResponse

Run a live websearch.

Run a live websearch on a set of queries, get back a fully structured and LLM-distilled response (in addition to the raw text if you need that as well). Your response includes as_string and as_dicts, where as_string is a prompt-optimized distillation of the information, done by an LLM. as_dicts contains all the details necessary to feed into other parts of your application.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure sdk credentials
$config = new AskNews\Configuration([
  'clientId' => 'YOUR_ASKNEWS_CLIENT_ID',
  'clientSecret' => 'YOUR_ASKNEWS_CLIENT_SECRET',
  'scopes' => ['news', 'chat', 'stories', 'analytics']
]);


$apiInstance = new AskNews\Api\WebsearchApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$queries = array('queries_example'); // string[] | A list of queries to be live searched, analyzed, distilled, and structured.
$lookback = 56; // int | Number of days back to allow the websearch to look. Defaults to All time

try {
    $result = $apiInstance->liveWebSearch($queries, $lookback);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebsearchApi->liveWebSearch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
queries string[] A list of queries to be live searched, analyzed, distilled, and structured.
lookback int Number of days back to allow the websearch to look. Defaults to All time [optional]

Return type

\AskNews\Model\WebSearchResponse

Authorization

Bearer, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]