Skip to content

Commit c2053d9

Browse files
Merge pull request #16 from DeepLcom/context-parameter-ga
Remove alpha label from context parameter entries in OpenAPI files
2 parents 87e559b + f0a379b commit c2053d9

File tree

4 files changed

+17
-19
lines changed

4 files changed

+17
-19
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ number is used only for corrections to the OpenAPI specification, for example:
1010
typos, schema fixes, or adding examples.
1111

1212

13+
## [2.14.1] - 2024-06-18
14+
### Changed
15+
* Text translation `context` parameter is now generally available (was alpha).
16+
17+
1318
## [2.14.0] - 2024-05-08
1419
### Added
1520
* Added supported glossary languages: Danish (`'da'`), Norwegian (bokmål) (`'nb'`), and Swedish (`'sv'`).
@@ -131,6 +136,7 @@ typos, schema fixes, or adding examples.
131136
Initial release of the OpenAPI specification.
132137

133138

139+
[2.14.1]: https://github.com/DeepLcom/openapi/compare/v2.14.0...v2.14.1
134140
[2.14.0]: https://github.com/DeepLcom/openapi/compare/v2.13.0...v2.14.0
135141
[2.13.0]: https://github.com/DeepLcom/openapi/compare/v2.12.0...v2.13.0
136142
[2.12.0]: https://github.com/DeepLcom/openapi/compare/v2.11.0...v2.12.0

openapi.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"name": "DeepL - Contact us",
99
"url": "https://www.deepl.com/contact-us"
1010
},
11-
"version": "2.14.0"
11+
"version": "2.14.1"
1212
},
1313
"externalDocs": {
1414
"description": "DeepL Pro - Plans and pricing",
@@ -1657,7 +1657,7 @@
16571657
},
16581658
"schemas": {
16591659
"Context": {
1660-
"description": "The `context` parameter makes it possible to include additional context that can influence a translation but is not translated itself. \nThis additional context can potentially improve translation quality when translating short, low-context source texts such \nas product names on an e-commerce website, article headlines on a news website, or UI elements.\n\n\nFor example...\n - When translating a product name, you might pass the product description as context. \n - When translating a news article headline, you might pass the first few sentences or a summary of the article as context.\n\n\nFor best results, we recommend sending a few complete sentences of context. There is no size limit for the `context` parameter itself, but \nthe request body size limit of 128 KiB still applies to all text translation requests. \n\n\nIf you send a request with multiple `text` parameters, the `context` parameter will be applied to each one. \n\n\nThe `context` parameter is an **alpha feature** as defined in section 3.1.5 of our [terms and conditions](https://www.deepl.com/en/pro-license). \nThis means it could be changed or deprecated by DeepL at any point and without advance notice. While the feature is still labeled as \"alpha\", \ncontext will not be counted toward billing (i.e. there is no additional cost for sending context). This is subject to change if the \"alpha\" \nlabel is removed and the feature becomes generally available. If we decide to deprecate the `context` parameter, requests that include it will not \nbreak; the context will simply be ignored. \n\n\nFor these reasons, **the `context` parameter is not intended to be used in production** as long as the alpha label still applies.\n\n\nWe're eager to hear how the `context` parameter is working for you and how we can improve the feature! You can share your feedback \nby emailing api-feedback@deepl.com.",
1660+
"description": "The `context` parameter makes it possible to include additional context that can influence a translation but is not translated itself. \nThis additional context can potentially improve translation quality when translating short, low-context source texts such \nas product names on an e-commerce website, article headlines on a news website, or UI elements.\n\n\nFor example...\n - When translating a product name, you might pass the product description as context. \n - When translating a news article headline, you might pass the first few sentences or a summary of the article as context.\n\n\nFor best results, we recommend sending a few complete sentences of context in the same language as the source text. \nThere is no size limit for the `context` parameter itself, but the request body size limit of 128 KiB still applies to \nall text translation requests. \n\n\nIf you send a request with multiple `text` parameters, the `context` parameter will be applied to each one. \n\n\nCharacters included in the `context` parameter will not be counted toward billing (i.e. there is no additional \ncost for using the `context` parameter, and only characters sent in the text parameter(s) will be counted toward \nbilling for text translation even when the `context` parameter is included in a request).",
16611661
"type": "string"
16621662
},
16631663
"CreateGlossaryParameters": {

openapi.yaml

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ info:
77
contact:
88
name: DeepL - Contact us
99
url: https://www.deepl.com/contact-us
10-
version: 2.14.0
10+
version: 2.14.1
1111
externalDocs:
1212
description: DeepL Pro - Plans and pricing
1313
url: https://www.deepl.com/pro#developer?cta=header-prices/
@@ -1277,25 +1277,17 @@ components:
12771277
- When translating a news article headline, you might pass the first few sentences or a summary of the article as context.
12781278
12791279
1280-
For best results, we recommend sending a few complete sentences of context. There is no size limit for the `context` parameter itself, but
1281-
the request body size limit of 128 KiB still applies to all text translation requests.
1280+
For best results, we recommend sending a few complete sentences of context in the same language as the source text.
1281+
There is no size limit for the `context` parameter itself, but the request body size limit of 128 KiB still applies to
1282+
all text translation requests.
12821283
12831284
12841285
If you send a request with multiple `text` parameters, the `context` parameter will be applied to each one.
12851286
12861287
1287-
The `context` parameter is an **alpha feature** as defined in section 3.1.5 of our [terms and conditions](https://www.deepl.com/en/pro-license).
1288-
This means it could be changed or deprecated by DeepL at any point and without advance notice. While the feature is still labeled as "alpha",
1289-
context will not be counted toward billing (i.e. there is no additional cost for sending context). This is subject to change if the "alpha"
1290-
label is removed and the feature becomes generally available. If we decide to deprecate the `context` parameter, requests that include it will not
1291-
break; the context will simply be ignored.
1292-
1293-
1294-
For these reasons, **the `context` parameter is not intended to be used in production** as long as the alpha label still applies.
1295-
1296-
1297-
We're eager to hear how the `context` parameter is working for you and how we can improve the feature! You can share your feedback
1298-
by emailing api-feedback@deepl.com.
1288+
Characters included in the `context` parameter will not be counted toward billing (i.e. there is no additional
1289+
cost for using the `context` parameter, and only characters sent in the text parameter(s) will be counted toward
1290+
billing for text translation even when the `context` parameter is included in a request).
12991291
type: string
13001292
CreateGlossaryParameters:
13011293
type: object

openapi_gitbook.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ info:
99
contact:
1010
name: DeepL - Contact us
1111
url: https://www.deepl.com/contact-us
12-
version: 2.14.0
12+
version: 2.14.1
1313
externalDocs:
1414
description: DeepL Pro - Plans and pricing
1515
url: https://www.deepl.com/pro#developer?cta=header-prices/
@@ -1311,7 +1311,7 @@ components:
13111311
description: |-
13121312
Additional context that can influence a translation but is not translated itself.
13131313
1314-
Alpha feature. Not intended for production use. May be deprecated without prior notice.
1314+
Characters included in the `context` parameter will not be counted toward billing.
13151315
type: string
13161316
example: This is context.
13171317
OutlineDetectionOptionStr:

0 commit comments

Comments
 (0)