Skip to content

Commit cc59900

Browse files
committed
fix: Fix formality for translate and add separate formality for voice
Updated formality references and added VoiceFormality schema. Ordered some of the params alphabetically. We should either have a linter/autofixer for this or not care
1 parent ebe3832 commit cc59900

1 file changed

Lines changed: 59 additions & 38 deletions

File tree

api-reference/openapi.yaml

Lines changed: 59 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1958,7 +1958,7 @@ paths:
19581958
glossary_id:
19591959
$ref: '#/components/schemas/GlossaryId'
19601960
formality:
1961-
$ref: '#/components/schemas/Formality'
1961+
$ref: '#/components/schemas/VoiceFormality'
19621962
examples:
19631963
basic:
19641964
summary: Basic configuration
@@ -1975,7 +1975,7 @@ paths:
19751975
source_language_mode: 'fixed'
19761976
target_languages: ['de', 'fr']
19771977
glossary_id: 'def3a26b-3e84-45b3-84ae-0c0aaf3525f7'
1978-
formality: 'more'
1978+
formality: 'formal'
19791979
responses:
19801980
200:
19811981
description: Successfully obtained streaming URL and token.
@@ -3557,17 +3557,24 @@ components:
35573557
Formality:
35583558
description: |-
35593559
Sets whether the translated text should lean towards formal or informal language.
3560+
This feature is only available for certain target languages. Setting this parameter
3561+
with a target language that does not support formality will fail, unless one of the
3562+
`prefer_...` options are used.
35603563
Possible options are:
3561-
* `default` - use the default formality for the target language
3562-
* `formal` - for a more formal language
3563-
* `informal` - for a more informal language
3564+
* `default` (default)
3565+
* `more` - for a more formal language
3566+
* `less` - for a more informal language
3567+
* `prefer_more` - for a more formal language if available, otherwise fallback to default formality
3568+
* `prefer_less` - for a more informal language if available, otherwise fallback to default formality
35643569
type: string
35653570
enum:
35663571
- default
3567-
- formal
3568-
- informal
3572+
- more
3573+
- less
3574+
- prefer_more
3575+
- prefer_less
35693576
default: default
3570-
example: formal
3577+
example: prefer_more
35713578
GlossaryDictionary:
35723579
type: object
35733580
description: A dictionary contained in a multilingual glossary. Each dictionary contains the mapping of source terms to target language terms.
@@ -4074,36 +4081,6 @@ components:
40744081
- pt-BR
40754082
- pt-PT
40764083
example: de
4077-
WritingStyle:
4078-
type: string
4079-
description: |-
4080-
Specify a style to rephrase your text in a way that fits your audience and goals.
4081-
The `prefer_` prefix allows falling back to the default style if the language does not yet support styles.
4082-
enum:
4083-
- academic
4084-
- business
4085-
- casual
4086-
- default
4087-
- simple
4088-
- prefer_academic
4089-
- prefer_business
4090-
- prefer_casual
4091-
- prefer_simple
4092-
WritingTone:
4093-
type: string
4094-
description: |-
4095-
Specify the desired tone for your text.
4096-
The `prefer_` prefix allows falling back to the default tone if the language does not yet support tones.
4097-
enum:
4098-
- confident
4099-
- default
4100-
- diplomatic
4101-
- enthusiastic
4102-
- friendly
4103-
- prefer_confident
4104-
- prefer_diplomatic
4105-
- prefer_enthusiastic
4106-
- prefer_friendly
41074084
UsageResponse:
41084085
type: object
41094086
properties:
@@ -4153,6 +4130,20 @@ components:
41534130
format: date-time
41544131
description: Only present for API Pro users. End time of the current billing period (ISO 8601).
41554132
example: '2025-06-13T09:18:42Z'
4133+
VoiceFormality:
4134+
description: |-
4135+
Sets whether the translated text should lean towards formal or informal language.
4136+
Possible options are:
4137+
* `default` - use the default formality for the target language
4138+
* `formal` - for a more formal language
4139+
* `informal` - for a more informal language
4140+
type: string
4141+
enum:
4142+
- default
4143+
- formal
4144+
- informal
4145+
default: default
4146+
example: formal
41564147
VoiceSourceMediaContentType:
41574148
type: string
41584149
description: "
@@ -4321,6 +4312,36 @@ components:
43214312
description: >
43224313
Internal use only. A unique identifier for the requested stream.
43234314
example: 4f911080-cfe2-41d4-8269-0e6ec15a0354
4315+
WritingStyle:
4316+
type: string
4317+
description: |-
4318+
Specify a style to rephrase your text in a way that fits your audience and goals.
4319+
The `prefer_` prefix allows falling back to the default style if the language does not yet support styles.
4320+
enum:
4321+
- academic
4322+
- business
4323+
- casual
4324+
- default
4325+
- simple
4326+
- prefer_academic
4327+
- prefer_business
4328+
- prefer_casual
4329+
- prefer_simple
4330+
WritingTone:
4331+
type: string
4332+
description: |-
4333+
Specify the desired tone for your text.
4334+
The `prefer_` prefix allows falling back to the default tone if the language does not yet support tones.
4335+
enum:
4336+
- confident
4337+
- default
4338+
- diplomatic
4339+
- enthusiastic
4340+
- friendly
4341+
- prefer_confident
4342+
- prefer_diplomatic
4343+
- prefer_enthusiastic
4344+
- prefer_friendly
43244345
AdminUsageReport:
43254346
type: object
43264347
description: The response for admin usage statistics.

0 commit comments

Comments
 (0)