Adding Compass Tool #240

sanal-cohere · 2024-06-19T04:26:38Z

Thank you for contributing to the Cohere Toolkit!

PR title: "area: description"
- Where "area" is whichever of interface, frontend, model, tools, backend, etc. is being modified. Use "docs: ..." for purely docs changes, "infra: ..." for CI changes.
- Example: "deployment: add Azure model option"
PR message: Delete this entire checklist and replace with
- Description: a description of the change
- Issue: the issue # it fixes, if applicable
- Dependencies: any dependencies required for this change
Add tests and docs: Please include testing and documentation for your changes
Lint and test: Run make lint and make run-tests

AI Description

This PR introduces a new Python class, CompassTool, which extends the BaseTool class. This class provides functionality to interact with a Compass instance and perform operations such as creating, searching, updating, and deleting documents.

File Walkthrough:

The changes are made in the src/backend/tools/compass.py file:

New imports are added, including modules from the compass_sdk package.
The CompassTool class is defined, inheriting from BaseTool.
The is_available class method checks for the existence of required environment variables related to Compass configuration.
The __init__ method initializes the CompassTool class by setting the Compass URL, username, and password, either through direct arguments or environment variables.
The call method serves as the entry point for using the CompassTool. It performs various checks to ensure that the required parameters are provided and then delegates the action to specific methods (_create, _search, _update, _delete) based on the specified action.
The _parse method is responsible for parsing the input file and validating its existence.
The _create method inserts a document into Compass by first parsing the input and then using the insert_docs method of the CompassClient.
The _search method executes a search query on Compass and returns the top-k results.
The _update method updates a file in Compass by first deleting and then recreating it.
The _delete method removes a file from Compass using the delete_document method of the CompassClient.

Summary:

The CompassTool class provides a comprehensive set of methods to interact with a Compass instance, offering a user-friendly way to perform common operations on Compass documents.

CLAassistant · 2024-06-19T04:26:43Z

All committers have signed the CLA.

benrules3

Approach is looking good 👍

src/backend/tools/compass.py

benrules3

Compass integration looks right, good updates 👍

lusmoura

LGTM!

codecov-commenter · 2024-06-21T14:57:07Z

Codecov Report

Attention: Patch coverage is 0% with 83 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@123a9c0). Learn more about missing BASE report.

Files	Patch %	Lines
src/backend/tools/compass.py	0.00%	83 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #240   +/-   ##
=======================================
  Coverage        ?   87.26%           
=======================================
  Files           ?      147           
  Lines           ?     5212           
  Branches        ?        0           
=======================================
  Hits            ?     4548           
  Misses          ?      664           
  Partials        ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

* feat(assistant): Update conversation header * feat(assistant): Update conversation header * update tooltip * fix IconButton import

improve auth guide

* create new agent form * render agents list * link back to base agent page * perform post submission actions * move input labels outside of input borders * move submit button * gen client * factor out agent base form * use default content type * list custom agents * check if agent name is unique * and deployment + env variables to agent form * add deployments * clean up * add submit modal * push to new agent page on create success * only show available deployments * remove deployments dropdown * feat: List Assistants returned from API (#242) * feat: list agents from BE * Update src/interfaces/coral_web/src/components/Conversation/MessagingContainer.tsx Co-authored-by: misspia-cohere <[email protected]> --------- Co-authored-by: misspia-cohere <[email protected]> * nits --------- Co-authored-by: Khalil Najjar <[email protected]>

should_store logic to the attach_files_to_messages

* initial chat changes * need to test * done * Remove old test * default model for agents right now

* Organizations initial commit * Organizations initial commit * Organizations initial commit - sync main * Organizations initial commit - sync main - blacked * Organizations initial commit - sync main - lint * Organizations initial commit - sync main - tests * Organizations initial commit - sync main - tests * Organizations initial commit - review fixes * Organizations initial commit - review fixes

* CHange * change

* create new agent form * render agents list * link back to base agent page * perform post submission actions * move input labels outside of input borders * move submit button * gen client * factor out agent base form * check if agent name is unique * and deployment + env variables to agent form * add deployments * clean up * remove deployments dropdown * init agent page * create agent drawer * use agent form * add update agent request * add get agent request * fix rebase errors * remove model from agent form * add agent drawer to conversation * remove unused componenets * use new agent name for update success message * fix(toolkit): Address code feedback + improvements (#249) address code feedback improvements --------- Co-authored-by: Khalil Najjar <[email protected]>

* feat(toolkit): add/remove recently used agents * merge main

* GUide * Chang * Change * Change * Update docs/walkthrough/walkthrough.md Co-authored-by: Luísa Moura <[email protected]> * Update walkthrough.md --------- Co-authored-by: Luísa Moura <[email protected]>

cast isEditAgentPanelOpen to boolean

* updates * remove client changes * remove logs * use better header user id check * fix validators * typo

* Metrics: add middleware * add chat calls * merge * lint * make it async * add user id * add more fields * add retry and duration * add meta * comments * fix tests * improve error handling * rename fields * match spec * comments * clean code * only create loop when theres endpoint * add assistant id to chat

* feat(toolkit): show assistant welcome message * feat(toolkit): show assistant welcome message

* add login page components * Add Register page and hooks for auth * Add the register page and connect all the frontend elements * Redirect to /login if the token expires and clean up some console errors * Add error messages for failed logins * frontend: Add Single Sign-on to Toolkit (#227) * Add Google SSO login plus OpenID components * Dynamically set SSO login buttons and show or hide username and password based on auth_strategies --------- Co-authored-by: Tianjing Li <[email protected]> * fix startup event * Fix build errors and update the API client * Fix tests by adding missing env vars Add test OIDC_WELL_KNOWN_ENDPOINT var to fixtures * Add a walkthrough guide of the toolkit (#251) * GUide * Chang * Change * Change * Update docs/walkthrough/walkthrough.md Co-authored-by: Luísa Moura <[email protected]> * Update walkthrough.md --------- Co-authored-by: Luísa Moura <[email protected]> * coral-web: fix agent info panel opening by default (#253) cast isEditAgentPanelOpen to boolean * [backend] enforce agent update with user-id (#246) * updates * remove client changes * remove logs * use better header user id check * fix validators * typo * Metrics: add middleware (#185) * Metrics: add middleware * add chat calls * merge * lint * make it async * add user id * add more fields * add retry and duration * add meta * comments * fix tests * improve error handling * rename fields * match spec * comments * clean code * only create loop when theres endpoint * add assistant id to chat * feat(toolkit): show assistant welcome message (#255) * feat(toolkit): show assistant welcome message * feat(toolkit): show assistant welcome message --------- Co-authored-by: misspia-cohere <[email protected]> Co-authored-by: Tianjing Li <[email protected]> Co-authored-by: Beatrix De Wilde <[email protected]> Co-authored-by: Luísa Moura <[email protected]> Co-authored-by: misspia-cohere <[email protected]> Co-authored-by: Scott <[email protected]> Co-authored-by: Khalil Najjar <[email protected]>

sanal-cohere had a problem deploying to development June 19, 2024 04:26 — with GitHub Actions Failure

sanal-cohere requested review from BeatrixCohere, benrules3 and rodrigue-h June 19, 2024 04:27

sanal-cohere had a problem deploying to development June 19, 2024 04:39 — with GitHub Actions Failure

sanal-cohere changed the title ~~Initial commit for Compass Tool~~ Adding Compass Tool Jun 19, 2024

benrules3 reviewed Jun 19, 2024

View reviewed changes

src/backend/tools/compass.py Show resolved Hide resolved

src/backend/tools/compass.py Outdated Show resolved Hide resolved

src/backend/tools/compass.py Outdated Show resolved Hide resolved

sanal-cohere had a problem deploying to development June 20, 2024 17:41 — with GitHub Actions Failure

sanal-cohere had a problem deploying to development June 20, 2024 18:16 — with GitHub Actions Failure

benrules3 reviewed Jun 20, 2024

View reviewed changes

sanal-cohere had a problem deploying to development June 20, 2024 18:51 — with GitHub Actions Failure

sanal-cohere temporarily deployed to development June 20, 2024 18:58 — with GitHub Actions Inactive

sanal-cohere marked this pull request as ready for review June 20, 2024 19:01

sanal-cohere requested review from a team, EugeneLightsOn, malexw, scottmx81 and tianjing-li as code owners June 20, 2024 19:01

lusmoura approved these changes Jun 21, 2024

View reviewed changes

sanal-cohere had a problem deploying to development June 21, 2024 15:06 — with GitHub Actions Failure

sanal-cohere and others added 8 commits June 21, 2024 15:26

Initial commit for Compass Tool

e0aeab9

coral-web: update first turn suggestions (#225)

6831c6b

Addressed comments on the previous commit

d41d0f7

Added custom_context to parse and filters to search

1e4d295

Formatting changes

f39e29c

feat(assistant): Update conversation header (#229)

d875086

* feat(assistant): Update conversation header * feat(assistant): Update conversation header * update tooltip * fix IconButton import

Setup: fix dependencies (#243)

0deb6a7

feat(toolkit): show conversation list on with agents list (#231)

e1cce39

lusmoura and others added 17 commits June 21, 2024 15:26

Setup: remove redundant dependency (#244)

72dbad3

Improve Auth guide (#235)

a9f4b2b

improve auth guide

Propagate should_store logic to the File upload logic (#247)

7b613e6

should_store logic to the attach_files_to_messages

[backend] passing in agent when calling streaming chat (#237)

41a955d

* initial chat changes * need to test * done * Remove old test * default model for agents right now

Split up display name and name for Tools (#241)

6b1370a

* CHange * change

feat(toolkit): add/remove recently used agents (#250)

c1770d9

* feat(toolkit): add/remove recently used agents * merge main

Add a walkthrough guide of the toolkit (#251)

82a598f

* GUide * Chang * Change * Change * Update docs/walkthrough/walkthrough.md Co-authored-by: Luísa Moura <[email protected]> * Update walkthrough.md --------- Co-authored-by: Luísa Moura <[email protected]>

coral-web: fix agent info panel opening by default (#253)

e8abb45

cast isEditAgentPanelOpen to boolean

[backend] enforce agent update with user-id (#246)

0054efc

* updates * remove client changes * remove logs * use better header user id check * fix validators * typo

feat(toolkit): show assistant welcome message (#255)

913b250

* feat(toolkit): show assistant welcome message * feat(toolkit): show assistant welcome message

fix(toolkit): UX/UI improvements (#257)

9bf4f35

Add error troubleshooting (#262)

9c1d4bf

sanal-cohere force-pushed the sanal/compass branch from ccff1ca to 9c1d4bf Compare June 21, 2024 15:29

sanal-cohere had a problem deploying to development June 21, 2024 15:29 — with GitHub Actions Failure

Merge branch 'main' into sanal/compass

2fd7aed

sanal-cohere had a problem deploying to development June 21, 2024 16:12 — with GitHub Actions Failure

Update chat.py

0529a65

sanal-cohere had a problem deploying to development June 21, 2024 16:29 — with GitHub Actions Failure

sanal-cohere merged commit 0c5db02 into main Jun 21, 2024

sanal-cohere deleted the sanal/compass branch June 21, 2024 16:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding Compass Tool #240

Adding Compass Tool #240

Uh oh!

sanal-cohere commented Jun 19, 2024 •

edited by cohere-pr-pal bot

Loading

Uh oh!

CLAassistant commented Jun 19, 2024 •

edited

Loading

Uh oh!

benrules3 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benrules3 left a comment

Uh oh!

lusmoura left a comment

Uh oh!

codecov-commenter commented Jun 21, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

15 participants

Adding Compass Tool #240

Adding Compass Tool #240

Uh oh!

Conversation

sanal-cohere commented Jun 19, 2024 • edited by cohere-pr-pal bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

File Walkthrough:

Summary:

Uh oh!

CLAassistant commented Jun 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benrules3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benrules3 left a comment

Choose a reason for hiding this comment

Uh oh!

lusmoura left a comment

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Jun 21, 2024

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

15 participants

sanal-cohere commented Jun 19, 2024 •

edited by cohere-pr-pal bot

Loading

CLAassistant commented Jun 19, 2024 •

edited

Loading