@emergentmethods/asknews-typescript-sdk/dist/models/ForecastResponse.d.ts

Typescript SDK for AskNews API

/**
 * AskNews API
 * AskNews API
 *
 * The version of the OpenAPI document: 0.19.10
 * Contact: contact@emergentmethods.ai
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { WebSearchResult } from './WebSearchResult';
import type { Choice } from './Choice';
import type { KeyPerson } from './KeyPerson';
import type { SearchResponseDictItem } from './SearchResponseDictItem';
/**
 *
 * @export
 * @interface ForecastResponse
 */
export interface ForecastResponse {
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    forecast: string;
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    resolutionCriteria: string;
    /**
     *
     * @type {Date}
     * @memberof ForecastResponse
     */
    date: Date;
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    reasoning: string;
    /**
     *
     * @type {Array<SearchResponseDictItem>}
     * @memberof ForecastResponse
     */
    sources: Array<SearchResponseDictItem>;
    /**
     *
     * @type {Array<string>}
     * @memberof ForecastResponse
     */
    timeline: Array<string>;
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    oppositeRequest: string;
    /**
     *
     * @type {number}
     * @memberof ForecastResponse
     */
    confidence: number;
    /**
     *
     * @type {Choice}
     * @memberof ForecastResponse
     */
    choice: Choice;
    /**
     *
     * @type {number}
     * @memberof ForecastResponse
     */
    llmConfidence: number;
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    modelUsed: string;
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    likelihood: string;
    /**
     *
     * @type {number}
     * @memberof ForecastResponse
     */
    probability: number;
    /**
     *
     * @type {Array<WebSearchResult>}
     * @memberof ForecastResponse
     */
    webSearchResults: Array<WebSearchResult>;
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    summary: string;
    /**
     *
     * @type {Array<KeyPerson>}
     * @memberof ForecastResponse
     */
    keyPeople: Array<KeyPerson>;
    /**
     *
     * @type {Array<string>}
     * @memberof ForecastResponse
     */
    keyFacets: Array<string>;
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    reconciledInformation: string;
    /**
     *
     * @type {Array<string>}
     * @memberof ForecastResponse
     */
    candidateModels: Array<string>;
    /**
     *
     * @type {string}
     * @memberof ForecastResponse
     */
    uniqueInformation: string;
    /**
     *
     * @type {{ [key: string]: any; }}
     * @memberof ForecastResponse
     */
    expertInformation?: {
        [key: string]: any;
    };
}
/**
 * Check if a given object implements the ForecastResponse interface.
 */
export declare function instanceOfForecastResponse(value: object): value is ForecastResponse;
export declare function ForecastResponseFromJSON(json: any): ForecastResponse;
export declare function ForecastResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ForecastResponse;
export declare function ForecastResponseToJSON(json: any): ForecastResponse;
export declare function ForecastResponseToJSONTyped(value?: ForecastResponse | null, ignoreDiscriminator?: boolean): any;