Update Quickstart - Understand and Search Forms to use OpenAIChatCompletion transformer
Migrate from OpenAIPrompt transformer to OpenAIChatCompletion since the former is not supported with newer versions of models
Related Issues/PRs
#xxx
What changes are proposed in this pull request?
Modified the sample in order to change from using the OpenAIPrompt for the OpenAIChatCompletion transformer.
How is this patch tested?
- [ ] I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.
- [x] I have followed the modified tutorial successfully
Does this PR change any dependencies?
- [x] No. You can skip this section.
- [ ] Yes. Make sure the dependencies are resolved correctly, and list changes here.
Does this PR add a new feature? If so, have you added samples on website?
- [x] No. You can skip this section.
- [ ] Yes. Make sure you have added samples following below steps.
- Find the corresponding markdown file for your new feature in
website/docs/documentationfolder. Make sure you choose the correct classestimators/transformersand namespace. - Follow the pattern in markdown file and add another section for your new API, including pyspark, scala (and .NET potentially) samples.
- Make sure the
DocTablepoints to correct API link. - Navigate to website folder, and run
yarn run startto make sure the website renders correctly. - Don't forget to add
<!--pytest-codeblocks:cont-->before each python code blocks to enable auto-tests for python samples. - Make sure the
WebsiteSamplesTestsjob pass in the pipeline.
Acrolinx Scorecards
A minimum total score of 80 is required.
Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain customer trust in overall content quality.
| Article | Total score (Required: 80) |
Words + phrases (Brand, terms) |
Correctness (Spelling, grammar) |
Clarity (Readability) |
|---|---|---|---|---|
| :white_check_mark: website/versioned_docs/version-1.0.4/Explore Algorithms/OpenAI/Quickstart - Understand and Search Forms.md | 76 | 100 | 100 | 71 |
More information about Acrolinx
@jdocampo hey thanks for this, though we just lit up prompt template support for gpt 4, perhaps we can just change the model name to gpt4 in this demo