RetrieveUserProxyAgent

RetrieveUserProxyAgent(**kwargs)

(In preview) The Retrieval-Augmented User Proxy retrieves document chunks based on the embedding similarity, and sends them along with the question to the Retrieval-Augmented Assistant

Parameters:
NameDescription
**kwargs

Class Attributes

DEFAULT_CONFIG



DEFAULT_SUMMARY_METHOD



DEFAULT_SUMMARY_PROMPT



DEFAULT_USER_PROXY_AGENT_DESCRIPTIONS



MAX_CONSECUTIVE_AUTO_REPLY



Instance Attributes

chat_messages


A dictionary of conversations from agent to list of messages.

code_executor


The code executor used by this agent. Returns None if code execution is disabled.

description


Get the description of the agent.

function_map


Return the function map.

name


Get the name of the agent.

system_message


Return the system message.

tools


Get the agent’s tools (registered for LLM)

Note this is a copy of the tools list, use add_tool and remove_tool to modify the tools list.

use_docker


Bool value of whether to use docker to execute the code, or str value of the docker image name to use, or None when code execution is disabled.

Instance Methods

a_check_termination_and_human_reply

a_check_termination_and_human_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_execute_function

a_execute_function(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_generate_function_call_reply

a_generate_function_call_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_generate_init_message

a_generate_init_message(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_generate_oai_reply

a_generate_oai_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_generate_reply

a_generate_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_generate_tool_calls_reply

a_generate_tool_calls_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_get_human_input

a_get_human_input(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_initiate_chat

a_initiate_chat(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_initiate_chats

a_initiate_chats(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_receive

a_receive(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_run

a_run(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

a_send

a_send(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

can_execute_function

can_execute_function(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

chat_messages_for_summary

chat_messages_for_summary(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

check_termination_and_human_reply

check_termination_and_human_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

clear_history

clear_history(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

execute_code_blocks

execute_code_blocks(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

execute_function

execute_function(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

generate_code_execution_reply

generate_code_execution_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

generate_function_call_reply

generate_function_call_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

generate_init_message

generate_init_message(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

generate_oai_reply

generate_oai_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

generate_reply

generate_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

generate_tool_calls_reply

generate_tool_calls_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

get_actual_usage

get_actual_usage(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

get_chat_results

get_chat_results(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

get_context

get_context(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

get_human_input

get_human_input(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

get_max_tokens

get_max_tokens(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

get_total_usage

get_total_usage(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

initiate_chat

initiate_chat(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

initiate_chats

initiate_chats(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

last_message

last_message(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

max_consecutive_auto_reply

max_consecutive_auto_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

message_generator

message_generator(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

pop_context

pop_context(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

print_usage_summary(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

process_all_messages_before_reply

process_all_messages_before_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

process_last_received_message

process_last_received_message(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

receive

receive(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

register_for_execution

register_for_execution(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

register_for_llm

register_for_llm(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

register_function

register_function(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

register_hook

register_hook(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

register_model_client

register_model_client(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

register_nested_chats

register_nested_chats(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

register_reply

register_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

remove_tool_for_llm

remove_tool_for_llm(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

replace_reply_func

replace_reply_func(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

reset

reset(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

reset_consecutive_auto_reply_counter

reset_consecutive_auto_reply_counter(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

retrieve_docs

retrieve_docs(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

run

run(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

run_code

run_code(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

send

send(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

set_context

set_context(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

stop_reply_at_receive

stop_reply_at_receive(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

update_agent_state_before_reply

update_agent_state_before_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

update_context

update_context(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

update_function_signature

update_function_signature(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

update_max_consecutive_auto_reply

update_max_consecutive_auto_reply(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

update_system_message

update_system_message(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

update_tool_signature

update_tool_signature(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs