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

structured output completion example #126

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

akshana-aravind
Copy link

@akshana-aravind akshana-aravind commented Oct 7, 2024

Purpose

  • Structured outputs allow you to enforce a specific JSON Schema definition when making an inference API call. This means you can dictate exactly what the output should look like, ensuring that it conforms to the structure you expect.
    This feature is particularly beneficial for scenarios where you need to call specific functions based on the output. By using structured outputs, you can be confident that the necessary parameters and formats are adhered to, facilitating smoother integration with your applications.

Does this introduce a breaking change?

[ ] Yes
[X] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[X] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

How to Test

  • Get the code
git clone https://github.com/akshana-aravind/azureopenai.git
cd azureopenai
git checkout main
npm install

Test the code

Run it as a normal colab Notebook in any  compatible environment or IDE i.e  VS code, pycharm etc. -

What to Check

Verify that the following are valid

  • Standard Azure OpenAI credentials are correct .

Other Information

@akshana-aravind
Copy link
Author

@microsoft-github-policy-service agree

@akshana-aravind
Copy link
Author

@colombod can I please get a review on this when you get a chance. Thanks.

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