Analyse

Actions

NameDescription
analyse collection indexes

Analyse the indexes of the parsed files of a collection of documents

analyse index

Analyse an index

collection documents term combination

Combine the vocabulary terms extracted from the documents of a collection to create the terms of a collection vocabulary

collection documents term relation combination

Combine the term relations extracted from the documents of a collection to create the relations of a collection vocabulary

collection documents term relation use combination

Combine the term relation uses extracted from the documents of a collection to create the relation uses of the collection

collection documents term use combination

Combine the term uses extracted from the documents of a collection to create the uses of the collection

copy analysis objects

Copy the objects of an analysis to another analysis. The copied objects will have new ids.

remove analysis

Remove an analysis. If it is the analysis of a collection, do not remove analyses of its documents

remove collection analyses

Remove all analyes of a collection, but not of its documents

remove collection document analyses

Remove the analyses of the documents of a collection, but not of the collection itself

remove document analyses

Remove all analyses of a document

term extraction from collection documents

Extract definitions of key concepts from the documents of a collection

term relation extraction from collection documents

Extract relations between the terms of a vocabulary from the documents of a collection

term relation use extraction from collection documents

Extract uses of the relations of a vocabulary from the documents of a collection

term use extraction from collection documents

Extract uses of the terms of a vocabulary from the documents of a collection


Inputs

ActionNameDescription
[]|analyse collection indexesanalysis-type

The type of analysis to be performed

[]|analyse collection indexesinclude-headings

Whether to include section headings in the analysis

[]|analyse collection indexesindexed-collection-item

An item representing a collection whose documents have been parsed and indexed

[]|analyse collection indexesread-level

The item representing the read access level that the analysis is to have

[]|analyse indexanalysis-type

The type of analysis to be performed

[]|analyse indexinclude-headings

Whether to include section headings in the analysis

[]|analyse indexindex-item

The item representing the index to be analysed

[]|analyse indexread-level

The item representing the read access level that the analysis is to have

[]|collection documents term combinationanalysed-documents-collection-item

The item representing the collection whose document vocabularies are to be combined

[]|collection documents term combinationcollection-analysis-item

The item representing the analysis to be created

[]|collection documents term combinationdocument-analysis-type

The type of analysis to be performed on the collection documents

[]|collection documents term combinationread-level

The item representing the read access level that the vocabulary definitions are to have

[]|collection documents term relation combinationanalysed-documents-collection-item

The item representing the collection from whose documents the relations to be combined have been extracted

[]|collection documents term relation combinationcollection-analysis-item

The item representing the analysis to which the relations are to be added

[]|collection documents term relation combinationdocument-analysis-type

The type of analysis performed on the documents of the collection whose results are to be combined.

[]|collection documents term relation combinationread-level

The item representing the read access level that the combined relations are to have

[]|collection documents term relation combinationvocabulary-item

The item representing the vocabulary relations between whose terms are to be combined

[]|collection documents term relation use combinationanalysed-documents-collection-item

The item representing the collection from whose documents the uses to be combined have been extracted

[]|collection documents term relation use combinationcollection-analysis-item

The item representing the term use analysis of the collection that the relation uses are to be added to

[]|collection documents term relation use combinationdocument-analysis-type

The type of analysis to be performed

[]|collection documents term relation use combinationread-level

The item representing the read access level that the term relation uses are to have

[]|collection documents term relation use combinationvocabulary-item

The item representing the vocabulary uses of relations between whose terms are to be combined

[]|collection documents term use combinationanalysed-documents-collection-item

The item representing the collection from whose documents the uses to be combined have been extracted

[]|collection documents term use combinationcollection-analysis-item

The item representing the analysis to be created

[]|collection documents term use combinationdocument-analysis-type

The type of analysis to be performed

[]|collection documents term use combinationread-level

The item representing the read access level that the combined uses are to have

[]|collection documents term use combinationvocabulary-item

The item representing the vocabulary uses of whose terms are to be combined

[]|copy analysis objectsinput-analysis-item

The item representing the analysis from which the objects are to be copied

[]|copy analysis objectsoutput analysis item

The item representing the analysis to which the objects are to be copied

[]|remove analysisanalysis-item

