Adding inference APIs

[NiveditJain]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @NiveditJain, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces comprehensive documentation for Exosphere's new inference APIs, which are designed to handle high-volume inference with adaptable SLAs and cost-efficiency. The changes also include updates to the documentation site's navigation to properly feature these new API guides.

Highlights

• New Inference API Documentation: A new documentation page, inference.md, has been added to detail the Exosphere inference APIs, including endpoints for submitting inference tasks, tracking overall task status, and checking individual object status.
• Documentation Navigation Update: The mkdocs.yml configuration has been updated to enable navigation tabs and integrate the new 'Inference APIs' documentation into the main navigation structure, grouping existing content under an 'Orchestrator' section.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[coderabbitai]

Warning

Rate limit exceeded

@NiveditJain has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6f17d64 and 0584f97.

📒 Files selected for processing (3)

• .vscode/settings.json (1 hunks)
• docs/docs/inference.md (1 hunks)
• docs/mkdocs.yml (2 hunks)

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Introduced comprehensive Inference APIs documentation outlining the unified API design, including endpoint specifications for task submission and status retrieval, with details on rate limiting, cost management, and automatic retry behavior.
  • Reorganized documentation navigation structure with tabbed interface for improved user experience and better discoverability of platform resources.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

This PR adds VS Code configuration for Python type checking, introduces new documentation for Inference APIs, and reorganizes the documentation site navigation with tabs enabled.

Changes

Cohort / File(s)	Summary
VS Code Configuration .vscode/settings.json	Added two new Pyright analysis settings: cursorpyright.analysis.autoImportCompletions: true and cursorpyright.analysis.typeCheckingMode: "basic"
Documentation docs/docs/inference.md	New documentation file describing the Inference APIs, including endpoint details (POST /v0/infer/, GET /v0/infer/task/{task_id}/, GET /v0/infer/object/{object_id}/), example requests/responses, SLA behavior, and auto-retry policy
Documentation Configuration docs/mkdocs.yml	Enabled navigation.tabs in theme configuration and reorganized nav structure by grouping existing items under a new "Orchestrator" section; added "Inference APIs" as a top-level nav entry

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Configuration entries are straightforward additions with no behavioral complexity
• Documentation review focuses on clarity and accuracy of API descriptions
• Navigation reorganization is a simple structural change without logic implications

Poem

🐰 A rabbit hops through docs with care,
Configuration settings now in the air,
Inference APIs documented bright,
Navigation tabs arranged just right! ✨

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch inference-docs

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Code Review

This pull request introduces documentation for the new Inference APIs. The documentation is well-structured and provides good examples. I've found a few issues, mostly related to consistency and correctness in the API examples, such as an inconsistent use of item_id versus object_id, a malformed JSON example, and some missing fields in responses. I've also pointed out a few typos and grammatical errors to improve clarity. The changes to mkdocs.yml look good and correctly integrate the new documentation.