patterns-ai-core / langchainrb

Build LLM-powered applications in Ruby
https://rubydoc.info/gems/langchainrb
MIT License
1.44k stars 195 forks source link

Shorter model name params #840

Closed bborn closed 1 month ago

bborn commented 1 month ago

Fixes #820:

This is a breaking change, and I updated the changelog and bumped the version to reflect that.

qarol commented 1 month ago

What do you think to release new versions following Semantic Versioning https://semver.org? If the release introduces breaking change, then bumping major version should help to catch potential problems earlier.

bborn commented 1 month ago

@qarol you're probably right - a breaking change should be a MAJOR version change according to server. @andreibondarev I'll leave that decision to you though...

andreibondarev commented 1 month ago

@bborn Quick thought -- maybe since the 3 methods are called:

def embed
def complete
def chat

we should call the defaults:

:embed_model
:complete_model
:chat_model

What do you think?

bborn commented 1 month ago

@andreibondarev I think that makes sense. Updated.

My only concern is that complete_model just sounds kind of ... weird to me. But it's consistent with the method names so probably ok.

andreibondarev commented 1 month ago

What do you think to release new versions following Semantic Versioning https://semver.org? If the release introduces breaking change, then bumping major version should help to catch potential problems earlier.

@qarol I love that! Given that we're pre-1.0.0, do you suggest that we keep incrementing minor versions, 0.18.0, 0.19.0, 0.20.0, etc.?

andreibondarev commented 1 month ago

@bborn Great PR! Thank you!

qarol commented 1 month ago

What do you think to release new versions following Semantic Versioning https://semver.org? If the release introduces breaking change, then bumping major version should help to catch potential problems earlier.

@qarol I love that! Given that we're pre-1.0.0, do you suggest that we keep incrementing minor versions, 0.18.0, 0.19.0, 0.20.0, etc.?

@andreibondarev question is, what things blocks from releasing 1.0.0 ;) For pre-1.0.0 it's acceptable to bump just minor version no matter if it's a breaking change or new feature. For bugfixes increasing patch number should be enough IMO