The item representing the analysis to be removed

[]|remove collection analysesanalysis-name

The name of the analysis to be removed. If omitted, all analyses with the given analysis-type or, if this is omitted, all analyses are to be removed.

[]|remove collection analysesanalysis-type

The type of analysis to be removed. If omitted, all analyses with the given analysis-name or, if this is omitted, all analyses are to be removed.

[]|remove collection analysescollection-item

The item representing the collection whose analyses are to be removed

[]|remove collection document analysesanalysis-type

The type of analysis to be removed. If omitted, all analyses are to be removed.

[]|remove collection document analysescollection-item

The item representing the collection whose individual document analyses are to be removed

[]|remove document analysesanalysis-type

The type of analysis to be removed. If omitted, all analyses are to be removed.

[]|remove document analysesdocument-item

The item representing the document whose analyses are to be removed

[]|term extraction from collection documentsanalysis-type

The type of analysis to be performed

[]|term extraction from collection documentsparsed-collection-item

The item representing the collection that has been parsed and from which the vocabulary is to be extracted

[]|term extraction from collection documentsread-level

The item representing the read access level that the vocabulary definitions are to have

[]|term relation extraction from collection documentsanalysis-type

The type of analysis to be performed

[]|term relation extraction from collection documentsparsed-collection-item

The item representing the collection that has been parsed and from which the relations are to be extracted

[]|term relation extraction from collection documentsread-level

The item representing the read access level that the relations are to have

[]|term relation extraction from collection documentsterm-use-analysis-item

The item representing the analysis of uses of terms between which relations are to be extracted

[]|term relation extraction from collection documentsvocabulary-item

The item representing the vocabulary, relations between whose terms are to be extracted

[]|term relation use extraction from collection documentsanalysis-type

The type of term relation use extraction analysis to be performed

[]|term relation use extraction from collection documentscollection-analysis-item

The completed analysis of the collection for vocabulary term uses

[]|term relation use extraction from collection documentsparsed-collection-item

The item representing the collection from whose documents uses of relations between the vocabulary terms are to be extracted

[]|term relation use extraction from collection documentsread-level

The item representing the read access level that the term relation uses are to have

[]|term relation use extraction from collection documentsuse-analysed-collection-item

The item representing the collection that has been analysed for term uses and that is to be analysed for term relation uses

[]|term relation use extraction from collection documentsvocabulary-item

The item representing the vocabulary uses of whose term relations are to be extracted

[]|term use extraction from collection documentsanalysis-type

The type of term use extraction analysis to be performed

[]|term use extraction from collection documentsparsed-collection-item

The item representing the collection from whose documents uses of the vocabulary terms are to be extracted

[]|term use extraction from collection documentsread-level

The item representing the read access level that the term uses are to have

[]|term use extraction from collection documentsvocabulary-item

The item representing the vocabulary uses of whose terms are to be extracted


Outputs

ActionNameDescription
[]|analyse collection indexesanalysis-item

The item representing the analysis of the collection whose parsed and indexed documents have been analysed

[]|analyse indexanalysis-item

The item representing the analysis that is created

[]|collection documents term combinationanalysed-collection-item

The item representing the collection whose document vocabularies have been combined

[]|collection documents term relation combinationanalysed-collection-item

The item representing the collection whose document term relations have been combined

[]|collection documents term relation use combinationanalysed-collection-item

The item representing the collection whose document term relation uses have been combined

[]|collection documents term use combinationanalysed-collection-item

The item representing the collection whose document term uses have been combined

[]|term extraction from collection documentsanalysed-documents-collection-item

The item representing the collection from whose documents the vocabulary has been extracted

[]|term relation extraction from collection documentsanalysed-documents-collection-item

The item representing the collection from whose documents the term relations have been extracted

[]|term relation use extraction from collection documentsanalysed-documents-collection-item

The item representing the collection from whose documents the term relation uses have been extracted

[]|term use extraction from collection documentsanalysed-documents-collection-item

The item representing the collection from whose documents the term uses have been extracted

Local Run Sequence

["python3", "-m", "analyser", "$API", "$CRED", "$KEY", "/Users/chrisharding/nlp/models/all-MiniLM-L6-v2"]