DeepDocs: Docs updates triggered by e054c33 in main - #5
#5Open
deepdocsai-dev[bot] wants to merge 1 commit into
mainDeepDocs-eval/vocode-core:mainfrom
deepdocs-update/mainDeepDocs-eval/vocode-core:deepdocs-update/mainCopy head branch name to clipboard
Open
DeepDocs: Docs updates triggered by e054c33 in main#5deepdocsai-dev[bot] wants to merge 1 commit intomainDeepDocs-eval/vocode-core:mainfrom deepdocs-update/mainDeepDocs-eval/vocode-core:deepdocs-update/mainCopy head branch name to clipboard
deepdocsai-dev[bot] wants to merge 1 commit into
mainDeepDocs-eval/vocode-core:mainfrom
deepdocs-update/mainDeepDocs-eval/vocode-core:deepdocs-update/mainCopy head branch name to clipboard
Conversation
- docs/open-source/conversation-mechanics.mdx: StreamingConversation.__init__ parameter is speed_coefficient, not conversation_speed - docs/open-source/create-your-own-agent.mdx: The `respond` method signature is missing `conversation_id: str` parameter, is not marked as `async`, and return statement is missing the boolean value. The `generate_response` method signature is missing `conversation_id: str` and `bot_was_in_medias_res: bool = False` parameters, and should yield `GeneratedResponse` instead of simplified `Tuple[str, bool]`. All `RespondAgent.respond` implementations include `conversation_id`. - docs/open-source/language-support.mdx: Incorrect syntax in os.getenv (default= keyword arg invalid, must be positional); incorrect parameter name 'voice' instead of 'voice_name' for AzureSynthesizerConfig; incorrect use of 'model' parameter with language default value instead of 'language' parameter for DeepgramTranscriberConfig - docs/open-source/python-quickstart.mdx: `create_streaming_microphone_input_and_speaker_output` does not accept `use_blocking_speaker_output` parameter; it always uses `BlockingStreamingSpeakerOutput`. - docs/open-source/external-action.mdx: Response schema is missing the required `success: bool` field present in `ExternalActionResponse`. | `processing_mode` has no default value and is listed as required in class inputs, but doc implies optional by not listing default. - docs/open-source/synthesizer-reference.mdx: Parameter type for speed is Optional[float] not Optional[int] | Parameter type for temperature is Optional[float] not Optional[int] | Parameter experimental_streaming is bool (required) not Optional[bool] - docs/open-source/synthesizer.mdx: voice_name is str (required) not Optional[str] with required=false - docs/open-source/transcriber-reference.mdx: DeepgramTranscriberConfig.model is Optional[str] with no default value specified | DeepgramTranscriberConfig.version is Optional[str] with no default value specified | GoogleTranscriberConfig.language_code is str (required) with no default value | AssemblyAITranscriberConfig.buffer_size_seconds is float (required) with no default value | WhisperCPPTranscriberConfig.buffer_size_seconds is float (required) with no default value | AzureTranscriberConfig.language is str (required) with no default value | GladiaTranscriberConfig.buffer_size_seconds is float (required) with no default value - docs/open-source/langchain-agent-dep.mdx: TelephonyServer.__init__ does not accept a 'logger' parameter per the function signature | OutboundCall.__init__ requires 'telephony_config' parameter (no default) but it is missing; does not accept 'logger' parameter per the function signature - docs/open-source/using-synthesizers.mdx: Example code uses from_telephone_output_device but description incorrectly states from_output_device - docs/open-source/using-transcribers.mdx: Code imports PunctuationEndpointingConfig but uses DeepgramEndpointingConfig | Code imports PunctuationEndpointingConfig but uses DeepgramEndpointingConfig; from_input_device is on base TranscriberConfig
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.
Docs Scan Report
StreamingConversation.__init__in streaming_conversation.py]respondmethod signature is missingconversation_id: strparameter, is not marked asasync, and return statement is missing the boolean value. Thegenerate_responsemethod signature is missingconversation_id: strandbot_was_in_medias_res: bool = Falseparameters, and should yieldGeneratedResponseinstead of simplifiedTuple[str, bool]. AllRespondAgent.respondimplementations includeconversation_id. [Ref: methodRespondAgent.respondin base_agent.py, methodRespondAgent.generate_responsein base_agent.py]AzureSynthesizerConfigin synthesizer.py, classDeepgramTranscriberConfigin transcriber.py]create_streaming_microphone_input_and_speaker_outputdoes not acceptuse_blocking_speaker_outputparameter; it always usesBlockingStreamingSpeakerOutput. [Ref: functioncreate_streaming_microphone_input_and_speaker_outputin helpers.py]success: boolfield present inExternalActionResponse. [Ref: methodExecuteExternalAction.send_external_action_requestin execute_external_action.py]• Line 20
processing_modehas no default value and is listed as required in class inputs, but doc implies optional by not listing default. [Ref: classExecuteExternalActionVocodeActionConfigin execute_external_action.py]PlayHtSynthesizerConfigin synthesizer.py]• Lines 130:132 Parameter type for temperature is Optional[float] not Optional[int] [Ref: class
PlayHtSynthesizerConfigin synthesizer.py]• Lines 76:78 Parameter experimental_streaming is bool (required) not Optional[bool] [Ref: class
ElevenLabsSynthesizerConfigin synthesizer.py]AzureSynthesizerConfigin synthesizer.py]DeepgramTranscriberConfigin transcriber.py]• Line 58 DeepgramTranscriberConfig.version is Optional[str] with no default value specified [Ref: class
DeepgramTranscriberConfigin transcriber.py]• Line 73 GoogleTranscriberConfig.language_code is str (required) with no default value [Ref: class
GoogleTranscriberConfigin transcriber.py]• Line 80 AssemblyAITranscriberConfig.buffer_size_seconds is float (required) with no default value [Ref: class
AssemblyAITranscriberConfigin transcriber.py]• Line 91 WhisperCPPTranscriberConfig.buffer_size_seconds is float (required) with no default value [Ref: class
WhisperCPPTranscriberConfigin transcriber.py]• Line 106 AzureTranscriberConfig.language is str (required) with no default value [Ref: class
AzureTranscriberConfigin transcriber.py]• Line 117 GladiaTranscriberConfig.buffer_size_seconds is float (required) with no default value [Ref: class
GladiaTranscriberConfigin transcriber.py]TelephonyServer.__init__in base.py]• Lines 176:186 OutboundCall.init requires 'telephony_config' parameter (no default) but it is missing; does not accept 'logger' parameter per the function signature [Ref: method
OutboundCall.__init__in outbound_call.py]SynthesizerConfig.from_telephone_output_devicein synthesizer.py]TranscriberConfig.from_telephone_input_devicein transcriber.py]• Lines 47:59 Code imports PunctuationEndpointingConfig but uses DeepgramEndpointingConfig; from_input_device is on base TranscriberConfig [Ref: method
TranscriberConfig.from_input_devicein transcriber.py]Credits
Used: 1
Remaining: 99/100