diff --git a/api-reference/openapi.json b/api-reference/openapi.json index d4727c1..cb88b5e 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -984,6 +984,15 @@ "description": "Indicates the translation model used. Only present if model_type parameter is included in the request.", "type": "string", "example": "quality_optimized" + }, + "tag_handling_version": { + "description": "The version of the tag handling algorithm used for the translation. Only present when the `tag_handling` parameter (`xml` or `html`) is set. If you don't specify `tag_handling_version`, this shows the default that was applied.", + "type": "string", + "enum": [ + "v2", + "v1" + ], + "example": "v2" } } } diff --git a/api-reference/openapi.yaml b/api-reference/openapi.yaml index ab81c4d..a623a2c 100644 --- a/api-reference/openapi.yaml +++ b/api-reference/openapi.yaml @@ -745,6 +745,16 @@ paths: is included in the request. type: string example: quality_optimized + tag_handling_version: + description: The version of the tag handling algorithm used for the translation. + Only present when the `tag_handling` parameter (`xml` or `html`) is set. + If you don't specify `tag_handling_version`, this shows the default + that was applied. + type: string + enum: + - v2 + - v1 + example: v2 400: $ref: '#/components/responses/BadRequest' diff --git a/api-reference/translate.mdx b/api-reference/translate.mdx index f817075..43f3034 100644 --- a/api-reference/translate.mdx +++ b/api-reference/translate.mdx @@ -326,6 +326,7 @@ Note that we do not include examples for our client libraries in every single se
  • v2: Use the improved v2 algorithm.
  • v1: Use the previous v1 algorithm.
  • + When `tag_handling` is set, the response includes a `tag_handling_version` field showing which version was applied, including the default when you don't specify one. The automatic detection of the XML structure won't yield best results in all XML files. You can disable this automatic mechanism altogether by setting the outline_detection parameter to false and selecting the tags that should be considered structure tags. This will split sentences using the splitting_tags parameter.