docs: add transcriptType and turnId fields to WebSocket message docs#978
Open
dhruva-reddy wants to merge 1 commit intomainfrom
Open
docs: add transcriptType and turnId fields to WebSocket message docs#978dhruva-reddy wants to merge 1 commit intomainfrom
dhruva-reddy wants to merge 1 commit intomainfrom
Conversation
Document three new optional fields from VapiAI/vapi#10548: - transcriptType (partial|final) on transcriber-response messages - turnId on model-output and user-interrupted messages Made-with: Cursor
Contributor
|
🌿 Preview your docs: https://vapi-preview-a084d137-8dba-42f0-a172-9ea922955212.docs.buildwithfern.com |
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.
Description
fern/customization/custom-transcriber.mdxto document the new optionaltranscriptTypefield ("partial"|"final") ontranscriber-responsemessages, enabling custom STT servers to send progressive transcription updates (from VapiAI/vapi#10548)transcriptType: "final"to all JSON examples and the server.js code example in the custom transcriber guidefern/server-url/events.mdxto document the new optionalturnIdfield onmodel-outputmessages (groups tokens from the same LLM response) anduser-interruptedmessages (identifies the interrupted turn for token discarding)Testing Steps
fern check-- passes with 0 errors