Flexible Translate

POST

/flexible_translate

curl --request POST \
  --url https://example.com/flexible_translate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "source_lang": "example", "target_lang": "example", "registered_model_name": "example", "variant": "example", "text": "example", "generation_params": {}, "document_type": "example", "chunking_strategy": "sentence", "max_chunk_tokens": 1, "overlap_tokens": 20, "preserve_context": true, "experiment_name": "example", "client_request_id": "example", "disable_prompt_formatting": false, "use_pivot": false, "translation_job_uuid": "example" }'

Authorizations

• HTTPBearer

Request Body^required

Media typeapplication/json

FlexibleTranslationRequest

object

source_lang

required

Source Lang

string

>= 1 characters <= 20 characters

target_lang

required

Target Lang

string

>= 1 characters <= 20 characters

registered_model_name

required

Registered Model Name

string

>= 1 characters <= 200 characters

variant

Any of:

string

string

<= 64 characters

null

null

text

required

Text

string

>= 1 characters

generation_params

Any of:

object

object

key

additional properties

any

null

null

document_type

Any of:

string

string

null

null

chunking_strategy

Any of:

string

string

/^(sentence|paragraph|token|sliding)$/

null

null

max_chunk_tokens

Any of:

integer

integer

>= 50 <= 8192

null

null

overlap_tokens

Any of:

integer

integer

<= 1000

null

null

preserve_context

Any of:

boolean

boolean

null

null

experiment_name

Any of:

string

string

<= 200 characters

null

null

client_request_id

Any of:

string

string

null

null

disable_prompt_formatting

Any of:

boolean

boolean

null

null

use_pivot

Any of:

boolean

boolean

null

null

translation_job_uuid

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

FlexibleTranslationResponse

object

translation

required

Translation

string

chunks_used

required

Chunks Used

integer

chunking_strategy

required

Chunking Strategy

string

processing_time_ms

required

Processing Time Ms

number

model_info

required

Model Info

object

key

additional properties

any

effective_params

required

Effective Params

object

key

additional properties

any

mlflow_run_id

Any of:

string

string

null

null

usage

Any of:

TokenUsage

TokenUsage

object

prompt_tokens

Any of:

integer

integer

null

null

completion_tokens

Any of:

integer

integer

null

null

total_tokens

Any of:

integer

integer

null

null

quantization

Any of:

string

string

null

null

gpu_mem_allocated_gb

Any of:

number

number

null

null

gpu_mem_reserved_gb

Any of:

number

number

null

null

null

null

Example^generated

{
  "translation": "example",
  "chunks_used": 1,
  "chunking_strategy": "example",
  "processing_time_ms": 1,
  "model_info": {},
  "effective_params": {},
  "mlflow_run_id": "example",
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1,
    "quantization": "example",
    "gpu_mem_allocated_gb": 1,
    "gpu_mem_reserved_gb": 1
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}