Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
analyze
v1

MLModel List

get/api/v1/analyze/ml-model/list/

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

idinteger
namestring required

Model name, may include module parameters

versionstring required

Model version

vector_namestring nullable
model_pathstring required

Model path, relative to WebDAV root folder

is_activeboolean

Inactive models are ignored

defaultboolean

The default model is used unless another model is deliberately selected

apply_to'document' | 'text_unit' nullable required

Should the model be applied to documents or text units

target_entity'transformer' | 'classifier' | 'contract_type_classifier' | 'is_contract' nullable required

The model class

languagestring nullable required

Language (ISO 693-1) code, may be omitted

text_unit_type'sentence' | 'paragraph' nullable

Text unit type: sentence or paragraph

codebase_versionstring nullable

ContraxSuite version in which the model was created

user_modifiedboolean

User modified models are not automatically updated

projectinteger nullable

Optional project reference

Example response

[
  {
    "is_active": true,
    "project": 6,
    "vector_name": "vector_name",
    "language": "language",
    "version": "version",
    "model_path": "model_path",
    "user_modified": true,
    "text_unit_type": "sentence",
    "default": true,
    "name": "name",
    "apply_to": "document",
    "target_entity": "transformer",
    "id": 0,
    "codebase_version": "codebase_version"
  }
]