Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OpenAI] Rename MessageContent to ThreadMessageContent #43016

Open
joseharriaga opened this issue Mar 26, 2024 · 0 comments
Open

[OpenAI] Rename MessageContent to ThreadMessageContent #43016

joseharriaga opened this issue Mar 26, 2024 · 0 comments
Labels
Client This issue points to a problem in the data-plane of the library. OpenAI
Milestone

Comments

@joseharriaga
Copy link
Member

joseharriaga commented Mar 26, 2024

https://apiview.dev/Assemblies/Review/abf39c5b6bd9459f81706dfc751197b5#4915ac9a53044f86ab3dd04613cd405b

KrzysztofCwalina 3 weeks ago
Should this be called AssitantMessageContent?

joseharriaga 3 weeks ago
I think "AssistantMessageContent" could make it sound like this belongs to a message with the "assistant" role. If the issue is that "MessageContent" is too generic, would it help if we called it "ThreadMessageContent" instead? I'm also thinking that any decision we make here might apply to the other Message* classes too.

trrwilson 2 weeks ago
Agreed with Jose on "thread" being the best additional information to encode if we go that route. I see the merits of either approach; I'd originally named this ThreadMessageContent in the Azure OpenAI definitions and then dropped the "Thread" in response to feedback that overall names were unnecessarily verbose.

Is there a codified decision process we should follow when balancing concision and clarity with type names? I noticed there's a bit of a "to do" in the guidelines: https://azure.github.io/azure-sdk/dotnet_introduction.html#model-type-naming

@joseharriaga joseharriaga added Client This issue points to a problem in the data-plane of the library. OpenAI labels Mar 26, 2024
@joseharriaga joseharriaga modified the milestones: 2024-04, 2024-05 Mar 26, 2024
@jsquire jsquire modified the milestones: 2024-05, 2024-06 May 20, 2024
@jsquire jsquire modified the milestones: 2024-06, 2024-07 Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. OpenAI
Projects
None yet
Development

No branches or pull requests

2 participants