vent-hq 0.14.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -69,37 +69,46 @@ Run `vent-hq <command> --help` for command-specific options.
69
69
 
70
70
  ## What you get back
71
71
 
72
- Every `run` returns a single JSON object on stdout. Shape:
72
+ Every `run` places one call and returns a single JSON object on stdout. Shape:
73
73
 
74
74
  ```json
75
75
  {
76
- "run_id": "01J...",
77
- "status": "complete",
76
+ "run_id": "4ceb8e0a-...",
77
+ "status": "pass",
78
+ "total": 1,
78
79
  "calls": [
79
80
  {
80
81
  "name": "happy-path",
81
- "status": "complete",
82
- "duration_ms": 42180,
83
- "latency": { "p50_ms": 612, "p95_ms": 1180, "time_to_first_audio_ms": 540 },
82
+ "status": "completed",
83
+ "duration_ms": 75562,
84
84
  "transcript": [
85
- { "role": "agent", "text": "Hi, this is Acme Salon, how can I help?" },
85
+ { "role": "agent", "text": "Hi, thanks for calling Acme Salon. How can I help?" },
86
86
  { "role": "caller", "text": "Hey, I'd like to book a haircut for Friday." }
87
87
  ],
88
- "tool_calls": [{ "name": "check_availability", "args": {...}, "result": {...} }],
89
- "recording_url": "https://...",
90
- "call_metadata": { ... }
88
+ "latency": { "response_time_ms": 3154, "p50_response_time_ms": 2980, "max_response_time_ms": 4890, "first_response_time_ms": 4920 },
89
+ "tool_calls": {
90
+ "total": 1, "successful": 1, "failed": 0,
91
+ "observed": [{ "name": "check_availability", "arguments": { ... }, "result": { ... }, "successful": true }]
92
+ },
93
+ "component_latency": { "mean_stt_ms": 648, "mean_llm_ms": 1033, "mean_tts_ms": 321 },
94
+ "signal_quality": { "mean_snr_db": 31.2, "max_clipping_ratio": 0 },
95
+ "call_metadata": {
96
+ "platform": "vapi", "provider_call_id": "...", "recording_url": "https://...",
97
+ "cost": { "total_usd": 0.13, "breakdown": { "stt": 0.01, "llm": 0.03, "tts": 0.02, "transport": 0.02, "vapi": 0.05 } },
98
+ "provider_debug_urls": { "dashboard": "https://dashboard.vapi.ai/calls/..." }
99
+ }
91
100
  }
92
101
  ]
93
102
  }
94
103
  ```
95
104
 
96
- Verbose fields are gated behind `--verbose` to keep agent context lean.
105
+ `status` is `"error"` (with an `error` message) when Vent could not complete the call, and `end_note` explains an early hang-up.
97
106
 
98
107
  ## Platform notes
99
108
 
100
109
  - **Vapi, Retell, ElevenLabs** — hosted only. Set the API key + assistant/agent ID in `.env`.
101
110
  - **LiveKit** — works against local dev agents and LiveKit Cloud with the same config (different `LIVEKIT_URL`). Install [`@vent-hq/livekit`](https://www.npmjs.com/package/@vent-hq/livekit) (Node) or [`vent-livekit`](https://pypi.org/project/vent-livekit/) (Python) for tool-call and component-latency observability.
102
- - **Bland** — supports pathways (`bland_pathway_id`), personas (`persona_id`), or inline `task` prompts.
111
+ - **Bland** — supports pathways (`bland_pathway_id`) or inline `task` prompts, optionally with a persona (`persona_id`).
103
112
  - **Custom (WebSocket)** — point at a hosted endpoint with `agent_url`, or run a local agent with `start_command` + `agent_port`. Vent tunnels audio through a relay so your machine doesn't need a public IP.
104
113
 
105
114
  Platform credentials are encrypted at rest (AES-256-GCM) and never appear in chat logs or run payloads.
@@ -109,7 +118,7 @@ Platform credentials are encrypted at rest (AES-256-GCM) and never appear in cha
109
118
  - [Website](https://venthq.dev)
110
119
  - [Documentation](https://docs.vent.dev)
111
120
  - [Source on GitHub](https://github.com/vent-hq/vent)
112
- - [Changelog](https://github.com/vent-hq/vent/blob/main/packages/cli/CHANGELOG.md)
121
+ - [Changelog](https://github.com/vent-hq/vent/blob/main/packages/pub-cli/CHANGELOG.md)
113
122
  - [@vent_hq on X](https://x.com/vent_hq)
114
123
 
115
124
  ## License