Skip to content

docs: document poly chat --sip-header on the ADK CLI reference #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
polyai-moaed wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document poly chat --sip-header on the ADK CLI reference #595

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions adk/reference/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,8 @@ Examples:
poly chat
poly chat --environment live
poly chat --channel webchat
poly chat --sip-header X-Customer-ID=12345
poly chat --sip-header X-Customer-ID=12345 --sip-header X-Language=en-GB
poly chat --metadata
poly chat --lang fr-FR
poly chat --input-lang en-US --output-lang fr-FR
Expand Down Expand Up @@ -490,6 +492,24 @@ Use language flags to specify the expected input and output language when chatti

`--input-lang` and `--output-lang` take precedence over `--lang` when both are supplied.

#### Simulating SIP headers

Use `--sip-header NAME=VALUE` to simulate a SIP header when starting a conversation.

Single header:

~~~bash
poly chat --sip-header X-Customer-ID=12345
~~~

Multiple headers are supported by repeating the flag:

~~~bash
poly chat --sip-header X-Customer-ID=12345 --sip-header X-Language=en-GB
~~~

The values are exposed to project functions through `conv.sip_headers`. This is for testing agent behaviour only; it does not create a SIP call or reproduce carrier-level SIP behaviour. SIP headers cannot be changed when resuming an existing conversation.

#### `poly chat` flags summary

| Flag | Description |
Expand All @@ -501,6 +521,7 @@ Use language flags to specify the expected input and output language when chatti
| `--json` | Emit a single JSON object when the session ends (see below). |
| `--environment` | Target environment. Choices: `branch`, `sandbox`, `pre-release`, `live`. Defaults to `branch`. `branch` chats against the last **pushed** state of your current branch (not local uncommitted changes); on main it falls back to `sandbox`. Use `--push` to push local changes before chatting. |
| `--channel` | Channel to use (e.g. `webchat`, `voice`). |
| `--sip-header NAME=VALUE` | Simulate a SIP header at conversation start (repeatable). |
| `--lang` | Set both input and output language. |
| `--input-lang` | Set input language only. |
| `--output-lang` | Set output language only. |
Expand Down