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

Typescript SDK for AskNews API

/**
 * AskNews API
 * AskNews API [![status](https://status.asknews.app/api/badge/2/status?style=for-the-badge)](https://status.asknews.app/status/prod)
 *
 * The version of the OpenAPI document: 0.24.22
 * 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 { IntraClusterStatistics } from './IntraClusterStatistics';
import type { Article } from './Article';
import type { RedditPerspective } from './RedditPerspective';
import type { StoryUpdateDisplayImageUrlsInner } from './StoryUpdateDisplayImageUrlsInner';
import type { AsknewsApiSchemaV1StoriesGraphRelationships } from './AsknewsApiSchemaV1StoriesGraphRelationships';
import type { RedditThread } from './RedditThread';
import type { Entities } from './Entities';
/**
 *
 * @export
 * @interface StoryUpdate
 */
export interface StoryUpdate {
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    uuid: string;
    /**
     *
     * @type {Array<Article>}
     * @memberof StoryUpdate
     */
    clusterArticles: Array<Article>;
    /**
     *
     * @type {Array<Article>}
     * @memberof StoryUpdate
     */
    promptArticles: Array<Article>;
    /**
     *
     * @type {number}
     * @memberof StoryUpdate
     */
    nArticles: number;
    /**
     *
     * @type {Entities}
     * @memberof StoryUpdate
     */
    entities: Entities;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    headline: string;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    story: string;
    /**
     *
     * @type {number}
     * @memberof StoryUpdate
     */
    storyUpdateTs: number;
    /**
     *
     * @type {{ [key: string]: number; }}
     * @memberof StoryUpdate
     */
    sourcesUrls: {
        [key: string]: number;
    };
    /**
     *
     * @type {{ [key: string]: number; }}
     * @memberof StoryUpdate
     */
    languagesPct: {
        [key: string]: number;
    };
    /**
     *
     * @type {{ [key: string]: number; }}
     * @memberof StoryUpdate
     */
    countriesPct: {
        [key: string]: number;
    };
    /**
     *
     * @type {Array<string>}
     * @memberof StoryUpdate
     */
    keyTakeaways: Array<string>;
    /**
     *
     * @type {Array<string>}
     * @memberof StoryUpdate
     */
    contradictions: Array<string>;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    continent: string;
    /**
     *
     * @type {Array<string>}
     * @memberof StoryUpdate
     */
    people: Array<string>;
    /**
     *
     * @type {Array<string>}
     * @memberof StoryUpdate
     */
    locations: Array<string>;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    newInformation: string;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    imageUrl: string;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    urlSafeTitle: string;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    storyUuid: string;
    /**
     *
     * @type {Array<string>}
     * @memberof StoryUpdate
     */
    categories: Array<string>;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    imagePrompt: string;
    /**
     *
     * @type {RedditPerspective}
     * @memberof StoryUpdate
     */
    redditPerspective: RedditPerspective;
    /**
     *
     * @type {Array<RedditThread>}
     * @memberof StoryUpdate
     */
    redditThreads: Array<RedditThread>;
    /**
     *
     * @type {{ [key: string]: number; }}
     * @memberof StoryUpdate
     */
    languages: {
        [key: string]: number;
    };
    /**
     *
     * @type {Array<string>}
     * @memberof StoryUpdate
     */
    keywords: Array<string>;
    /**
     *
     * @type {IntraClusterStatistics}
     * @memberof StoryUpdate
     */
    intraClusterStatistics: IntraClusterStatistics;
    /**
     *
     * @type {{ [key: string]: any; }}
     * @memberof StoryUpdate
     */
    silhouetteScore: {
        [key: string]: any;
    };
    /**
     *
     * @type {Array<string>}
     * @memberof StoryUpdate
     */
    articleIds: Array<string>;
    /**
     *
     * @type {{ [key: string]: number; }}
     * @memberof StoryUpdate
     */
    countries: {
        [key: string]: number;
    };
    /**
     *
     * @type {Array<string>}
     * @memberof StoryUpdate
     */
    markdownCitations: Array<string>;
    /**
     *
     * @type {number}
     * @memberof StoryUpdate
     */
    confidence?: number;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    provocative?: StoryUpdateProvocativeEnum;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    reportingVoice?: string;
    /**
     *
     * @type {AsknewsApiSchemaV1StoriesGraphRelationships}
     * @memberof StoryUpdate
     */
    relationships: AsknewsApiSchemaV1StoriesGraphRelationships;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    mermaid: string;
    /**
     *
     * @type {string}
     * @memberof StoryUpdate
     */
    ccImageUrl: string;
    /**
     *
     * @type {Array<StoryUpdateDisplayImageUrlsInner>}
     * @memberof StoryUpdate
     */
    displayImageUrls: Array<StoryUpdateDisplayImageUrlsInner>;
    /**
     *
     * @type {number}
     * @memberof StoryUpdate
     */
    alignment?: number;
}
/**
 * @export
 */
export declare const StoryUpdateProvocativeEnum: {
    readonly Unknown: "unknown";
    readonly Low: "low";
    readonly Medium: "medium";
    readonly High: "high";
};
export type StoryUpdateProvocativeEnum = typeof StoryUpdateProvocativeEnum[keyof typeof StoryUpdateProvocativeEnum];
/**
 * Check if a given object implements the StoryUpdate interface.
 */
export declare function instanceOfStoryUpdate(value: object): value is StoryUpdate;
export declare function StoryUpdateFromJSON(json: any): StoryUpdate;
export declare function StoryUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): StoryUpdate;
export declare function StoryUpdateToJSON(json: any): StoryUpdate;
export declare function StoryUpdateToJSONTyped(value?: StoryUpdate | null, ignoreDiscriminator?: boolean): any;