Skip to content

v0.4.0-alpha release

Pre-release
Pre-release
Compare
Choose a tag to compare
@jhakulin jhakulin released this 20 May 23:03
· 85 commits to main since this release
v0.4.0-alpha
13efc61
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

Purpose

  • Refactored Conversation and TextMessage, FileMessage and ImageMessage classes. Main reason is that the AssistantClientCallbacks implementation was insufficient and did not provide information about other than text messages in on_run_update method. In streaming scenario, it is important to get information about text, file citiations, files, images while streaming the content.
    • Conversation/AsyncConversation classes
      • Creates ConversationMessage/AsyncConversationMessage instances and provide convenience methods to get messages (including text, file and image contents) and text messages
    • New ConversationMessage/AsyncConversationMessage classes
      • Creates and provide properties for TextMessage, FileMessage and ImageMessage instances with contents
    • ConversationThreadClient/AsyncConversationThreadClient classes
      • AssistantClientCallbacks on_run_update method has been modified to pass ConversationMessage, which is used to provide convenient way to get text, file, image content information from the OpenAI assistant messages
      • New method retrieve_message added to ConversationThreadClient to convert OpenAI Message to ConversationMessage with parsed information.
    • Fixed bugs in async context when testing inside Azure Container App environment
    • Updated samples and templates for required changes due to refactoring
  • 2024-05-01-preview API version is default for Azure OpenAI unless specified in AZURE_OPENAI_API_VERSION env variable
  • Streaming has been now enabled as default in Assistant Tool. If you want to switch streaming off, you can do that in Settings -> General menu.
  • Update the version to 0.4.0-alpha.

Does this introduce a breaking change?

Due to Conversation class restructure, there is breaking change. Please see the updated samples and sample templates for the required changes.

[X] Yes
[ ] No

Release Type

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

Other Information

  • Please install new version azure_ai_assistant-0.4.0a1-py3-none-any.whl for middleware SDK from this release. See the README for installation details.
Assets 3
Loading