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

Docs(README): Fix mistakes in README #613

Merged
merged 3 commits into from
Oct 8, 2024
Merged

Conversation

HamadaSalhab
Copy link
Contributor

@HamadaSalhab HamadaSalhab commented Oct 8, 2024

Important

Fixes mistakes in README files by updating provider names, session chat structures, and document handling functions.

  • Provider and API Key Updates:
    • Change provider from google to brave and update api_key references in README.md, README-CN.md, and README-JP.md.
  • Session Chat Structure:
    • Update client.sessions.chat to use messages array instead of message string in README.md, README-CN.md, and README-JP.md.
  • Document Handling:
    • Change client.documents.create to client.agents.docs.create and client.documents.search to client.agents.docs.search in README.md, README-CN.md, and README-JP.md.

This description was created by Ellipsis for 867ad75. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 867ad75 in 45 seconds

More details
  • Looked at 171 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 3 drafted comments based on config settings.
1. README-CN.md:623
  • Draft comment:
    The client.sessions.chat method now expects a list of messages instead of a single message string. Ensure that the messages parameter is used correctly as a list of dictionaries with role and content. This change is also applicable in README-JP.md and README.md.
  • Reason this comment was not posted:
    Comment did not seem useful.
2. README-CN.md:635
  • Draft comment:
    The method for creating documents has changed from client.documents.create to client.agents.docs.create. Similarly, searching documents has changed from client.documents.search to client.agents.docs.search. Ensure these changes are reflected in your code. This change is also applicable in README-JP.md and README.md.
  • Reason this comment was not posted:
    Comment did not seem useful.
3. README-JP.md:617
  • Draft comment:
    The user_id parameter in client.sessions.create should reference a user object, i.e., user_id=user.id instead of a hardcoded string like user_id="user123". This change is also applicable in README-CN.md and README.md.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    The comment is about a change that has already been implemented in the diff, making it redundant. Additionally, it references changes in other files, which is not relevant to this review. Therefore, the comment should be removed.
    I might be overlooking the possibility that the comment is meant to reinforce the change or provide additional context. However, since the change is already made, the comment does not add value.
    The comment does not provide new information or context that is necessary after the change has been made. It is redundant and should be removed.
    The comment is about a change that has already been implemented, making it redundant. It should be removed.

Workflow ID: wflow_IdbSm45dREA7GKKr


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@HamadaSalhab HamadaSalhab merged commit 007c2ef into dev Oct 8, 2024
6 checks passed
@HamadaSalhab HamadaSalhab deleted the d/fix-readme-issues branch October 8, 2024 16:47
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

Successfully merging this pull request may close these issues.

1 participant