Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Readme fixes and changes #134

Merged
merged 9 commits into from
Nov 2, 2023
Merged

Readme fixes and changes #134

merged 9 commits into from
Nov 2, 2023

Conversation

igiloh-pinecone
Copy link
Contributor

@igiloh-pinecone igiloh-pinecone commented Nov 1, 2023

Made a few changes:

  • The library description - removed the API endpoints, as they are irrelevant. We can add them in a separate "server" section later
  • Separated the CLI chat from the Quickstart section to its own "evaluation" section
  • Changed service to server
  • Added some general note about security \ authentication

There were some inaccuracies there
This term makes more sense...
@igiloh-pinecone igiloh-pinecone changed the title Minor Readme fixes Readme fixes and changes Nov 1, 2023
Copy link
Collaborator

@nc2112 nc2112 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few copy edits.

Does this version still have descriptions of the chat flow and context flow? We should include probably just have 1-2 lines explaining the two flows rather than the whole 7 or 4 steps.

README.md Outdated Show resolved Hide resolved

3. **Canopy CLI** - A built-in development tool that allows users to swiftly set up their own Canopy server and test its configuration.
With just three CLI commands, you can create a new Canopy service, upload your documents to it, and then interact with the Chatbot using a built-in chat application directly from the terminal. The built-in chatbot also enables comparison of RAG-infused responses against a native LLM chatbot.
With just three CLI commands, you can create a new Canopy server, upload your documents to it, and then interact with the Chatbot using a built-in chat application directly from the terminal. The built-in chatbot also enables comparison of RAG-infused responses against a native LLM chatbot.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interact with the Chatbot --> "chat with your documents"?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@igiloh-pinecone igiloh-pinecone merged commit d71e852 into dev Nov 2, 2023
4 checks passed
@igiloh-pinecone igiloh-pinecone deleted the readme_fixes branch November 2, 2023 18:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants