julep icon indicating copy to clipboard operation
julep copied to clipboard

Remove 'n' parameter from responses

Open creatorrr opened this issue 6 months ago • 2 comments
trafficstars

User description

Summary

  • remove deprecated n field from CreateResponse
  • update docs to reflect single-choice responses
  • mention change in changelog

Testing

  • scripts/generate_openapi_code.sh (failed: invalid TypeSpec compiler setup)
  • uvx poe lint (failed: failed to fetch poe)

PR Type

enhancement, documentation


Description

  • Removed deprecated n parameter from Responses API.

  • Updated documentation to reflect single-choice responses.

  • Updated changelog to mention removal of n parameter.


Changes walkthrough 📝

Relevant files
Enhancement
models.tsp
Remove `n` parameter from CreateResponse model                     

typespec/responses/models.tsp

  • Removed the n parameter from the CreateResponse model.
  • Ensured API reflects single-response behavior.
  • +0/-1     
    Documentation
    concepts.mdx
    Update docs to remove `n` and clarify single response       

    documentation/responses/concepts.mdx

  • Updated configuration options to remove n parameter.
  • Clarified that API always returns a single response.
  • Removed n from options table.
  • +1/-3     
    CHANGELOG.md
    Add changelog entry for `n` parameter removal                       

    CHANGELOG.md

  • Added entry noting removal of n parameter from Responses API.
  • Clarified that requests now return a single choice.
  • +1/-0     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.

  • [!IMPORTANT] Remove deprecated n parameter from CreateResponse and update documentation for single-choice responses.

    • Behavior:
      • Remove deprecated n parameter from CreateResponse in models.tsp.
      • Update concepts.mdx to reflect single-choice responses, removing mention of n parameter.
    • Documentation:
      • Update CHANGELOG.md to mention removal of n parameter and single-choice response behavior.

    This description was created by Ellipsis for db957aff3330a89fdb67835ac31b362a534435be. You can customize this summary. It will automatically update as commits are pushed.

    creatorrr avatar May 20 '25 12:05 creatorrr

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Inconsistent Removal

    The PR removes the 'n' parameter from CreateResponse model but keeps the 'stop' parameter which was also removed from the documentation table. This inconsistency should be verified.

    stop?: string | string[];
    presence_penalty?: float;
    

    PR Code Suggestions ✨

    No code suggestions found for the PR.