Skip to main content
PATCH
Create or change an A/B variant

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

cloudchat-instance
string
required

The CloudChat instance the account lives in, e.g. 4. Sent as a header, and required: with accountId it forms the pair that names exactly one account, which accountId alone does not. listMyCloudChatAccounts returns the value to send here alongside each accountId.

Path Parameters

project
string
required

The ClaudIA project to act on, by name. Get the names from listMyClaudiaProjects — a project these credentials do not cover answers 404, indistinguishable from one that does not exist.

key
string
required

The variant to act on, 1 to 64 letters, digits, _ or -. getProjectAbTest lists the existing ones.

Query Parameters

accountId
string
required

The CloudChat account whose permissions decide what you may read and write here, e.g. 7. It is permission context, not the resource: the project is named in the path. Only unique within an instance, so it is always read together with the cloudchat-instance header — get the pair from listMyCloudChatAccounts. An account your credentials hold no editing claim for answers 403.

Body

application/json
displayName
string
knowledgeBases
string[]
summaryPrompt
string
confidenceThreshold
number<float>
lowConfidenceCountLimit
integer<int32>
maximumMinutesWithoutResponse
integer<int64>
resolutionJobActive
boolean
detectTransferMessage
boolean
outOfOfficeResolveN1
boolean
outOfOfficeMessage
string
deferOutOfOfficeClose
boolean
generatedOutOfOfficeMessage
boolean
outOfOfficeAnswerPrompt
string
forwardToHumanMessage
string
humansAvailable
boolean
filterN1TagsOnly
boolean
filterN2TagsOnly
boolean
enableAudioTranscription
boolean
voiceReplyEnabled
boolean
voiceReplyEngine
string
voiceReplyVoice
string
voiceReplyTextAfterAudioPauseMillis
integer<int64>
repeatedSectionLimit
integer<int32>
shouldNeverChangeIntentWhenOnEddieFlow
boolean
language
enum<string>
Available options:
PT_BR,
EN,
ES,
FR,
DE,
IT,
JA,
KO,
ZH,
RU,
AR,
HI,
NL,
SV,
DA,
FI,
PL,
TR,
TH,
VI,
MS,
TL,
ID
basePromptModules
object
outputTransformation
object
splitLargeMessages
object
enlightenmentQuestionLimit
object
classificationSettings
object
greetingsSettings
object
unansweredTicketEscalator
object
attachmentHandover
object
startWithBotConfiguration
object
endWithBotConfiguration
object
defaultTagConfiguration
object
llmTagConfiguration
object
agenticLLMTagConfiguration
object
imageTranscriptionSettings
object
eddieConfiguration
object
backofficeConfiguration
object
frustrationDetection
object
contextEnrichment
object
resolutionMessages
object
humanOfficeHoursConfig
object
problemResolvedChecker
object
botPromotingConfig
object
forwardToHumanChecker
object

Response

Saved. The whole A/B test is returned as it now stands.

How this project's conversations are split between its base configuration and each A/B variant. Every new conversation draws once and keeps the variant it drew until it ends, always running that variant's current settings.

baselinePercentage
integer<int32>
required

Share of new conversations that run the base configuration, in percent.

Example:

80

variants
object[]
required

Every variant this project declares, including the ones receiving no traffic.