.Net - Convert message AuthorName whitespace or empty string assignment to null - #6990
Merged
Merged
Conversation
Chris (crickman)
added
PR: ready for review
Chris (crickman)
requested review from
SergeyMenshykh,
Ben Thomas (alliscode) and
Gil LaHaye (glahaye)
June 27, 2024 16:32
Chris (crickman)
added
bug
Chris (crickman)
changed the title
AuthorName assignment to nullAuthorName whitespace or empty string assignment to null
Ben Thomas (alliscode)
approved these changes
Jun 27, 2024
Chris (crickman)
removed
the
PR: ready for review
LudoCorporateShark
pushed a commit
to LudoCorporateShark/semantic-kernel
that referenced
this pull request
Aug 25, 2024
…ment to `null` (microsoft#6990) ### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> Assist caller in avoiding an improper assignmemt of: - `ChatMessageContent.AuthorRole` - `StreamingChatMessageContent.AuthorRole` ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> In advertent assignment of an empty string (or whitespace) results in an `HttpOperationException` when using the message as input to `IChatCompletionService`. While it may be ideal for caller to take care to _not_ assign such a value, intercepting this state at the earliest possible moment reduces debugging confusion. > Stronger validation may not be appropriate as it may be model specific. ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [X] The code builds clean without any errors or warnings - [X] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [X] All unit tests pass, and I have added new tests where possible - [X] I didn't break anyone 😄
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Assist caller in avoiding an improper assignmemt of:
ChatMessageContent.AuthorRoleStreamingChatMessageContent.AuthorRoleDescription
Inadvertent assignment of an empty string (or whitespace) to
ChatMessageContant.AuthorNameresults in anHttpOperationExceptionwhen using the message as input toIChatCompletionService.While it may be ideal for caller to take care to not assign such a value, intercepting this state at the earliest possible moment reduces debugging confusion.
Contribution Checklist