docs: document poly chat --sip-header on the ADK CLI reference - #595
Open
polyai-moaed wants to merge 1 commit into
Open
docs: document poly chat --sip-header on the ADK CLI reference#595polyai-moaed wants to merge 1 commit into
polyai-moaed wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Ports the
poly chat --sip-headerdocumentation from the ADK repo across to the Mintlify ADK tab, so the option is documented on docs.poly.ai and not only on the MkDocs site.--sip-header NAME=VALUElets a developer simulate SIP headers when starting a chat conversation, which exercises agent behaviour that readsconv.sip_headerswithout arranging a real SIP call.Dependency
Documents the option added in polyai/adk#256, which is open (all checks green). That PR in turn depends on PolyAI-LDN/poly_core#44668 for the chat API to accept the headers. Worth holding this until adk#256 merges so the docs do not describe an unreleased flag.
Changes
adk/reference/cli.mdxpoly chatexamples block: two--sip-headerinvocations, single and repeated.#### Simulating SIP headerssubsection underpoly chat, covering theNAME=VALUEform, repeating the flag for multiple headers, exposure to project functions viaconv.sip_headers, and the two limits (it does not create a SIP call or reproduce carrier behaviour, and headers cannot be changed when resuming a conversation).poly chatflags summary table: a--sip-header NAME=VALUErow.Wording is carried over from the upstream
docs/docs/reference/cli.mdso the two sites stay in step. Nodocs.jsonchange is needed,adk/reference/cliis already in the nav.Verification
mint validate: build validation passed.mint broken-links: 3 broken links found, all pre-existing and all the same/managed-topics/how-to-setup-action/handofftarget inintegrations/chat/amazon-connect.mdx,nice-cxone.mdx, andwebex.mdx. None are in the file this PR touches.Notes
.migration/convert.py. A fullrm -rf adkregeneration would revert the hand edits onadk/index.mdxfrom docs: wide mode and linked recommended path on ADK overview #581 (mode: "wide") and docs: redesign home landing page + ADK GitHub link #586 (the "View the ADK on GitHub" card), since neither exists in the MkDocs source. Worth folding those intoconvert.pybefore anyone runs a full resync.poly audio-cache(polyai/adk#246, merged 4 Aug) is documented upstream with 7 subcommands and is still absent fromadk/reference/cli.mdx.