fluxninja / aperture

Rate limiting, caching, and request prioritization for modern workloads
https://docs.fluxninja.com
Apache License 2.0
641 stars 25 forks source link

Add mermaid and explanation to openai guide #3050

Closed karansohi closed 11 months ago

karansohi commented 11 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 11 months ago

Walkthrough

The documentation for OpenAI has been updated to include a new graph that illustrates how request scheduling is managed using Aperture. It also provides a concise explanation of the request prioritization and execution process. Additionally, a code snippet that previously demonstrated how to make an OpenAI API call using Aperture Client's StartFlow and End methods has been removed.

Changes

File Summary
docs/content/guides/openai.md Added a graph depicting request scheduling with Aperture and a brief explanation of request prioritization and execution; removed a code snippet for OpenAI API call using Aperture Client.

🐇✨ To code, to build, a graph takes flight, Through Aperture's lens, requests in sight. Prioritize, execute, the flow is clear, CodeRabbit hops on, with changes to cheer! 🎉 🐇💻


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - You can reply to a review comment made by CodeRabbit. - You can tag CodeRabbit on specific lines of code or files in the PR by tagging `@coderabbitai` in a comment. - You can tag `@coderabbitai` in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json`