deepflow-voicespeed-cli 0.1.2__tar.gz → 0.1.4__tar.gz

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.
Files changed (18) hide show
  1. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/PKG-INFO +28 -1
  2. deepflow_voicespeed_cli-0.1.4/README.md +66 -0
  3. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/setup.cfg +1 -1
  4. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/src/deepflow_voicespeed_cli/__init__.py +1 -1
  5. deepflow_voicespeed_cli-0.1.4/src/deepflow_voicespeed_cli/__main__.py +3 -0
  6. deepflow_voicespeed_cli-0.1.4/src/deepflow_voicespeed_cli/cli.py +799 -0
  7. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/src/deepflow_voicespeed_cli/client.py +61 -0
  8. deepflow_voicespeed_cli-0.1.4/src/deepflow_voicespeed_cli/guide.py +132 -0
  9. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/src/deepflow_voicespeed_cli.egg-info/PKG-INFO +28 -1
  10. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/src/deepflow_voicespeed_cli.egg-info/SOURCES.txt +2 -0
  11. deepflow_voicespeed_cli-0.1.4/tests/test_cli.py +688 -0
  12. deepflow_voicespeed_cli-0.1.2/README.md +0 -39
  13. deepflow_voicespeed_cli-0.1.2/src/deepflow_voicespeed_cli/cli.py +0 -330
  14. deepflow_voicespeed_cli-0.1.2/tests/test_cli.py +0 -358
  15. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/pyproject.toml +0 -0
  16. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/src/deepflow_voicespeed_cli.egg-info/dependency_links.txt +0 -0
  17. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/src/deepflow_voicespeed_cli.egg-info/entry_points.txt +0 -0
  18. {deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/src/deepflow_voicespeed_cli.egg-info/top_level.txt +0 -0
{deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: deepflow-voicespeed-cli
3
- Version: 0.1.2
3
+ Version: 0.1.4
4
4
  Summary: Command line client for VoiceSpeed OpenAPI
5
5
  Home-page: https://github.com/DeepFlowAI/voicespeed
6
6
  License: Proprietary
@@ -27,6 +27,16 @@ export VOICESPEED_API_KEY=YOUR_API_KEY
27
27
 
28
28
  Both values can also be passed with `--base-url` and `--api-key`.
29
29
 
30
+ ## Learn the system from the CLI
31
+
32
+ ```bash
33
+ voicespeed guide # concepts, typical flow, scope per command, error codes
34
+ voicespeed <resource> --help
35
+ voicespeed models list # model ids for --voice-llm / --text-llm
36
+ ```
37
+
38
+ `voicespeed guide` works offline and needs no API key.
39
+
30
40
  ## Usage
31
41
 
32
42
  ```bash
@@ -35,15 +45,32 @@ voicespeed agents create --name "Support" --description "Demo agent"
35
45
  voicespeed agents update 1 --name "Support Pro"
36
46
  voicespeed agents disable 1
37
47
  voicespeed agents enable 1
48
+ voicespeed agents get 1
49
+ voicespeed agents search-settings 1
50
+ voicespeed models list
38
51
  voicespeed agents basic-settings 1
52
+ voicespeed agents update-basic-settings 1 --prompt "You are a support assistant."
53
+ voicespeed agents update-basic-settings 1 --prompt-file prompt.txt \
54
+ --opening-mode fixed_greeting --greeting "Hello, how can I help?"
55
+ voicespeed agents performance-settings 1
56
+ voicespeed agents update-performance-settings 1 --endpoint-silence-ms 800 \
57
+ --turn-detection-enabled --barge-sensitivity balanced
58
+ voicespeed agents update-performance-settings 1 --clear endpoint-silence-ms
59
+ voicespeed agents update-performance-settings 1 --clear-all
39
60
  voicespeed conversation run 1 --message "Hello" --mode text2text \
40
61
  --variables '{"customer_name":"Ada"}'
41
62
  voicespeed calls preset-variables 1 call_42 \
42
63
  --variables '{"customer_name":"Ada","order_no":"A1024"}'
43
64
  voicespeed realtime-sessions create 1 --external-id call_42 \
44
65
  --variables '{"customer_name":"Ada"}'
66
+ voicespeed sessions list 1 --session-id call_42
67
+ voicespeed sessions get 1 call_42
45
68
  ```
46
69
 
70
+ `agents update-basic-settings` changes only the fields passed on the command line. Use `--prompt-file`, `--runtime-context-file`, or `--greeting-file` for long text.
71
+
72
+ `agents update-performance-settings` (dialog rhythm) also changes only the passed knobs. `--clear FIELD` (repeatable) or `--clear-all` restores knobs to the FlowKit default. Reading with `performance-settings` works with a `chat` or `config` key; updating needs `config`.
73
+
47
74
  `--variables` is a JSON object of text values. It is optional on `conversation run` and `realtime-sessions create`. `calls preset-variables` stores values for a FlowKit call before it starts; the call id is the same value later sent as `session_id`.
48
75
 
49
76
  All successful commands print formatted JSON.
deepflow_voicespeed_cli-0.1.4/README.md ADDED
@@ -0,0 +1,66 @@
1
+ # deepflow-voicespeed-cli
2
+
3
+ Command line client for VoiceSpeed OpenAPI.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ pip install deepflow-voicespeed-cli
9
+ ```
10
+
11
+ ## Configure
12
+
13
+ ```bash
14
+ export VOICESPEED_BASE_URL=http://localhost:5002
15
+ export VOICESPEED_API_KEY=YOUR_API_KEY
16
+ ```
17
+
18
+ Both values can also be passed with `--base-url` and `--api-key`.
19
+
20
+ ## Learn the system from the CLI
21
+
22
+ ```bash
23
+ voicespeed guide # concepts, typical flow, scope per command, error codes
24
+ voicespeed <resource> --help
25
+ voicespeed models list # model ids for --voice-llm / --text-llm
26
+ ```
27
+
28
+ `voicespeed guide` works offline and needs no API key.
29
+
30
+ ## Usage
31
+
32
+ ```bash
33
+ voicespeed agents list --status enabled
34
+ voicespeed agents create --name "Support" --description "Demo agent"
35
+ voicespeed agents update 1 --name "Support Pro"
36
+ voicespeed agents disable 1
37
+ voicespeed agents enable 1
38
+ voicespeed agents get 1
39
+ voicespeed agents search-settings 1
40
+ voicespeed models list
41
+ voicespeed agents basic-settings 1
42
+ voicespeed agents update-basic-settings 1 --prompt "You are a support assistant."
43
+ voicespeed agents update-basic-settings 1 --prompt-file prompt.txt \
44
+ --opening-mode fixed_greeting --greeting "Hello, how can I help?"
45
+ voicespeed agents performance-settings 1
46
+ voicespeed agents update-performance-settings 1 --endpoint-silence-ms 800 \
47
+ --turn-detection-enabled --barge-sensitivity balanced
48
+ voicespeed agents update-performance-settings 1 --clear endpoint-silence-ms
49
+ voicespeed agents update-performance-settings 1 --clear-all
50
+ voicespeed conversation run 1 --message "Hello" --mode text2text \
51
+ --variables '{"customer_name":"Ada"}'
52
+ voicespeed calls preset-variables 1 call_42 \
53
+ --variables '{"customer_name":"Ada","order_no":"A1024"}'
54
+ voicespeed realtime-sessions create 1 --external-id call_42 \
55
+ --variables '{"customer_name":"Ada"}'
56
+ voicespeed sessions list 1 --session-id call_42
57
+ voicespeed sessions get 1 call_42
58
+ ```
59
+
60
+ `agents update-basic-settings` changes only the fields passed on the command line. Use `--prompt-file`, `--runtime-context-file`, or `--greeting-file` for long text.
61
+
62
+ `agents update-performance-settings` (dialog rhythm) also changes only the passed knobs. `--clear FIELD` (repeatable) or `--clear-all` restores knobs to the FlowKit default. Reading with `performance-settings` works with a `chat` or `config` key; updating needs `config`.
63
+
64
+ `--variables` is a JSON object of text values. It is optional on `conversation run` and `realtime-sessions create`. `calls preset-variables` stores values for a FlowKit call before it starts; the call id is the same value later sent as `session_id`.
65
+
66
+ All successful commands print formatted JSON.
{deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/setup.cfg RENAMED
@@ -1,6 +1,6 @@
1
1
  [metadata]
2
2
  name = deepflow-voicespeed-cli
3
- version = 0.1.2
3
+ version = 0.1.4
4
4
  description = Command line client for VoiceSpeed OpenAPI
5
5
  long_description = file: README.md
6
6
  long_description_content_type = text/markdown
{deepflow_voicespeed_cli-0.1.2 → deepflow_voicespeed_cli-0.1.4}/src/deepflow_voicespeed_cli/__init__.py RENAMED
@@ -1,3 +1,3 @@
1
1
  """VoiceSpeed OpenAPI command line client."""
2
2
 
3
- __version__ = "0.1.2"
3
+ __version__ = "0.1.4"
deepflow_voicespeed_cli-0.1.4/src/deepflow_voicespeed_cli/__main__.py ADDED
@@ -0,0 +1,3 @@
1
+ from .cli import main
2
+
3
+ raise SystemExit(main())