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

Class namings #8

Open
fmatak opened this issue May 10, 2024 · 3 comments
Open

Class namings #8

fmatak opened this issue May 10, 2024 · 3 comments

Comments

@fmatak
Copy link

fmatak commented May 10, 2024

io.github.stefanbratanov.jvm.openai.Thread class, sharing the same name java.lang.Thread, which is imported by default, causes some issues when using the library. Each time prefixing it with the full package name become a bit tedious. Maybe changing the class names that could potentially cause conflicts could help?

This is also applicable for some other classes like File, Constants etc. But since these classes are not included automatically, it is not that big problem.

thank you

@fmatak
Copy link
Author

fmatak commented May 10, 2024

Also, CreateThreadRequest.Message and ChatCompletion.Choice.Message classes are confusing for the people who are not very familiar with the api.
Even if the name changing is not possible, code samples could be updated to specify which one is used. Otherwise, because the imports are not provided, default Eclipse automatic imports cause many compilation errors.

@StefanBratanov
Copy link
Owner

Hi, thanks a lot for raising this. I was thinking about simplifying the nested classes. Would also update the README when done.

@StefanBratanov
Copy link
Owner

For the moment updated the README in 694eb6d . Will keep this issue open if I come up with namings, reorganization to make usage of classes easier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants