docs: fix HITL interrupt schema typos (args and camelCase for JS)#2927
Open
Ezzat Esam (EzzatEsam) wants to merge 2 commits intolangchain-ai:mainfrom
Open
docs: fix HITL interrupt schema typos (args and camelCase for JS)#2927Ezzat Esam (EzzatEsam) wants to merge 2 commits intolangchain-ai:mainfrom
args and camelCase for JS)#2927Ezzat Esam (EzzatEsam) wants to merge 2 commits intolangchain-ai:mainfrom
Conversation
args and camelCase for JS)
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.
Overview
This PR corrects significant discrepancies in the Human-in-the-Loop (HITL) documentation for both Python and JavaScript.
argumentstoargswithin the tool request objects.__interrupt__object. The documentation incorrectly used snake_case (Python-style). The actual SDK output uses camelCase.Type of change
Type: Fix typo
Related issues/PRs
N/A
Checklist
docs devsrc/docs.jsonif neededAdditional notes
The documentation was updated to reflect the actual runtime output of the
__interrupt__state.Key Changes:
arguments→args.arguments→args.action_requests→actionRequests,review_configs→reviewConfigs,action_name→actionName, andallowed_decisions→allowedDecisions.I verified these changes by running the replication scripts provided below.
Python Replication Code
JavaScript/TypeScript Replication Code