v1
latestOpenAPI 3.0.22026-07-17373198641.7 KBCreate Document Field Params: - document_type: uid of Document Type - code: str - Unique Short name for field, max 50 symbols, should contain only latin letters, digits, and underscores - long_code: str - Unique Calculated field, max 150 symbols - title: str - Verbose name for field, max 100 symbols - description: str - optional - type: str - max 30 symbols (from pre-defined choices) - text_unit_type: str - (from pre-defined choices) default = sentences - value_detection_strategy: str - max 50 chars (from pre-defined choices) - unsure_choice_value: str - max 256 chars, default=null - unsure_thresholds_by_value: json - classifier_init_script: str - formula: str - convert_decimals_to_floats_in_formula_args: bool - depends_on_fields: array of uids, optional - confidence: str - max 100 chars (from pre-defined choices) - requires_text_annotations: bool, default=True - read_only: bool, default=False - category: int - id of DocumentFieldCategory instance - default_value: json - choices: str - \n-separated list of choices - allow_values_not_specified_in_choices: bool - default=False - metadata: json, optional - training_finished: bool, default=False - dirty: bool, default=False - order: integer - default=0 - trained_after_documents_number: integer, default=null - hidden_always: bool - default=False - hide_until_python: str, optional - hide_until_js: str, optional - display_yes_no: bool - default=False
Request body
Example request
{
"classifier_init_script": "classifier_init_script",
"vectorizer_stop_words": "vectorizer_stop_words",
"metadata": "{}",
"code": "code",
"allow_values_not_specified_in_choices": true,
"description": "description",
"long_code": "long_code",
"title": "title",
"type": "address",
"value_regexp": "value_regexp",
"trained_after_documents_number": 1280358509,
"unsure_choice_value": "unsure_choice_value",
"read_only": true,
"depends_on_fields": [
"depends_on_fields",
"depends_on_fields"
],
"requires_text_annotations": true,
"hide_until_python": "hide_until_python",
"document_type": "document_type",
"order": 4803,
"convert_decimals_to_floats_in_formula_args": true,
"dirty": true,
"confidence": "High",
"hide_until_js": "hide_until_js",
"default_value": "{}",
"unsure_thresholds_by_value": "{}",
"warning_message": "warning_message",
"text_unit_type": "sentence",
"mlflow_model_uri": "mlflow_model_uri",
"display_yes_no": true,
"training_finished": true,
"mlflow_detect_on_document_level": true,
"formula": "formula",
"value_detection_strategy": "disabled",
"hidden_always": true,
"category": 0,
"family": 6,
"choices": "choices"
}Response
Example response
{
"classifier_init_script": "classifier_init_script",
"vectorizer_stop_words": "vectorizer_stop_words",
"metadata": "{}",
"code": "code",
"allow_values_not_specified_in_choices": true,
"description": "description",
"long_code": "long_code",
"title": "title",
"type": "address",
"value_regexp": "value_regexp",
"trained_after_documents_number": 1280358509,
"unsure_choice_value": "unsure_choice_value",
"read_only": true,
"depends_on_fields": [
"depends_on_fields",
"depends_on_fields"
],
"requires_text_annotations": true,
"hide_until_python": "hide_until_python",
"document_type": "document_type",
"order": 4803,
"convert_decimals_to_floats_in_formula_args": true,
"dirty": true,
"confidence": "High",
"hide_until_js": "hide_until_js",
"default_value": "{}",
"unsure_thresholds_by_value": "{}",
"warning_message": "warning_message",
"text_unit_type": "sentence",
"mlflow_model_uri": "mlflow_model_uri",
"display_yes_no": true,
"training_finished": true,
"mlflow_detect_on_document_level": true,
"formula": "formula",
"value_detection_strategy": "disabled",
"hidden_always": true,
"category": 0,
"family": 6,
"choices": "choices"
}