feat: Integrate cohere models #932

Wendong-Fan · 2024-09-11T13:28:27Z

Description

Integrate cohere models

Motivation and Context

Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax `close #896'

I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds core functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (update in the documentation)
Example (update in the folder of example)

Implemented Tasks

Develop the script to interact with the Cohere model API.
Ensure Cohere model is seamlessly integrated within the Camel framework.
Write and execute unit tests to verify the functionality of the Cohere model integration.
Resolve compatibility issues between the Cohere application and the retriever component.

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

I have read the CONTRIBUTION guide. (required)
My change requires a change to the documentation.
I have updated the tests accordingly. (required for a bug fix or a new feature)
I have updated the documentation accordingly.

coderabbitai · 2024-09-11T13:28:34Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

koch3092

Thanks @NeilJohnson0930 , left some comments

camel/models/cohere_model.py

examples/models/role_playing_with_cohere.py

camel/configs/cohere_config.py

Wendong-Fan

Thanks @NeilJohnson0930 ! Left some comments below

camel/models/cohere_model.py

examples/models/cohere_model_example.py

examples/models/role_playing_with_cohere.py

Wendong-Fan

Thanks @NeilJohnson0930 ! Left some comments

Wendong-Fan · 2024-09-24T15:00:30Z

camel/configs/cohere_config.py

+        temperature (Optional[float], optional):
+            Controls randomness in the model.
+            Values closer to 0 make the model more deterministic, while
+            values closer to 1 make it more random. (default: :obj:`None`)
+        p (Optional[float], optional): Sets a p% nucleus sampling threshold.
+            (default: :obj:`None`)
+        k (Optional[int], optional):
+            Limits the number of tokens to sample from on
+            each step. (default: :obj:`None`)
+        max_tokens (Optional[int], optional):
+            The maximum number of tokens to generate.
+            (default: :obj:`None`)
+        prompt_truncation (Optional[str], optional):
+            How to truncate the prompt if it
+            exceeds the model's context length. Can be 'START', 'END', or
+            'AUTO'. (default: :obj:`None`)


from https://docs.cohere.com/reference/chat seems not all parameters are included in config, like seed

Wendong-Fan · 2024-09-24T15:11:02Z

camel/models/cohere_model.py

+            usage={
+                "prompt_tokens": safe_get(
+                    response, 'meta', 'billed_tokens', 'prompt_tokens'
+                )
+                or 0,
+                "completion_tokens": safe_get(
+                    response, 'meta', 'billed_tokens', 'completion_tokens'
+                )
+                or 0,
+                "total_tokens": (
+                    (
+                        safe_get(
+                            response, 'meta', 'billed_tokens', 'prompt_tokens'
+                        )
+                        or 0
+                    )
+                    + (
+                        safe_get(
+                            response,
+                            'meta',
+                            'billed_tokens',
+                            'completion_tokens',
+                        )
+                        or 0
+                    )
+                ),
+            },


the path we get usage data seems not correct, it should from response.meta.tokens.input_tokens and response.meta.tokens.output_tokens

Wendong-Fan · 2024-09-24T15:12:32Z

camel/models/cohere_model.py

+    def _to_openai_response(
+        self, response: 'NonStreamedChatResponse'
+    ) -> ChatCompletion:


cohere model also support tool calling, we need to add tool_calls data to ChatCompletion

camel/models/cohere_model.py

NeilJohnson0930 added 2 commits September 11, 2024 21:24

feat: integrate model cohere

3151eec

feat: integrate model cohere

b05d9ac

update wd

71f3c0a

NeilJohnson0930 requested review from lightaime and NeilJohnson0930 September 11, 2024 14:51

fix: compatibility issue with Cohere application in retriever

0686fde

NeilJohnson0930 added this to the Sprint 12 milestone Sep 11, 2024

NeilJohnson0930 linked an issue Sep 11, 2024 that may be closed by this pull request

[Feature Request] Add cohere models #896

Open

2 tasks

NeilJohnson0930 removed their request for review September 11, 2024 15:11

Wendong-Fan assigned NeilJohnson0930 Sep 11, 2024

Wendong-Fan added Model Related to backend models New Feature labels Sep 11, 2024

NeilJohnson0930 marked this pull request as ready for review September 12, 2024 02:01

koch3092 self-requested a review September 20, 2024 10:34

koch3092 reviewed Sep 20, 2024

View reviewed changes

camel/models/cohere_model.py Outdated Show resolved Hide resolved

examples/models/role_playing_with_cohere.py Outdated Show resolved Hide resolved

WHALEEYE reviewed Sep 22, 2024

View reviewed changes

camel/configs/cohere_config.py Outdated Show resolved Hide resolved

camel/configs/cohere_config.py Outdated Show resolved Hide resolved

Wendong-Fan commented Sep 22, 2024

View reviewed changes

feat: add test_cohere_model.py and solved comment problems

3ac127b

NeilJohnson0930 force-pushed the dev_cohere branch from 0bc66de to 3ac127b Compare September 23, 2024 15:04

NeilJohnson0930 requested review from NeilJohnson0930, koch3092 and WHALEEYE and removed request for NeilJohnson0930 September 23, 2024 15:08

Wendong-Fan commented Sep 24, 2024

View reviewed changes

NeilJohnson0930 and others added 5 commits September 26, 2024 19:48

fix: review comment

ca9928b

update cohere config

1ee1aa8

Merge branch 'master' into dev_cohere

8629d43

update _to_openai_response

03ef4ee

add tool calling, with error from cohere

4a7cbad

Wendong-Fan and others added 5 commits October 10, 2024 17:56

Merge branch 'master' into dev_cohere

ffa6333

update cohere version

4a7ff06

feat: make cohere tool calling work

fee6d72

feat: del cohere exception function

ffaff5d

feat: add cohere tool call

03cd8c9

NeilJohnson0930 force-pushed the dev_cohere branch from ecb1925 to 03cd8c9 Compare October 30, 2024 09:48

NeilJohnson0930 and others added 3 commits October 30, 2024 17:52

fix: updates

2062d27

fix: tool call

6d3f699

update

e447666

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Integrate cohere models #932

feat: Integrate cohere models #932

Wendong-Fan commented Sep 11, 2024 •

edited

Loading

coderabbitai bot commented Sep 11, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

koch3092 left a comment

Wendong-Fan left a comment

Wendong-Fan left a comment

Wendong-Fan Sep 24, 2024

Wendong-Fan Sep 24, 2024

Wendong-Fan Sep 24, 2024

feat: Integrate cohere models #932

Are you sure you want to change the base?

feat: Integrate cohere models #932

Conversation

Wendong-Fan commented Sep 11, 2024 • edited Loading

Description

Motivation and Context

Types of changes

Implemented Tasks

Checklist

coderabbitai bot commented Sep 11, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

koch3092 left a comment

Choose a reason for hiding this comment

Wendong-Fan left a comment

Choose a reason for hiding this comment

Wendong-Fan left a comment

Choose a reason for hiding this comment

Wendong-Fan Sep 24, 2024

Choose a reason for hiding this comment

Wendong-Fan Sep 24, 2024

Choose a reason for hiding this comment

Wendong-Fan Sep 24, 2024

Choose a reason for hiding this comment

Wendong-Fan commented Sep 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)