Skip to content

fix(docs): correct response key from "generation" to "completion" in example code #1534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

LuizyHub
Copy link
Contributor

@LuizyHub LuizyHub commented Oct 14, 2024

Description

This PR corrects an error in the documentation for Spring AI's ChatClient example. The response key in the curl example was incorrectly labeled as "generation" instead of "completion", which better aligns with the API’s response format.

Changes

  • Updated the response example to reflect "completion" as the correct key.

Issue Reference

Fixes #1533 Documentation: Correct response key from "generation" to "completion" in example code

Checklist

  • Signed the Contributor License Agreement (CLA)
  • Rebased changes on the latest main branch and squashed commits
  • Reviewed and updated unit tests as needed (N/A for this documentation change)
  • Ran the build and confirmed that all tests pass

Thank you for reviewing this PR!

#1533

…example code

The example response in the documentation incorrectly uses "generation" as the response key. This commit updates it to "completion" to accurately reflect the API's actual response format.
@markpollack
Copy link
Member

thanks, merged in a39aadc

@markpollack markpollack added this to the 1.0.0-M4 milestone Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Correct response key from "generation" to "completion" in example code
2 participants