Add a text getter for Candidate #170
Merged
+52
−37
Conversation
This file contains 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
Closes #99 Call out that candidates may be ignored in the doc for `GenerateContentResponse.text`. Add a `text` getter on `Candidate`. This is the same logic that was in the response text getter, applied to an individual candidate. Refactor the response text implementation to use the candidate field.
devoncarew
approved these changes
May 23, 2024
| /// If there is more than one candidate, all but the first are ignored. See | ||
| /// [Candidate.text] to get the text content of candidates other than the | ||
| /// first. | ||
| String? get text => switch (candidates) { |
There was a problem hiding this comment.
Do other language sdks have a similar affordance? It's a nice shorthand for getting results from a response, but may be easy for people to mis-use (to not understand that there could be more than one candidate response).
There was a problem hiding this comment.
Yes, this API has a coordinated designed across the SDKs. I don't think the text getter on Candidate is as consistent, but every language does have a utility to get the text of the first candidate from a GenerateContentResponse.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #99
Call out that candidates may be ignored in the doc for
GenerateContentResponse.text.Add a
textgetter onCandidate. This is the same logic that was inthe response text getter, applied to an individual candidate.
Refactor the response text implementation to use the candidate field.