Simulation response models

The 20 response models returned by the simulation resources of the Future AGI Python and TypeScript SDKs, with every field and its type.

The models returned by client.agents, client.simulation, importable from fi.platform.models (Python) and @future-agi/sdk/platform/models (TypeScript). Types are language-neutral: string[] is a Python list[str] and a TypeScript string[], and a type named after another model links to that model. Parsing is tolerant by default: a response that leaves a field out or adds one never breaks a call. In Python, Client(strict_responses=True) rejects a response that misses a field the contract requires (see the overview); TypeScript has no strict mode.

Models

ModelFields
AgentDefinitionCreateResponsemessage: string, agent: AgentDefinitionResponse
AgentDefinitionDetailResponseid: string, agent_name: string, agent_type: string, contact_number: string, inbound: boolean, target_speaks_first: boolean, description: string, assistant_id: string, provider: string, language: string, languages: string[], authentication_method: string, websocket_url: string, websocket_headers: any, workspace: string, knowledge_base: string, organization: string, api_key: any, observability_provider: string, created_at: string, updated_at: string, model: string, model_details: any, livekit_url: any, livekit_api_key: any, livekit_agent_name: any, livekit_config_json: any, livekit_max_concurrency: any, versions: any, active_version: any, version_count: integer, agent_kind: string, source: string, environment_count: integer, observability_enabled: boolean
AgentDefinitionEditResponsemessage: string, agent: AgentDefinitionResponse
AgentDefinitionListResponseid: string, agent_name: string, agent_type: string, contact_number: string, inbound: boolean, target_speaks_first: boolean, description: string, assistant_id: string, provider: string, language: string, languages: string[], websocket_url: string, websocket_headers: any, workspace: string, knowledge_base: string, organization: string, created_at: string, updated_at: string, latest_version: any, latest_version_id: any, model_details: any, model: string, agent_kind: string, source: string, version_count: integer, environment_count: integer, environments: RunEnvironmentRef[]
AgentDefinitionResponseid: string, agent_name: string, agent_type: string, contact_number: string, inbound: boolean, target_speaks_first: boolean, description: string, assistant_id: string, provider: string, language: string, languages: string[], authentication_method: string, websocket_url: string, websocket_headers: any, workspace: string, knowledge_base: string, organization: string, api_key: any, observability_provider: string, created_at: string, updated_at: string, model: string, model_details: any, livekit_url: any, livekit_api_key: any, livekit_agent_name: any, livekit_config_json: any, livekit_max_concurrency: any
AgentVersionCreateResponsemessage: string, version: AgentVersionResponse
AgentVersionResponseid: string, version_number: integer, version_name: string, version_name_display: any, status: string, status_display: string, score: string, test_count: integer, pass_rate: string, description: string, commit_message: string, release_notes: string, agent_definition: string, organization: string, configuration_snapshot: any, is_active: any, is_latest: any, agent_kind: string, api_key: string, created_at: string, updated_at: string
CallExecutionid: string, phone_number: string, service_provider_call_id: string, status: string, started_at: string, completed_at: string, duration_seconds: integer, recording_url: string, cost_cents: integer, call_metadata: any, error_message: string, scenario_name: string, transcripts: any, created_at: string, updated_at: string, provider_call_data: any, stereo_recording_url: string, ended_reason: string, stt_cost_cents: integer, llm_cost_cents: integer, tts_cost_cents: integer, overall_score: number, response_time_ms: integer, response_time_seconds: any, assistant_id: string, customer_number: string, call_type: string, ended_at: string, analysis_data: any, evaluation_data: any, message_count: integer, transcript_available: boolean, recording_available: boolean, eval_outputs: any, error_localizer_tasks: CallExecutionErrorLocalizerTask[], call_summary: string, agent_version: string, customer_cost_cents: integer, system_metrics: any, cost_breakdown: any, customer_call_id: string, simulation_call_type: string, processing_skipped: any, processing_skip_reason: any
CallExecutionErrorLocalizerTasktask_id: string, eval_config_id: string, status: string, eval_result: any, eval_explanation: string, input_data: any, input_keys: string[], input_types: any, rule_prompt: string, error_analysis: any, selected_input_key: string, error_message: string, created_at: string, updated_at: string
DatasetColumnConfigEntryname: string, type: string
RunEnvironmentRefid: string, name: string
RunTestExecutionResponsemessage: string, execution_id: string, run_test_id: string, status: string, total_scenarios: integer, total_calls: integer, scenario_ids: string[]
RunTestResponseid: string, name: string, description: any, agent_definition: string, agent_version: any, agent_definition_detail: any, source_type: string, source_type_display: string, prompt_template: string, prompt_template_detail: any, prompt_version: string, prompt_version_detail: any, scenarios: string[], scenarios_detail: any[], dataset_row_ids: string[], simulator_agent: string, simulator_agent_detail: any, simulate_eval_configs: string[], simulate_eval_configs_detail: SimulateEvalConfigResponse[], evals_detail: SimulateEvalConfigResponse[], organization: string, enable_tool_evaluation: boolean, created_at: string, updated_at: string, last_run_at: string, deleted: boolean, deleted_at: string
ScenarioDetailResponseid: string, name: string, description: string, source: string, scenario_type: string, dataset_id: string, organization: string, dataset: string, created_at: string, updated_at: string, deleted: boolean, deleted_at: string, status: string, agent_type: string, graph: any, prompts: ScenarioPromptItem[], dataset_rows: integer, dataset_column_config: any
ScenarioEditResponsemessage: string, scenario: ScenarioResponse
ScenarioPromptItemrole: string, content: string
ScenarioResponseid: string, name: string, description: string, source: string, scenario_type: string, scenario_type_display: string, source_type: string, source_type_display: string, organization: string, dataset: string, dataset_rows: any, dataset_column_config: any, graph: any, agent: any, prompt_template: string, prompt_template_detail: any, prompt_version: string, prompt_version_detail: any, created_at: string, updated_at: string, deleted: boolean, status: string, deleted_at: string, agent_type: any
SimulateEvalConfigResponseid: string, name: string, config: any, mapping: any, filters: object[], error_localizer: boolean, model: string, status: string, eval_group: string, template_id: string, eval_type: string, regradable: boolean, editable: boolean
TestExecutionid: string, run_test: string, run_test_name: string, agent_definition_name: string, status: string, error_reason: string, started_at: string, completed_at: string, total_scenarios: integer, total_calls: integer, completed_calls: integer, failed_calls: integer, execution_metadata: any, duration_seconds: any, success_rate: any, calls: CallExecution[], created_at: string, scenario_ids: any, simulator_agent_name: string, simulator_agent_id: string, agent_definition_used_name: string, agent_definition_used_id: string, calls_attempted: any, calls_connected_percentage: any
TestExecutionAnalyticsfail_rate_over_test_runs: any, evaluation_categories_over_test_runs: any, metadata: any
Was this page helpful?

Questions & Discussion