| messages |
\AskNews\Model\CreateDeepNewsRequestMessage[] |
The messages to send to DeepNews. Each message should have 'role' and 'content' keys. Use this to specify what research/monitoring task DeepNews should perform. The 'content' for the final 'user' message should be your Alert query. |
|
| model |
\AskNews\Model\CreateDeepNewsRequestModel |
|
[optional] |
| filter_params |
\AskNews\Model\FilterParams1 |
|
[optional] |
| search_depth |
int |
The search depth for deep research. Higher values mean more thorough research. |
[optional] [default to 2] |
| max_depth |
int |
The maximum research depth allowed. |
[optional] [default to 6] |
| sources |
\AskNews\Model\Sources1 |
|
[optional] |
| inline_citations |
string |
How to format inline citations in the response. Defaults to: markdown_link. Available options: markdown_link, numbered, none |
[optional] [default to 'markdown_link'] |
| start_citation_number |
int |
Starting number for inline citations. Offsets fetched source citation keys. Useful if you are providing the agent outside sources with numbered citation keys. |
[optional] [default to 1] |
| return_sources |
bool |
Whether return a list of sources used by the agent. |
[optional] [default to true] |
| only_cited_sources |
bool |
Whether to return only of sources that are cited/referenced in the generated response content. |
[optional] [default to true] |
| append_references |
bool |
Whether to append a 'Cited Articles' section at the end of the response. |
[optional] [default to true] |
| journalist_mode |
bool |
Whether to use journalist mode for more factual reporting. |
[optional] [default to true] |
| conversational_awareness |
bool |
Whether to use conversational awareness. |
[optional] [default to true] |
| include_entities |
bool |
Whether to provide extracted entities to the agent. |
[optional] [default to true] |
| include_graphs |
bool |
Whether to provide knowledge graphs to the agent |
[optional] [default to false] |
| include_coordinates |
bool |
Whether to provide geo coordinates to the agent. |
[optional] [default to false] |
| asknews_watermark |
bool |
Append 'Generated by AskNews AI' watermark |
[optional] [default to true] |
| stream |
bool |
Whether to stream the response as server-sent events. |
[optional] [default to false] |
| stop |
\AskNews\Model\Stop1 |
|
[optional] |
| temperature |
float |
The temperature of the DeepNews agent model. Controls randomness in the output. Higher values (e.g., 1.0) make output more random, lower values (e.g., 0.1) make it more deterministic. |
[optional] [default to 0.9] |
| top_p |
float |
Nucleus sampling parameter. Only tokens with cumulative probability up to top_p are considered. |
[optional] [default to 1.0] |
| n |
int |
Number of completions to generate. |
[optional] [default to 1] |
| max_tokens |
int |
Maximum number of tokens to generate in the response. |
[optional] [default to 9999] |
| presence_penalty |
int |
Penalizes new tokens based on whether they appear in the text so far, encouraging new topics. |
[optional] [default to 0] |
| frequency_penalty |
int |
Penalizes new tokens based on their frequency in the text so far, reducing repetition. |
[optional] [default to 0] |
| user |
\AskNews\Model\User1 |
|
[optional] |
| thread_id |
\AskNews\Model\ThreadId1 |
|
[optional] |
| max_parallel_tool_calls |
int |
Maximum number of parallel tool calls (e.g., searches) the agent can make during generation. Higher values may speed up responses, but may reduce on-the-fly adaptivity. |
[optional] [default to 1] |
| engine |
string |
The engine to use for the DeepNews agent. 'v1' is deprecated while 'v1.5' is our next-generation research agent with access to more tools, better contextual understanding, and improved reasoning capabilities.'v1.5' streams thinking and tool use using tags <think> </think>, <tool_a> </tool_a> Meanwhile, 'v2.0' is the same underlying agent as 'v1.5', but the thinking and tool use chunks are typed content_block_delta's streamed between content_block_start and content_block_stop events, mimicking Anthropic's approach to streaming tool use/thinking events. |
[optional] [default to 'v1.5'] |
| enable_source_pruning |
bool |
Whether to enable source pruning, which removes sources that are deemed irrelevant to the final response. This can help reduce noise in the sources and improve the quality of the response, but may also remove some relevant sources if not used carefully. |
[optional] [default to false] |
| cutoff_datetime |
\AskNews\Model\CutoffDatetime |
|
[optional] |