describe-contact-evaluation¶
Description¶
Describes a contact evaluation in the specified Amazon Connect instance.
See also: AWS API Documentation
Synopsis¶
describe-contact-evaluation
--instance-id <value>
--evaluation-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--instance-id (string) [required]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Constraints:
- min:
1- max:
100
--evaluation-id (string) [required]
A unique identifier for the contact evaluation.
Constraints:
- min:
1- max:
500
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
Evaluation -> (structure)
Information about the evaluation form completed for a specific contact.
EvaluationId -> (string) [required]
A unique identifier for the contact evaluation.
Constraints:
- min:
1- max:
500EvaluationArn -> (string) [required]
The Amazon Resource Name (ARN) for the contact evaluation resource.Metadata -> (structure) [required]
Metadata about the contact evaluation.
ContactId -> (string) [required]
The identifier of the contact in this instance of Amazon Connect.
Constraints:
- min:
1- max:
256EvaluatorArn -> (string) [required]
The Amazon Resource Name (ARN) of the user who last updated the evaluation.ContactAgentId -> (string)
The identifier of the agent who performed the contact.
Constraints:
- min:
1- max:
500CalibrationSessionId -> (string)
The calibration session ID that this evaluation belongs to.
Constraints:
- min:
1- max:
500Score -> (structure)
The overall score of the contact evaluation.
Percentage -> (double)
The score percentage for an item in a contact evaluation.
Constraints:
- min:
0- max:
100NotApplicable -> (boolean)
The flag to mark the item as not applicable for scoring.AutomaticFail -> (boolean)
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.AutoEvaluation -> (structure)
Information related to automated evaluation.
AutoEvaluationEnabled -> (boolean) [required]
Whether automated evaluation is enabled.AutoEvaluationStatus -> (string)
The status of the contact auto-evaluation.
Possible values:
IN_PROGRESSFAILEDSUCCEEDEDAcknowledgement -> (structure)
Information related to evaluation acknowledgement.
AcknowledgedTime -> (timestamp) [required]
When the agent acknowledged the evaluation.AcknowledgedBy -> (string) [required]
The agent who acknowledged the evaluation.AcknowledgerComment -> (string)
A comment from the agent when they confirmed they acknowledged the evaluation.
Constraints:
- min:
0- max:
3072Answers -> (map) [required]
A map of question identifiers to answer value.
Constraints:
- max:
100key -> (string)
Constraints:
- min:
1- max:
500value -> (structure)
Information about output answers for a contact evaluation.
Value -> (tagged union structure)
The value for an answer in a contact evaluation.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:StringValue,NumericValue,NotApplicable.StringValue -> (string)
The string value for an answer in a contact evaluation.
Constraints:
- min:
0- max:
300NumericValue -> (double)
The numeric value for an answer in a contact evaluation.NotApplicable -> (boolean)
The flag to mark the question as not applicable.SystemSuggestedValue -> (tagged union structure)
The system suggested value for an answer in a contact evaluation.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:StringValue,NumericValue,NotApplicable.StringValue -> (string)
The string value for an answer in a contact evaluation.
Constraints:
- min:
0- max:
300NumericValue -> (double)
The numeric value for an answer in a contact evaluation.NotApplicable -> (boolean)
The flag to mark the question as not applicable.SuggestedAnswers -> (list)
Automation suggested answers for the questions.
(structure)
The information about the suggested answer for the question.
Value -> (tagged union structure)
Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:StringValue,NumericValue,NotApplicable.StringValue -> (string)
The string value for an answer in a contact evaluation.
Constraints:
- min:
0- max:
300NumericValue -> (double)
The numeric value for an answer in a contact evaluation.NotApplicable -> (boolean)
The flag to mark the question as not applicable.Status -> (string) [required]
The status of the suggested answer. D
Possible values:
IN_PROGRESSFAILEDSUCCEEDEDInput -> (structure)
Details about the input used to question automation.
TranscriptType -> (string)
Transcript type.
Possible values:
RAWREDACTEDAnalysisType -> (string) [required]
Type of analysis used to provide suggested answer.
Possible values:
CONTACT_LENS_DATAGEN_AIAnalysisDetails -> (tagged union structure)
Detailed analysis results.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:GenAI,ContactLens.GenAI -> (structure)
Analysis results from the generative AI automation for the question.
Justification -> (string)
Generative AI automation answer justification.
Constraints:
- min:
1PointsOfInterest -> (list)
Generative AI automation answer analysis points of interest.
Constraints:
- min:
0- max:
100(structure)
Information about the point of interest in transcript provided to evaluation.
MillisecondOffsets -> (structure)
Offset in milliseconds from the beginning of transcript.
BeginOffsetMillis -> (integer) [required]
Offset in milliseconds from the beginning of the transcript.
Constraints:
- min:
0TranscriptSegment -> (string)
Segment of transcript.ContactLens -> (structure)
Analysis results from the Contact Lens automation for the question.
MatchedRuleCategories -> (list)
A list of match rule categories.
(structure)
The Contact Lens category used by evaluation automation.
Category -> (string) [required]
A category label.
Constraints:
- min:
1- max:
50Condition -> (string) [required]
An automation condition for a Contact Lens category.
Possible values:
PRESENTNOT_PRESENTPointsOfInterest -> (list)
A point of interest in a contact transcript that indicates match of condition.
Constraints:
- min:
0- max:
100(structure)
Information about the point of interest in transcript provided to evaluation.
MillisecondOffsets -> (structure)
Offset in milliseconds from the beginning of transcript.
BeginOffsetMillis -> (integer) [required]
Offset in milliseconds from the beginning of the transcript.
Constraints:
- min:
0TranscriptSegment -> (string)
Segment of transcript.Notes -> (map) [required]
A map of question identifiers to note value.
Constraints:
- max:
100key -> (string)
Constraints:
- min:
1- max:
500value -> (structure)
Information about notes for a contact evaluation.
Value -> (string)
The note for an item (section or question) in a contact evaluation.
Note
Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.Constraints:
- min:
0- max:
3072Status -> (string) [required]
The status of the contact evaluation.
Possible values:
DRAFTSUBMITTEDScores -> (map)
A map of item (section or question) identifiers to score value.
Constraints:
- max:
100key -> (string)
Constraints:
- min:
1- max:
500value -> (structure)
Information about scores of a contact evaluation item (section or question).
Percentage -> (double)
The score percentage for an item in a contact evaluation.
Constraints:
- min:
0- max:
100NotApplicable -> (boolean)
The flag to mark the item as not applicable for scoring.AutomaticFail -> (boolean)
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.CreatedTime -> (timestamp) [required]
The timestamp for when the evaluation was created.LastModifiedTime -> (timestamp) [required]
The timestamp for when the evaluation was last updated.EvaluationType -> (string)
Type of the evaluation.
Possible values:
STANDARDCALIBRATIONTags -> (map)
The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.
Constraints:
- min:
1- max:
50key -> (string)
Constraints:
- min:
1- max:
128- pattern:
^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$value -> (string)
Constraints:
- max:
256
EvaluationForm -> (structure)
Information about the evaluation form.
EvaluationFormVersion -> (integer) [required]
A version of the evaluation form.
Constraints:
- min:
1EvaluationFormId -> (string) [required]
The unique identifier for the evaluation form.
Constraints:
- min:
1- max:
500EvaluationFormArn -> (string) [required]
The Amazon Resource Name (ARN) for the evaluation form resource.Title -> (string) [required]
A title of the evaluation form.
Constraints:
- min:
1- max:
128Description -> (string)
The description of the evaluation form.
Constraints:
- min:
0- max:
1024Items -> (list) [required]
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
Constraints:
- min:
1- max:
100(tagged union structure)
Information about an item from an evaluation form. The item must be either a section or a question.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Section,Question.Section -> (structure)
The information of the section.
Title -> (string) [required]
The title of the section.
Constraints:
- min:
0- max:
128RefId -> (string) [required]
The identifier of the section. An identifier must be unique within the evaluation form.
Constraints:
- min:
1- max:
40Instructions -> (string)
The instructions of the section.
Constraints:
- min:
0- max:
1024Items -> (list) [required]
The items of the section.
Constraints:
- min:
1- max:
100(tagged union structure)
Information about an item from an evaluation form. The item must be either a section or a question.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Section,Question.Section -> (structure)
The information of the section.
Title -> (string) [required]
The title of the section.
Constraints:
- min:
0- max:
128RefId -> (string) [required]
The identifier of the section. An identifier must be unique within the evaluation form.
Constraints:
- min:
1- max:
40Instructions -> (string)
The instructions of the section.
Constraints:
- min:
0- max:
1024Weight -> (double)
The scoring weight of the section.
Constraints:
- min:
0- max:
100Question -> (structure)
The information of the question.
Title -> (string) [required]
The title of the question.
Constraints:
- min:
0- max:
350Instructions -> (string)
The instructions of the section.
Constraints:
- min:
0- max:
1024RefId -> (string) [required]
The identifier of the question. An identifier must be unique within the evaluation form.
Constraints:
- min:
1- max:
40NotApplicableEnabled -> (boolean)
The flag to enable not applicable answers to the question.QuestionType -> (string) [required]
The type of the question.
Possible values:
TEXTSINGLESELECTNUMERICQuestionTypeProperties -> (tagged union structure)
The properties of the type of question. Text questions do not have to define question type properties.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Numeric,SingleSelect,Text.Numeric -> (structure)
The properties of the numeric question.
MinValue -> (integer) [required]
The minimum answer value.MaxValue -> (integer) [required]
The maximum answer value.Options -> (list)
The scoring options of the numeric question.
Constraints:
- min:
1- max:
10(structure)
Information about the option range used for scoring in numeric questions.
MinValue -> (integer) [required]
The minimum answer value of the range option.MaxValue -> (integer) [required]
The maximum answer value of the range option.Score -> (integer)
The score assigned to answer values within the range option.
Constraints:
- min:
0- max:
10AutomaticFail -> (boolean)
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.AutomaticFailConfiguration -> (structure)
A configuration for automatic fail.
TargetSection -> (string)
The referenceId of the target section for auto failure.
Constraints:
- min:
1- max:
40Automation -> (tagged union structure)
The automation properties of the numeric question.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:PropertyValue,AnswerSource.PropertyValue -> (structure)
The property value of the automation.
Label -> (string) [required]
The property label of the automation.
Possible values:
OVERALL_CUSTOMER_SENTIMENT_SCOREOVERALL_AGENT_SENTIMENT_SCORENON_TALK_TIMENON_TALK_TIME_PERCENTAGENUMBER_OF_INTERRUPTIONSCONTACT_DURATIONAGENT_INTERACTION_DURATIONCUSTOMER_HOLD_TIMELONGEST_HOLD_DURATIONNUMBER_OF_HOLDSAGENT_INTERACTION_AND_HOLD_DURATIONAnswerSource -> (structure)
A source of automation answer for numeric question.
SourceType -> (string) [required]
The automation answer source type.
Possible values:
CONTACT_LENS_DATAGEN_AISingleSelect -> (structure)
The properties of the numeric question.
Options -> (list) [required]
The answer options of the single select question.
Constraints:
- min:
1- max:
256(structure)
Information about the automation configuration in single select questions.
RefId -> (string) [required]
The identifier of the answer option. An identifier must be unique within the question.
Constraints:
- min:
1- max:
40Text -> (string) [required]
The title of the answer option.
Constraints:
- min:
0- max:
128Score -> (integer)
The score assigned to the answer option.
Constraints:
- min:
0- max:
10AutomaticFail -> (boolean)
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.AutomaticFailConfiguration -> (structure)
Whether automatic fail is configured on a single select question.
TargetSection -> (string)
The referenceId of the target section for auto failure.
Constraints:
- min:
1- max:
40DisplayAs -> (string)
The display mode of the single select question.
Possible values:
DROPDOWNRADIOAutomation -> (structure)
The display mode of the single select question.
Options -> (list)
The automation options of the single select question.
Constraints:
- max:
20(tagged union structure)
Information about the automation option of a single select question.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:RuleCategory.RuleCategory -> (structure)
The automation option based on a rule category for the single select question.
Category -> (string) [required]
The category name, as defined in Rules.
Constraints:
- min:
1- max:
50Condition -> (string) [required]
The condition to apply for the automation option. If the condition is
PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition isNOT_PRESENT, then the option is applied when the contact data does not include the category.Possible values:
PRESENTNOT_PRESENTOptionRefId -> (string) [required]
The identifier of the answer option.
Constraints:
- min:
1- max:
40DefaultOptionRefId -> (string)
The identifier of the default answer option, when none of the automation options match the criteria.
Constraints:
- min:
1- max:
40AnswerSource -> (structure)
Automation answer source.
SourceType -> (string) [required]
The automation answer source type.
Possible values:
CONTACT_LENS_DATAGEN_AIText -> (structure)
The properties of the text question.
Automation -> (structure)
The automation properties of the text question.
AnswerSource -> (structure)
Automation answer source.
SourceType -> (string) [required]
The automation answer source type.
Possible values:
CONTACT_LENS_DATAGEN_AIEnablement -> (structure)
A question conditional enablement.
Condition -> (structure) [required]
A condition for item enablement configuration.
Operands -> (list) [required]
Operands of the enablement condition.
Constraints:
- min:
1(tagged union structure)
An operand of the enablement condition.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Expression,Condition.Expression -> (structure)
An expression of the enablement condition.
Source -> (structure) [required]
A source item of enablement expression.
Type -> (string) [required]
A type of source item.
Possible values:
QUESTION_REF_IDRefId -> (string)
A referenceId of the source item.
Constraints:
- min:
1- max:
40Values -> (list) [required]
A list of values from source item.
Constraints:
- min:
1(structure)
An enablement expression source value.
Type -> (string) [required]
A type of source item value.
Possible values:
OPTION_REF_IDRefId -> (string)
A referenceId of the source value.
Constraints:
- min:
1- max:
40Comparator -> (string) [required]
A comparator to be used against list of values.
Possible values:
INNOT_INCondition -> (structure)
A condition for item enablement.
Operands -> (list) [required]
Operands of the enablement condition.
Constraints:
- min:
1(tagged union structure)
An operand of the enablement condition.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Expression,Condition.Expression -> (structure)
An expression of the enablement condition.
Source -> (structure) [required]
A source item of enablement expression.
Type -> (string) [required]
A type of source item.
Possible values:
QUESTION_REF_IDRefId -> (string)
A referenceId of the source item.
Constraints:
- min:
1- max:
40Values -> (list) [required]
A list of values from source item.
Constraints:
- min:
1(structure)
An enablement expression source value.
Type -> (string) [required]
A type of source item value.
Possible values:
OPTION_REF_IDRefId -> (string)
A referenceId of the source value.
Constraints:
- min:
1- max:
40Comparator -> (string) [required]
A comparator to be used against list of values.
Possible values:
INNOT_IN( … recursive … )
Operator -> (string)
The operator to be used to be applied to operands if more than one provided.
Possible values:
ORANDOperator -> (string)
The operator to be used to be applied to operands if more than one provided.
Possible values:
ORANDAction -> (string) [required]
An enablement action that if condition is satisfied.
Possible values:
DISABLEENABLEDefaultAction -> (string)
An enablement action that if condition is not satisfied.
Possible values:
DISABLEENABLEWeight -> (double)
The scoring weight of the section.
Constraints:
- min:
0- max:
100Weight -> (double)
The scoring weight of the section.
Constraints:
- min:
0- max:
100Question -> (structure)
The information of the question.
Title -> (string) [required]
The title of the question.
Constraints:
- min:
0- max:
350Instructions -> (string)
The instructions of the section.
Constraints:
- min:
0- max:
1024RefId -> (string) [required]
The identifier of the question. An identifier must be unique within the evaluation form.
Constraints:
- min:
1- max:
40NotApplicableEnabled -> (boolean)
The flag to enable not applicable answers to the question.QuestionType -> (string) [required]
The type of the question.
Possible values:
TEXTSINGLESELECTNUMERICQuestionTypeProperties -> (tagged union structure)
The properties of the type of question. Text questions do not have to define question type properties.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Numeric,SingleSelect,Text.Numeric -> (structure)
The properties of the numeric question.
MinValue -> (integer) [required]
The minimum answer value.MaxValue -> (integer) [required]
The maximum answer value.Options -> (list)
The scoring options of the numeric question.
Constraints:
- min:
1- max:
10(structure)
Information about the option range used for scoring in numeric questions.
MinValue -> (integer) [required]
The minimum answer value of the range option.MaxValue -> (integer) [required]
The maximum answer value of the range option.Score -> (integer)
The score assigned to answer values within the range option.
Constraints:
- min:
0- max:
10AutomaticFail -> (boolean)
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.AutomaticFailConfiguration -> (structure)
A configuration for automatic fail.
TargetSection -> (string)
The referenceId of the target section for auto failure.
Constraints:
- min:
1- max:
40Automation -> (tagged union structure)
The automation properties of the numeric question.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:PropertyValue,AnswerSource.PropertyValue -> (structure)
The property value of the automation.
Label -> (string) [required]
The property label of the automation.
Possible values:
OVERALL_CUSTOMER_SENTIMENT_SCOREOVERALL_AGENT_SENTIMENT_SCORENON_TALK_TIMENON_TALK_TIME_PERCENTAGENUMBER_OF_INTERRUPTIONSCONTACT_DURATIONAGENT_INTERACTION_DURATIONCUSTOMER_HOLD_TIMELONGEST_HOLD_DURATIONNUMBER_OF_HOLDSAGENT_INTERACTION_AND_HOLD_DURATIONAnswerSource -> (structure)
A source of automation answer for numeric question.
SourceType -> (string) [required]
The automation answer source type.
Possible values:
CONTACT_LENS_DATAGEN_AISingleSelect -> (structure)
The properties of the numeric question.
Options -> (list) [required]
The answer options of the single select question.
Constraints:
- min:
1- max:
256(structure)
Information about the automation configuration in single select questions.
RefId -> (string) [required]
The identifier of the answer option. An identifier must be unique within the question.
Constraints:
- min:
1- max:
40Text -> (string) [required]
The title of the answer option.
Constraints:
- min:
0- max:
128Score -> (integer)
The score assigned to the answer option.
Constraints:
- min:
0- max:
10AutomaticFail -> (boolean)
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.AutomaticFailConfiguration -> (structure)
Whether automatic fail is configured on a single select question.
TargetSection -> (string)
The referenceId of the target section for auto failure.
Constraints:
- min:
1- max:
40DisplayAs -> (string)
The display mode of the single select question.
Possible values:
DROPDOWNRADIOAutomation -> (structure)
The display mode of the single select question.
Options -> (list)
The automation options of the single select question.
Constraints:
- max:
20(tagged union structure)
Information about the automation option of a single select question.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:RuleCategory.RuleCategory -> (structure)
The automation option based on a rule category for the single select question.
Category -> (string) [required]
The category name, as defined in Rules.
Constraints:
- min:
1- max:
50Condition -> (string) [required]
The condition to apply for the automation option. If the condition is
PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition isNOT_PRESENT, then the option is applied when the contact data does not include the category.Possible values:
PRESENTNOT_PRESENTOptionRefId -> (string) [required]
The identifier of the answer option.
Constraints:
- min:
1- max:
40DefaultOptionRefId -> (string)
The identifier of the default answer option, when none of the automation options match the criteria.
Constraints:
- min:
1- max:
40AnswerSource -> (structure)
Automation answer source.
SourceType -> (string) [required]
The automation answer source type.
Possible values:
CONTACT_LENS_DATAGEN_AIText -> (structure)
The properties of the text question.
Automation -> (structure)
The automation properties of the text question.
AnswerSource -> (structure)
Automation answer source.
SourceType -> (string) [required]
The automation answer source type.
Possible values:
CONTACT_LENS_DATAGEN_AIEnablement -> (structure)
A question conditional enablement.
Condition -> (structure) [required]
A condition for item enablement configuration.
Operands -> (list) [required]
Operands of the enablement condition.
Constraints:
- min:
1(tagged union structure)
An operand of the enablement condition.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Expression,Condition.Expression -> (structure)
An expression of the enablement condition.
Source -> (structure) [required]
A source item of enablement expression.
Type -> (string) [required]
A type of source item.
Possible values:
QUESTION_REF_IDRefId -> (string)
A referenceId of the source item.
Constraints:
- min:
1- max:
40Values -> (list) [required]
A list of values from source item.
Constraints:
- min:
1(structure)
An enablement expression source value.
Type -> (string) [required]
A type of source item value.
Possible values:
OPTION_REF_IDRefId -> (string)
A referenceId of the source value.
Constraints:
- min:
1- max:
40Comparator -> (string) [required]
A comparator to be used against list of values.
Possible values:
INNOT_INCondition -> (structure)
A condition for item enablement.
Operands -> (list) [required]
Operands of the enablement condition.
Constraints:
- min:
1(tagged union structure)
An operand of the enablement condition.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Expression,Condition.Expression -> (structure)
An expression of the enablement condition.
Source -> (structure) [required]
A source item of enablement expression.
Type -> (string) [required]
A type of source item.
Possible values:
QUESTION_REF_IDRefId -> (string)
A referenceId of the source item.
Constraints:
- min:
1- max:
40Values -> (list) [required]
A list of values from source item.
Constraints:
- min:
1(structure)
An enablement expression source value.
Type -> (string) [required]
A type of source item value.
Possible values:
OPTION_REF_IDRefId -> (string)
A referenceId of the source value.
Constraints:
- min:
1- max:
40Comparator -> (string) [required]
A comparator to be used against list of values.
Possible values:
INNOT_IN( … recursive … )
Operator -> (string)
The operator to be used to be applied to operands if more than one provided.
Possible values:
ORANDOperator -> (string)
The operator to be used to be applied to operands if more than one provided.
Possible values:
ORANDAction -> (string) [required]
An enablement action that if condition is satisfied.
Possible values:
DISABLEENABLEDefaultAction -> (string)
An enablement action that if condition is not satisfied.
Possible values:
DISABLEENABLEWeight -> (double)
The scoring weight of the section.
Constraints:
- min:
0- max:
100ScoringStrategy -> (structure)
A scoring strategy of the evaluation form.
Mode -> (string) [required]
The scoring mode of the evaluation form.
Possible values:
QUESTION_ONLYSECTION_ONLYStatus -> (string) [required]
The scoring status of the evaluation form.
Possible values:
ENABLEDDISABLEDAutoEvaluationConfiguration -> (structure)
The configuration of the automated evaluation.
Enabled -> (boolean) [required]
When automated evaluation is enabled.