oxylabs-ai-studio
Version:
JavaScript SDK for Oxylabs AI Studio API services
29 lines • 1.13 kB
TypeScript
import { OxylabsAIStudioClient } from '../client';
import { SearchOptions, RunResponse, AiSearchRun, SearchRunDataResponse, SearchInstantResponse } from '../types';
/**
* AI-Search Service
* Handles all AI-Search related API calls
*/
export declare class AiSearchService {
private client;
constructor(client: OxylabsAIStudioClient);
/**
* Submit search request (POST /search)
*/
submitSearchRequest(options: SearchOptions): Promise<RunResponse>;
/**
* Submit instant search request (POST /search/instant)
* Returns data in realtime on the same connection without polling
*/
searchInstant(options: SearchOptions): Promise<SearchInstantResponse>;
/**
* Get search run data/results (GET /search/run/data)
*/
getSearchRunData(runId: string): Promise<SearchRunDataResponse>;
/**
* Synchronous browsing (wait for results)
* Automatically uses instant endpoint when limit <= 10 and return_content is false
*/
search(options: SearchOptions, timeout?: number, pollInterval?: number): Promise<AiSearchRun>;
}
//# sourceMappingURL=aiSearch.d.ts.map