fix: threshold validation

[freinold]

Summary by CodeRabbit

• New Features

  • Added validation to ensure the threshold parameter for entity detection requests is between 0.0 and 1.0.

• Refactor

  • Renamed API endpoints and request/response formats for entity detection to use updated names.
  • Updated response headers for entity detection endpoints to provide clearer information on text length, inference time, and entity count.

[coderabbitai]

Walkthrough

The changes rename API endpoints and their associated request and response data models for entity detection, both for single and batch operations. The parameter for the HTTP response object is also renamed, and additional validation constraints are added to the threshold fields in the data models. Core logic and metrics remain unchanged.

Changes

File(s)	Change Summary
gliner_api/backend.py	Renamed API endpoints and updated request/response models; changed response parameter name; updated headers.
gliner_api/datamodel.py	Renamed four Pydantic data models; added value constraints to threshold fields in request models.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant GLiNER_Model

    Client->>API: POST /api/invoke (InvokeRequest)
    API->>GLiNER_Model: Run entity detection
    GLiNER_Model-->>API: Entities, inference time
    API-->>Client: InvokeResponse (with headers)

    Client->>API: POST /api/batch (BatchRequest)
    API->>GLiNER_Model: Run batch entity detection
    GLiNER_Model-->>API: Batch entities, inference time
    API-->>Client: BatchResponse (with headers)

Loading

Suggested labels

documentation

Poem

A hop and a skip, new names in the air,
Endpoints and models with fresh coats to wear.
Thresholds now bounded, requests well-defined,
Batch or invoke, your data aligned.
With headers and logic all neat in a row—
The code garden grows, and onward we go!
🥕

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ef865b1 and 7de5cdf.

📒 Files selected for processing (2)

• gliner_api/backend.py (6 hunks)
• gliner_api/datamodel.py (6 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• gliner_api/datamodel.py
• gliner_api/backend.py

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.