bx-h commented 3 months ago

Summary

This PR updates the documentation to clearly differentiate between the usage of Chat and Completion models for Azure OpenAI and OpenAI services. It specifies the respective classes to be used with each model type and updates the code sample ranges for improved clarity and accuracy.

Changes

Separated Azure and OpenAI sections to outline specific instructions for each service.
Introduced AzureChatCompletion and AzureTextCompletion classes for Azure, specifying the code ranges for each.
Introduced OpenAIChatCompletion and OpenAITextCompletion classes for OpenAI, specifying the code ranges for each
Added a link for users to understand the differences between Chat Completions and Completions models.

Rationale

This update ensures that users can easily identify which class to use based on their chosen model type, facilitating a smoother integration process and enhancing the utility of the documentation.

Additional Notes

Users are encouraged to refer to the provided link to comprehend the nuances between different model types and their corresponding applications in the OpenAI platform.

Testing

Verify the hyperlinks to the code samples are accurate and lead to the correct file locations.
Ensure the documentation renders correctly and is easy to follow.

Please review the changes for accuracy and clarity, and provide any feedback or suggestions for improvement.

Snipaste_2024-03-27_20-53-47

learn-build-service-prod[bot] commented 3 months ago

Learn Build status updates of commit 072ca93:

:white_check_mark: Validation status: passed

File	Status	Preview URL	Details
semantic-kernel/agents/kernel/index.md	:white_check_mark:Succeeded

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel