API Reference

• ares package
  • Subpackages
    • ares.connectors package
      • Subpackages
      • Submodules
      • ares.connectors.connector module
      • ares.connectors.guarded_connector module
      • ares.connectors.huggingface module
      • ares.connectors.restful_connector module
      • ares.connectors.watsonx_agent_connector module
      • ares.connectors.watsonx_connector module
      • ares.connectors.watsonx_rest_connector module
      • Module contents
    • ares.evals package
      • Subpackages
      • Submodules
      • ares.evals.attack_eval module
      • ares.evals.huggingface_eval module
      • ares.evals.keyword_eval module
      • ares.evals.llm_eval module
      • Module contents
    • ares.goals package
      • Submodules
      • ares.goals.attack_goal module
      • ares.goals.generic_attack_goal module
      • Module contents
    • ares.strategies package
      • Submodules
      • ares.strategies.attack_strategy module
      • ares.strategies.direct_requests module
      • Module contents
  • Submodules
  • ares.cli module
    • evaluate()
    • install_plugin()
    • main()
    • show_report()
  • ares.dashboard module
  • ares.exception module
    • AresException
  • ares.logging_config module
  • ares.redteam module
    • RedTeamConfig
      • RedTeamConfig.evaluation
      • RedTeamConfig.goal
      • RedTeamConfig.strategy
      • RedTeamConfig.user_config
    • RedTeamer
      • RedTeamer.add_evaluation_input_path()
      • RedTeamer.base_tmp_dir
      • RedTeamer.clean_temp()
      • RedTeamer.config
      • RedTeamer.create_redteamer_config()
      • RedTeamer.dashboard()
      • RedTeamer.evaluate()
      • RedTeamer.goal()
      • RedTeamer.init_strategy()
      • RedTeamer.input_guardrail_name
      • RedTeamer.load_external_connectors()
      • RedTeamer.metrics
      • RedTeamer.output_guardrail_name
      • RedTeamer.redteam()
      • RedTeamer.report()
      • RedTeamer.strategy()
      • RedTeamer.target()
      • RedTeamer.target_connector
      • RedTeamer.tmp_files_manager
    • setup_connector()
  • ares.show module
    • ColorCodes
      • ColorCodes.core
      • ColorCodes.external
      • ColorCodes.not_found
    • connectors()
    • evals()
    • goals()
    • modules()
    • print_config()
    • show_module()
    • strategies()
  • ares.utils module
    • ConnectorResponse
      • ConnectorResponse.error
      • ConnectorResponse.error_message
      • ConnectorResponse.label
      • ConnectorResponse.other
      • ConnectorResponse.response
      • ConnectorResponse.status
      • ConnectorResponse.tool_calls
    • Plugin
      • Plugin.find_spec()
      • Plugin.load()
      • Plugin.module_checker()
    • Status
      • Status.ERROR
      • Status.SUCCESS
    • desearialize_responses()
    • df_to_rich_table()
    • dict_contains()
    • extract_intent_config()
    • extract_strategy_from_config()
    • find_connector()
    • find_external()
    • generate_filename_with_timestamp()
    • get_external_templates()
    • log_dict()
    • log_table()
    • nested_update()
    • parse_config()
    • parse_connectors()
    • populate_connectors()
    • print_items()
    • save_file()
    • serialize_responses()
  • Module contents