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

Typescript SDK for AskNews API

/**
 * AskNews API
 * AskNews API
 *
 * The version of the OpenAPI document: 0.21.1
 * 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 { User } from './User';
import type { CreateDeepNewsRequestMessage } from './CreateDeepNewsRequestMessage';
import type { Stop } from './Stop';
import type { FilterParams1 } from './FilterParams1';
import type { Sources1 } from './Sources1';
import type { ThreadId1 } from './ThreadId1';
/**
 *
 * @export
 * @interface CreateDeepNewsRequest
 */
export interface CreateDeepNewsRequest {
    [key: string]: any | any;
    /**
     *
     * @type {string}
     * @memberof CreateDeepNewsRequest
     */
    model?: string;
    /**
     *
     * @type {Array<CreateDeepNewsRequestMessage>}
     * @memberof CreateDeepNewsRequest
     */
    messages: Array<CreateDeepNewsRequestMessage>;
    /**
     *
     * @type {number}
     * @memberof CreateDeepNewsRequest
     */
    temperature?: number;
    /**
     *
     * @type {number}
     * @memberof CreateDeepNewsRequest
     */
    topP?: number;
    /**
     *
     * @type {number}
     * @memberof CreateDeepNewsRequest
     */
    n?: number;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    stream?: boolean;
    /**
     *
     * @type {Stop}
     * @memberof CreateDeepNewsRequest
     */
    stop?: Stop;
    /**
     *
     * @type {number}
     * @memberof CreateDeepNewsRequest
     */
    maxTokens?: number;
    /**
     *
     * @type {number}
     * @memberof CreateDeepNewsRequest
     */
    presencePenalty?: number;
    /**
     *
     * @type {number}
     * @memberof CreateDeepNewsRequest
     */
    frequencyPenalty?: number;
    /**
     *
     * @type {User}
     * @memberof CreateDeepNewsRequest
     */
    user?: User;
    /**
     *
     * @type {ThreadId1}
     * @memberof CreateDeepNewsRequest
     */
    threadId?: ThreadId1;
    /**
     *
     * @type {string}
     * @memberof CreateDeepNewsRequest
     */
    inlineCitations?: CreateDeepNewsRequestInlineCitationsEnum;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    appendReferences?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    journalistMode?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    asknewsWatermark?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    conversationalAwareness?: boolean;
    /**
     *
     * @type {FilterParams1}
     * @memberof CreateDeepNewsRequest
     */
    filterParams?: FilterParams1;
    /**
     *
     * @type {number}
     * @memberof CreateDeepNewsRequest
     */
    searchDepth?: number;
    /**
     *
     * @type {number}
     * @memberof CreateDeepNewsRequest
     */
    maxDepth?: number;
    /**
     *
     * @type {Sources1}
     * @memberof CreateDeepNewsRequest
     */
    sources?: Sources1;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    returnSources?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    includeCoordinates?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    includeEntities?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof CreateDeepNewsRequest
     */
    includeGraphs?: boolean;
}
/**
 * @export
 */
export declare const CreateDeepNewsRequestInlineCitationsEnum: {
    readonly Numbered: "numbered";
    readonly MarkdownLink: "markdown_link";
    readonly None: "none";
};
export type CreateDeepNewsRequestInlineCitationsEnum = typeof CreateDeepNewsRequestInlineCitationsEnum[keyof typeof CreateDeepNewsRequestInlineCitationsEnum];
/**
 * Check if a given object implements the CreateDeepNewsRequest interface.
 */
export declare function instanceOfCreateDeepNewsRequest(value: object): value is CreateDeepNewsRequest;
export declare function CreateDeepNewsRequestFromJSON(json: any): CreateDeepNewsRequest;
export declare function CreateDeepNewsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDeepNewsRequest;
export declare function CreateDeepNewsRequestToJSON(json: any): CreateDeepNewsRequest;
export declare function CreateDeepNewsRequestToJSONTyped(value?: CreateDeepNewsRequest | null, ignoreDiscriminator?: boolean): any;