Skip to content
UltimateTeam.ai Docs

Conclude A/B test

POST
/api/v1/tuning/ab-tests/{test_id}/conclude
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/tuning/ab-tests/example/conclude \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "winner_variant": "example" }'

Conclude an A/B test with a winner.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
test_id
required
Test Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ConcludeTestRequest

Request body for concluding an A/B test.

object
winner_variant
required
Winner Variant
string
Examplegenerated
{
  "winner_variant": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
AgentResponseTestResponse

Response body for an agent response A/B test.

object
agent_role
required
Agent Role
string
behavior_dimension
required
Behavior Dimension
string
concluded_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
min_tenants
required
Min Tenants
integer
name
required
Name
string
significance_threshold
required
Significance Threshold
number
status
required
Status
string
variants
required
Variants
Array<object>
AgentResponseVariantResponse

Response body for a single response test variant.

object
acceptance_count
required
Acceptance Count
integer
acceptance_rate
Acceptance Rate
number
0
config
required
Config
object
key
additional properties
any
id
required
Id
string format: uuid
name
required
Name
string
override_count
required
Override Count
integer
satisfaction_sum
required
Satisfaction Sum
number
tenant_count
required
Tenant Count
integer
winner_variant
Any of:
string
Example
{
  "variants": [
    {
      "acceptance_rate": 0
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}