Skip to content

feat: add docs for quality estimation alpha (hidden)#142

Merged
leoncheng57 merged 15 commits intomainfrom
quality-estimation-hidden
Nov 19, 2025
Merged

feat: add docs for quality estimation alpha (hidden)#142
leoncheng57 merged 15 commits intomainfrom
quality-estimation-hidden

Conversation

@leoncheng57
Copy link
Copy Markdown
Member

@leoncheng57 leoncheng57 commented Nov 12, 2025

Add Quality Estimation API (Unstable Alpha) Documentation

Summary

This PR adds hidden documentation for the new Quality Estimation Bilingual API endpoint
(api.deepl.com/unstable/quality-estimation/bilingual). The documentation is marked as a
work-in-progress hidden page and follows similar structure as other beta/alpha API
documentation pages.

Changes

  • New file: api-reference/quality-estimation/quality-estimation-alpha.mdx

Notes:

  • Marked as "(Hidden Page)" - not added to navigation
  • Labeled as "Unstable Alpha" with appropriate warnings
  • Includes special section on alpha reliability standards

Preview Link

https://deepl-c950b784-quality-estimation-hidden.mintlify.app/api-reference/quality-estimation/quality-estimation-alpha

Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
  - Update page title format for better clarity
  - Streamline warning message in danger callout
  - Fix indentation in code examples for consistency
  - Consolidate response examples into single success tab
  - Rename section for better semantic meaning
  - Set response fields expandable to open by default
@leoncheng57 leoncheng57 force-pushed the quality-estimation-hidden branch from 4b75c1d to 6d254f4 Compare November 18, 2025 20:00
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated
Comment thread api-reference/quality-estimation/quality-estimation-alpha.mdx Outdated

Note that the response will contain results in the same order as the prompts array.

**Important**: Do not provide both fields in one object entry, only one of `preset_category` or `custom_prompt`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

But multiple preset_categorys can be provided?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also, can we provide a list of the valid options here? Just the options, no description (that can be saved for the full docs further down)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

image

hopefully this is clearer

  - Remove hidden page warning and update description
  - Consolidate alpha notices into single warning section
  - Add summary with example response for quick understanding
  - Improve formatting and readability throughout
  - Streamline language code documentation
  - Update custom prompt examples for better clarity
@leoncheng57 leoncheng57 merged commit 5d3aace into main Nov 19, 2025
2 checks passed
@leoncheng57 leoncheng57 deleted the quality-estimation-hidden branch November 19, 2025 19:09
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.

4 participants