Skip to content
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

docs(patching): introduce new patching methods and modes, update documentation #431

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

jxnl
Copy link
Collaborator

@jxnl jxnl commented Feb 12, 2024

Ellipsis 🚀 This PR description was created by Ellipsis for commit 888d695.

Summary:

This PR updates the OpenAI client patching documentation, introducing two patching methods, five patching modes, and three new keywords for backwards compatibility.

Key points:

  • Updated documentation for patching the OpenAI client.
  • Introduced two ways to patch: the client itself or a specific function.
  • Introduced five modes for patching: Function Calling, Tool Calling, JSON Mode, Markdown JSON Mode, and JSON Schema Mode.
  • Provided examples for each patching mode.
  • Introduced three new keywords for backwards compatibility: response_model, max_retries, and validation_context.

Generated with ❤️ by ellipsis.dev

@ellipsis-dev ellipsis-dev bot changed the title ... feat(OpenAI client): introduce new patching methods and modes, update documentation Feb 12, 2024
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Reviewed entire PR up to commit 888d695

Reviewed 128 lines of code across 1 files in 34 second(s).

See details
  • Skipped files: 0 (please contact us to request support for these files)
  • Confidence threshold: 85%
  • Drafted 1 additional comments.
  • Workflow ID: wflow_amEZfNKsVsPCgvDo
View 1 draft comments

These comments were drafted by Ellipsis, but were filtered out of the final review. They're included here so you can see our internal thought process and help you configure your ellipsis.yaml.

Drafted 1 additional comments

Comment at docs/concepts/patching.md:44

The section 'Patching Modes' is repeated in the document. Please remove the duplicate section.


Something look wrong? You can customize Ellipsis by editing the ellipsis.yaml for this repository.

Generated with ❤️ by ellipsis.dev

@jxnl jxnl changed the title feat(OpenAI client): introduce new patching methods and modes, update documentation docs(patching): introduce new patching methods and modes, update documentation Feb 12, 2024
@jxnl jxnl merged commit 56e69d4 into main Feb 12, 2024
12 of 13 checks passed
@jxnl jxnl deleted the patching-openai-client-docs branch February 12, 2024 14:43
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.

1 participant