@emergentmethods/asknews-typescript-sdk
Version:
Typescript SDK for AskNews API
73 lines (72 loc) • 2.52 kB
TypeScript
/**
* AskNews API
* AskNews API [](https://status.asknews.app/status/prod)
*
* The version of the OpenAPI document: 0.24.66
* 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 { DeepNewsReportParams } from './DeepNewsReportParams';
/**
* DeepNews report configuration.
*
* Uses DeepNews deep research capabilities for information retrieval and report generation.
* @export
* @interface DeepNewsReportRequest
*/
export interface DeepNewsReportRequest {
/**
*
* @type {string}
* @memberof DeepNewsReportRequest
*/
logoUrl?: string | null;
/**
*
* @type {boolean}
* @memberof DeepNewsReportRequest
*/
includeAppendix?: boolean | null;
/**
* Append 'Generated by AskNews AI' watermark
* @type {boolean}
* @memberof DeepNewsReportRequest
*/
asknewsWatermark?: boolean;
/**
*
* @type {string}
* @memberof DeepNewsReportRequest
*/
identifier?: DeepNewsReportRequestIdentifierEnum;
/**
*
* @type {DeepNewsReportParams}
* @memberof DeepNewsReportRequest
*/
params?: DeepNewsReportParams;
/**
* The prompt to use for report generation instructions. This is similar to the alert query but can contain additional instructions on how to format the report.
* @type {string}
* @memberof DeepNewsReportRequest
*/
prompt: string;
}
/**
* @export
*/
export declare const DeepNewsReportRequestIdentifierEnum: {
readonly Deepnews: "deepnews";
};
export type DeepNewsReportRequestIdentifierEnum = typeof DeepNewsReportRequestIdentifierEnum[keyof typeof DeepNewsReportRequestIdentifierEnum];
/**
* Check if a given object implements the DeepNewsReportRequest interface.
*/
export declare function instanceOfDeepNewsReportRequest(value: object): value is DeepNewsReportRequest;
export declare function DeepNewsReportRequestFromJSON(json: any): DeepNewsReportRequest;
export declare function DeepNewsReportRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeepNewsReportRequest;
export declare function DeepNewsReportRequestToJSON(json: any): DeepNewsReportRequest;
export declare function DeepNewsReportRequestToJSONTyped(value?: DeepNewsReportRequest | null, ignoreDiscriminator?: boolean): any;