@emergentmethods/asknews-typescript-sdk
Version:
Typescript SDK for AskNews API
97 lines (96 loc) • 3.61 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';
/**
* Configuration for generating a written report when the alert triggers. If report is a list, the individual reports will be concatenated into one report in the order they are defined. If not specified, no report is generated. Use ReportRequest(identifier='deepnews', ...) for DeepNews reports.Use ReportRequest(...) or ReportRequest(identifier='legacy', ...) for legacy reports (DEPRECATED). Requests without identifier default to 'deepnews'. Only DeepNews reports can be used in list.
* @export
* @interface Report2
*/
export interface Report2 {
/**
*
* @type {string}
* @memberof Report2
*/
logoUrl?: string;
/**
*
* @type {boolean}
* @memberof Report2
*/
includeAppendix?: boolean;
/**
* Append 'Generated by AskNews AI' watermark
* @type {boolean}
* @memberof Report2
*/
asknewsWatermark?: boolean;
/**
*
* @type {string}
* @memberof Report2
*/
identifier?: Report2IdentifierEnum;
/**
* The model to use for the report. Defaults to claude-sonnet-4-6.
* @type {string}
* @memberof Report2
*/
model?: Report2ModelEnum;
/**
*
* @type {DeepNewsReportParams}
* @memberof Report2
*/
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 Report2
*/
prompt: string;
}
/**
* @export
*/
export declare const Report2IdentifierEnum: {
readonly Deepnews: "deepnews";
};
export type Report2IdentifierEnum = typeof Report2IdentifierEnum[keyof typeof Report2IdentifierEnum];
/**
* @export
*/
export declare const Report2ModelEnum: {
readonly Gpt5: "gpt-5";
readonly Gpt4o: "gpt-4o";
readonly Gpt4120250414: "gpt-4.1-2025-04-14";
readonly Gpt41Mini20250414: "gpt-4.1-mini-2025-04-14";
readonly Gpt4oMini: "gpt-4o-mini";
readonly O3Mini: "o3-mini";
readonly Claude35SonnetLatest: "claude-3-5-sonnet-latest";
readonly ClaudeSonnet420250514: "claude-sonnet-4-20250514";
readonly ClaudeSonnet4520250929: "claude-sonnet-4-5-20250929";
readonly ClaudeOpus4520251101: "claude-opus-4-5-20251101";
readonly ClaudeOpus46: "claude-opus-4-6";
readonly ClaudeSonnet46: "claude-sonnet-4-6";
readonly MetaLlamaMetaLlama31405BInstruct: "meta-llama/Meta-Llama-3.1-405B-Instruct";
readonly MetaLlamaMetaLlama3370BInstruct: "meta-llama/Meta-Llama-3.3-70B-Instruct";
};
export type Report2ModelEnum = typeof Report2ModelEnum[keyof typeof Report2ModelEnum];
/**
* Check if a given object implements the Report2 interface.
*/
export declare function instanceOfReport2(value: object): value is Report2;
export declare function Report2FromJSON(json: any): Report2;
export declare function Report2FromJSONTyped(json: any, ignoreDiscriminator: boolean): Report2;
export declare function Report2ToJSON(json: any): Report2;
export declare function Report2ToJSONTyped(value?: Report2 | null, ignoreDiscriminator?: boolean): any;