docs: add backend verification note for backend setup#118
Open
jao-o-garcia wants to merge 1 commit intoopenai:mainfrom
Open
docs: add backend verification note for backend setup#118jao-o-garcia wants to merge 1 commit intoopenai:mainfrom
jao-o-garcia wants to merge 1 commit intoopenai:mainfrom
Conversation
…for 'uv' and add a section for verifying backend functionality with a curl test.
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.
Backend verification note
This adds a
curltest to verify that the ChatKit server and its memory store are correctly configured before working on the frontend.I ran into this while trying to confirm my backend was functioning prior to UI development. The documentation does not clearly specify what payload should be sent to
/chatkit. Many AI suggestions recommended sending:However, this results in an Internal Server Error, which can misleadingly make it seem like the server or installation is broken.
I determined the required parameters by using one of the ChatKit customer-service examples and logging the actual request payload. Including this verification step should help developers quickly confirm that their backend and memory store are properly set up and avoid unnecessary debugging.
I've also added a chore where the document gives the developer the option to choose uv.