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

Examples in README are obsolete #118

Merged
merged 1 commit into from
Mar 5, 2025
Merged

Examples in README are obsolete #118

merged 1 commit into from
Mar 5, 2025

Conversation

pierrebelin
Copy link
Contributor

@pierrebelin pierrebelin commented Mar 5, 2025

Hi,
I tried to use this library this morning, and I struggled on the documentation.
It seems that the structure has changed since CreateMessageAsync method no longer exists.

The only thing I didn't try is AsTools() since I'm not using it.
Hope it helps

Summary by CodeRabbit

  • Documentation
    • Updated instructions to reflect the new streamlined process for constructing and sending messages.
  • Refactor
    • Enhanced message handling with a dedicated parameter structure and clearer role assignment, improving consistency and maintainability.

Copy link

coderabbitai bot commented Mar 5, 2025

Walkthrough

This pull request refactors the message creation and sending process in the README.md file. The changes replace the previous use of CreateMessageAsync with a new approach involving a CreateMessageParams object that encapsulates all necessary parameters. The update also introduces the InputMessage object for clear role specification, renames maxTokens to MaxTokens, and modifies the API call to Messages.MessagesPostAsync. These changes standardize and streamline how messages are constructed and processed.

Changes

File Change Summary
README.md Updated from using CreateMessageAsync with separate parameters to using Messages.MessagesPostAsync with a CreateMessageParams object; introduced InputMessage objects for defining sender roles; renamed maxTokens to MaxTokens; adjusted response handling to add messages directly to the parameters object.

Sequence Diagram(s)

sequenceDiagram
    participant U as User/Application
    participant C as AnthropicClient
    participant M as Messages API

    U->>C: Create CreateMessageParams with InputMessage objects
    C->>M: Call MessagesPostAsync(messageParams)
    M-->>C: Return message response
    C-->>U: Return response
Loading

Possibly related PRs

Suggested reviewers

  • github-actions

Poem

I’m a rabbit in the code burrow,
Hopping through changes smooth and mellow,
Messages crafted with roles defined,
Cleaner and clearer by design,
Leaping high with a cheerful heart,
Celebrating improvements—a true art! 🐇🎉


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this 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.

@CLAassistant
Copy link

CLAassistant commented Mar 5, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
README.md (2)

23-33: Updated Message Construction and Sending
The updated snippet correctly demonstrates the use of the new CreateMessageParams object and the Messages.MessagesPostAsync API call, including the updated property naming (MaxTokens). One minor point: the initializer for the Messages collection uses square brackets ([ ... ]), but standard C# collection initialization typically uses curly braces or explicit new array/list syntax. Please verify this syntax or consider updating it for clarity and correctness in a real code sample.


102-125: Enhanced Tool Integration Workflow
This code segment cleanly demonstrates how tool integrations are now managed by:

  • Building a CreateMessageParams object with the additional properties (System, ToolChoice, and Tools)
  • Sending the message and then dynamically adding the response (via response.AsInputMessage())
  • Iterating over any tool uses to call the corresponding service function and appending the tool call result back into the message sequence.

For improved clarity, please consider adding inline comments that explain the purpose of each step (especially the re-invocation of MessagesPostAsync after processing tool responses). Also, confirm that the use of non-null assertions (Value2! and toolUse!) is safe in this context or add proper null checks if necessary.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0fa7178 and b38b6d4.

📒 Files selected for processing (1)
  • README.md (3 hunks)

@HavenDV HavenDV enabled auto-merge (squash) March 5, 2025 12:37
@HavenDV
Copy link
Contributor

HavenDV commented Mar 5, 2025

Thank you for your PR

Yes, there is a problem here - I did not update because the generated code now contains ModelVariant6.Claude35SonnetLatest which I wanted to combine into one enum for ease of use

@HavenDV HavenDV merged commit 25ad5e3 into tryAGI:main Mar 5, 2025
4 checks passed
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.

3 participants