genai: generalize uploadFile in examples and add comment #185
Conversation
|
Refactored |
| // representing it. | ||
| // representing it. mimeType optionally specifies the MIME type of the data in | ||
| // the file; if set to "", the service will try to automatically determine the | ||
| // type from the data contents. | ||
| // To clean up the file, defer a client.DeleteFile(ctx, file.Name) |
There was a problem hiding this comment.
Here, and in the equivalent comment in docs-snippets-test.go, the word "try" suggests that the service may fail. It would be more accurate to say "it will try to determine the correct type"
Thinking about the comment a bit more, and trying to add some guidance and insight around when to specify the empty strings and when to provide a MIME type, how about something like:
mimeType optionally specifies the MIME type of the data in the file;
if omitted, the service will attempt to infer it from the file contents;
for ambiguous file types (e.g., text files), it is recommended to explicitly specify the MIME type
There was a problem hiding this comment.
^ Feedback for future consideration
There was a problem hiding this comment.
I like this phrasing; will send a PR soon
Updates #180