Sign in
document
v1

Retrieve Document Field

get/api/v1/document/document-fields/{uid}/

Path parameters

uidstring required

A UUID string identifying this document field.

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

uidstring uuid
document_typestring nullable required
codestring required

Field codes must be lowercase, should start with a Latin letter, and contain only Latin letters, digits, underscores. Field codes must be unique to every Document Type.

long_codestring
titlestring required
descriptionstring nullable
type'address' | 'amount' | 'boolean' | 'choice' | 'company' | 'date' | 'date_recurring' | 'datetime' | 'duration' | 'float' | 'geography' | 'int' | 'linked_documents' | 'money' | 'multi_choice' | 'percent' | 'person' | 'ratio' | 'related_info' | 'string' | 'string_no_word_wrap' | 'text'
text_unit_type'sentence' | 'paragraph' | 'section'
value_detection_strategy'disabled' | 'use_regexps_only' | 'regexp_table' | 'use_formula_only' | 'regexps_and_text_based_ml' | 'text_based_ml_only' | 'formula_and_fields_based_ml' | 'fields_based_ml_only' | 'fields_based_prob_ml_only' | 'python_coded_field' | 'field_based_regexps' | 'mlflow_model'
python_coded_field'generic.EarliestDate' | 'generic.LatestDate' | 'generic.MaxCurrency' | 'generic.Parties' | 'similarity.SimilarDocuments' nullable
classifier_init_scriptstring nullable
formulastring nullable
convert_decimals_to_floats_in_formula_argsboolean

Floating point field values are represented in Python Decimal type to avoid rounding problems in machine numbers representations. Use this checkbox for converting them to Python float type before calculating the formula. Float: 0.1 + 0.2 = 0.30000000000000004. Decimal: 0.1 + 0.2 = 0.3.

value_regexpstring nullable

This regular expression is run on the sentence found by a Field Detector and extracts a specific string value from a Text Unit. The first matching group is used if the regular expression returns multiple matching groups. This is only applicable to string fields.

depends_on_fieldsstring
confidence'High' | 'Medium' | 'Low' nullable
requires_text_annotationsboolean
read_onlyboolean
categorystring
familyinteger nullable
default_valueobject nullable

When populated, this default value is displayed in the user interface’s annotator sidebar for the associated field. If not populated, the Field Value remains empty by default. Please wrap entries with quotes, example: “landlord”. This is only applicable to Choice and Multichoice fields.

choicesstring
allow_values_not_specified_in_choicesboolean
stop_wordsobject nullable
metadataobject nullable
training_finishedboolean
dirtyboolean
orderinteger
trained_after_documents_numberinteger
hidden_alwaysboolean
hide_until_pythonstring nullable
hide_until_jsstring nullable
detect_limit_unit'NONE' | 'UNIT'

Choose to add an upward limit to the amount of document text ContraxSuite will search for this Document Field. For example, you can choose to only search the first 10 paragraphs of text for the value required (this often works best for values like “Company,” “Execution Date,” or “Parties,” all of which typically appear in the first few paragraphs of a contract).

detect_limit_countinteger

Specify the maximum range for a bounded search. Field detection begins at the top of the document and continues until this Nth "Detect limit unit" element.

display_yes_noboolean

Checking this box will display “Yes” if Related Info text is found, and display “No” if no text is found.

value_awarestring
created_byinteger nullable
modified_byinteger nullable required
created_datestring date-time
modified_datestring date-time
vectorizer_stop_wordsstring nullable

Stop words for vectorizers user in field-based ML field detection. These stop words are excluded from going into the feature vector part build based on this field. In addition to these words the standard sklearn "english" word list is used. Format: each word on new line

unsure_choice_valuestring nullable

Makes sense for machine learning strategies with "Unsure" category. The strategy will return this value if probabilities of all other categories appear lower than the specified threshold.

unsure_thresholds_by_valueobject nullable

Makes sense for machine learning strategies with "Unsure" category. The strategy will return concrete result (one of choice values) only if the probability of the detected value is greater than this threshold. Otherwise the strategy returns None or the choice value specified in "Unsure choice value" field. Format: { "value1": 0.9, "value2": 0.5, ...}. Default: 0.9

mlflow_model_uristring nullable

MLFlow model URI understandable by the MLFlow artifact downloading routines.

mlflow_detect_on_document_levelboolean

If true - whole document text will be sent to the MLFlow model and the field value will be returned for the whole text with no annotations. If false - each text unit will be sent separately.

Example response

{
  "classifier_init_script": "classifier_init_script",
  "vectorizer_stop_words": "vectorizer_stop_words",
  "metadata": "{}",
  "code": "code",
  "allow_values_not_specified_in_choices": true,
  "detect_limit_count": 413233370,
  "description": "description",
  "long_code": "long_code",
  "title": "title",
  "type": "address",
  "value_regexp": "value_regexp",
  "trained_after_documents_number": 314780941,
  "unsure_choice_value": "unsure_choice_value",
  "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "read_only": true,
  "stop_words": "{}",
  "depends_on_fields": "depends_on_fields",
  "value_aware": "value_aware",
  "requires_text_annotations": true,
  "hide_until_python": "hide_until_python",
  "python_coded_field": "generic.EarliestDate",
  "document_type": "document_type",
  "order": 19750,
  "convert_decimals_to_floats_in_formula_args": true,
  "dirty": true,
  "confidence": "High",
  "hide_until_js": "hide_until_js",
  "default_value": "{}",
  "modified_date": "2000-01-23T04:56:07.000+00:00",
  "unsure_thresholds_by_value": "{}",
  "created_by": 5,
  "text_unit_type": "sentence",
  "mlflow_model_uri": "mlflow_model_uri",
  "display_yes_no": true,
  "training_finished": true,
  "mlflow_detect_on_document_level": true,
  "detect_limit_unit": "NONE",
  "modified_by": 2,
  "formula": "formula",
  "value_detection_strategy": "disabled",
  "hidden_always": true,
  "created_date": "2000-01-23T04:56:07.000+00:00",
  "category": "category",
  "family": 0,
  "choices": "choices"
}

Changes