chat • AI Agent SDK

chat: Chat with the agent.

chat

Method

</div>

This is a method of the Agent class in the agent module.

Chat with the agent.

Signature

python
def chat(prompt: Any, temperature: Any, tools: Any, output_json: Any, output_pydantic: Any, reasoning_steps: Any, stream: Any, task_name: Any, task_description: Any, task_id: Any, config: Any, force_retrieval: Any, skip_retrieval: Any, attachments: Any, tool_choice: Any) -> Any

Parameters

ParamField Any

Text query that WILL be stored in chat_history

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

No description available.

ParamField Any

Optional list of image/file paths that are ephemeral (used for THIS turn only, NEVER stored in history).

ParamField Any

Optional tool choice mode (‘auto’, ‘required’, ‘none’). ‘required’ forces the LLM to call a tool before responding. …other args…

Returns

ResponseField Any

The result of the operation.

Uses

  • get_context_emitter
  • _trace_emitter.agent_start
  • _trace_emitter.agent_end

Used By

Source

View on GitHub

praisonaiagents/agent/agent.py at line 4908


Related Documentation