public class InformationExtractionTrainerSpecification extends TieInformationExtractionAbstractSpecification
Modifier and Type | Field and Description |
---|---|
static String |
CLASS_NAME
The name of the ClassObject representing this class.
|
static String |
NAME_ATTRIBUTE
The name of the Attribute representing
The name of the InformationExtractionTrainerSpecification.
|
static String |
RESULTSET_ATTRIBUTE
The name of the Attribute representing
the result set managed by this instance.
|
static String |
SETTING_KEY_TRAININGSET
The setting key for the InformationExtractionTrainingSet.
|
static String |
TRAINERCLASSNAME_ATTRIBUTE
The name of the Attribute representing
Fully-qualified class name of the InformationExtractionTrainer class.
|
static String |
TRAININGSET_ATTRIBUTE
The name of the Attribute representing
the training set managed by this instance.
|
DESCRIPTION_ATTRIBUTE, SETTINGS_ATTRIBUTE
ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE
DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session
Constructor and Description |
---|
InformationExtractionTrainerSpecification(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Construct a InformationExtractionTrainerSpecification object.
|
Modifier and Type | Method and Description |
---|---|
Document |
createCoreNlpRegexRuleDocument(InformationExtractionDomainSpecification dspec,
InformationExtractionParserSpecification pspec,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the CoreNLP REGEX Rules model by creating a new model Document.
|
Document |
createDependencyMatcherRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec,
InformationExtractionParserSpecification pspec,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the JSON representation of the DependencyMatcher REGEX Rules
by creating a new Document.
|
Document |
createEntityRulerRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec,
InformationExtractionParserSpecification pspec,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the JSON representation of the EntityRuler REGEX Rules
by creating a new Document.
|
SimplePropertyTable |
createExportSet(String exportSetName)
Creates a training ExportSet for the name specified.
|
Document |
createNerClassifierDocument(InformationExtractionParserSpecification pspec,
AttributeValueTable trainingProps,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the NER Classifier model by creating a new NER Classifier Document.
|
Document |
createRegexPatternDocument(InformationExtractionDomainSpecification dspec,
InformationExtractionParserSpecification pspec,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the REGEX Pattern model by creating a new model Document.
|
Document |
createRegexPatternJsonDocument(InformationExtractionDomainSpecification dspec,
InformationExtractionParserSpecification pspec,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the JSON representation of the REGEX Patterns
by creating a new Document.
|
Document |
createRelationMentionModelDocument(InformationExtractionParserSpecification pspec,
AttributeValueTable trainingProps,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the RelationMention model by creating a new model Document.
|
Document |
createSpacyClassifierDocument(InformationExtractionParserSpecification pspec,
AttributeValueTable trainingProps,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the Spacy Classifier model by creating a new Spacy NER Classifier Document.
|
Document |
createTokenMatcherRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec,
InformationExtractionParserSpecification pspec,
String docName,
String docDesc,
AccessControlList docAcl,
Folder docFolder,
boolean addAsVersion)
Updates the JSON representation of the TokenMatcher REGEX Rules
by creating a new Document.
|
void |
exportNerClassifierModelData(String absFileName,
AttributeValueTable options)
Exports the NER Classifier training data to the specified file.
|
void |
exportRelationMentionModelData(String absFileName,
AttributeValueTable options)
Exports the RelationMention training data to the specified file.
|
static InformationExtractionTrainerSpecification[] |
findAll(LibrarySession session)
Returns the set of defined InformationExtractionTrainerSpecifications.
|
static InformationExtractionTrainerSpecification |
findByName(LibrarySession session,
String name)
Returns the a InformationExtractionTrainerSpecification matching the
specified name.
|
SimplePropertyTable |
getExportSet(String exportSetName)
Gets a training ExportSet for the name specified.
|
InformationExtractionResultSet |
getInformationExtractionResultSet()
Gets the InformationExtractionResultSet defined on this instance.
|
InformationExtractionTrainer |
getInformationExtractionTrainer()
Gets the InformationExtractionTrainer instance implementation
corresponding to the TrainerClassName attribute setting.
|
InformationExtractionTrainer |
getInformationExtractionTrainer(String className)
Gets the InformationExtractionTrainer instance implementation
corresponding to the specified class name.
|
InformationExtractionTrainingSet |
getInformationExtractionTrainingSet()
Gets the InformationExtractionTrainingSet defined on this instance.
|
static LibraryObjectLookupCache |
getLibraryObjectLookupCache(LibrarySession session)
Returns the LibraryObjectLookupCache used by find
InformationExtractionTrainerSpecification instances by name.
|
String |
getTrainerClassName()
Gets Fully-qualified class name of the InformationExtractionTrainer class.
|
boolean |
hasNameAttribute()
Returns true if this object is an instance of a class
that has a NAME attribute, and false otherwise.
|
void |
importNerClassifierModelData(String absFileName,
boolean append,
String docName,
String docDesc,
AccessControlList docAcl)
Imports NER Classifier training data from the specified file.
|
void |
importRelationMentionModelData(String absFileName,
boolean append,
String docName,
String docDesc,
AccessControlList docAcl)
Imports RelationMention training data from the specified file.
|
void |
removeExportSet(String exportSetName,
boolean freeExportSet)
Removes a training ExportSet for the name specified.
|
void |
setInformationExtractionResultSet(InformationExtractionResultSet rset)
Sets the InformationExtractionResultSet on this instance.
|
void |
setInformationExtractionTrainingSet(InformationExtractionTrainingSet tset)
Sets the InformationExtractionTrainingSet on this instance.
|
addSetting, getDescription, getSetting, getSettings, postCreate, preFree, preUpdate
addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postUpdate, preCreate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists
added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAttributeByUpperCaseName, getClassId, getId, getSessionInterface
getTraceLogger, isTraced, trace
public static final String CLASS_NAME
public static final String NAME_ATTRIBUTE
public static final String TRAINERCLASSNAME_ATTRIBUTE
public static final String TRAININGSET_ATTRIBUTE
public static final String RESULTSET_ATTRIBUTE
public static final String SETTING_KEY_TRAININGSET
public InformationExtractionTrainerSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- current LibrarySessionid
- object idclassId
- class iddata
- data componentIfsException
- if the operation failspublic boolean hasNameAttribute() throws IfsException
LibraryObject
hasNameAttribute
in class InformationExtractionAbstractSpecification
IfsException
- if operation fails.public String getTrainerClassName() throws IfsException
IfsException
- if the operation failspublic InformationExtractionTrainer getInformationExtractionTrainer() throws IfsException
IfsException
- if the operation failspublic InformationExtractionTrainer getInformationExtractionTrainer(String className) throws IfsException
className
- the fully qualified class nameIfsException
- if the operation failspublic InformationExtractionResultSet getInformationExtractionResultSet() throws IfsException
IfsException
- if the operation failspublic void setInformationExtractionResultSet(InformationExtractionResultSet rset) throws IfsException
tset
- the InformationExtractionResultSet settingIfsException
- if the operation failspublic InformationExtractionTrainingSet getInformationExtractionTrainingSet() throws IfsException
IfsException
- if the operation failspublic void setInformationExtractionTrainingSet(InformationExtractionTrainingSet tset) throws IfsException
tset
- the InformationExtractionTrainingSet settingIfsException
- if the operation failspublic Document createNerClassifierDocument(InformationExtractionParserSpecification pspec, AttributeValueTable trainingProps, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
pspec
- the Parser Specification to apply updated modeltrainingProps
- the training property overridesdocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic Document createSpacyClassifierDocument(InformationExtractionParserSpecification pspec, AttributeValueTable trainingProps, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
pspec
- the Parser Specification to apply updated modeltrainingProps
- the training property overridesdocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic Document createRelationMentionModelDocument(InformationExtractionParserSpecification pspec, AttributeValueTable trainingProps, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
pspec
- the Parser Specification to apply updated modeltrainingProps
- the training property overridesdocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic Document createRegexPatternDocument(InformationExtractionDomainSpecification dspec, InformationExtractionParserSpecification pspec, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
dspec
- the Domain Specification that contains the source
REGEX patternspspec
- the Parser Specification to apply updated modeldocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic Document createRegexPatternJsonDocument(InformationExtractionDomainSpecification dspec, InformationExtractionParserSpecification pspec, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
dspec
- the Domain Specification that contains the source
REGEX patternspspec
- the Parser Specification to apply updated modeldocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic Document createEntityRulerRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec, InformationExtractionParserSpecification pspec, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
dspec
- the Domain Specification that contains the source
REGEX rulespspec
- the Parser Specification to apply updated modeldocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic Document createTokenMatcherRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec, InformationExtractionParserSpecification pspec, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
dspec
- the Domain Specification that contains the source
REGEX rulespspec
- the Parser Specification to apply updated modeldocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic Document createDependencyMatcherRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec, InformationExtractionParserSpecification pspec, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
dspec
- the Domain Specification that contains the source
REGEX rulespspec
- the Parser Specification to apply updated modeldocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic Document createCoreNlpRegexRuleDocument(InformationExtractionDomainSpecification dspec, InformationExtractionParserSpecification pspec, String docName, String docDesc, AccessControlList docAcl, Folder docFolder, boolean addAsVersion) throws IfsException
dspec
- the Domain Specification that contains the source
REGEX rulespspec
- the Parser Specification to apply updated modeldocName
- the name to use for the new training documentdocDesc
- the description to use for the new training documentdocAcl
- the ACL to use for the new training documentdocFolder
- the Parent folder for the new training documentaddAsVersion
- whether to add the new training Document as a versionIfsException
- if the operation failspublic SimplePropertyTable createExportSet(String exportSetName) throws IfsException
If an existing ExportSet exists with that name, the existing ExportSet will be returned.
exportSetName
- the export set nameIfsException
- if the operation failspublic SimplePropertyTable getExportSet(String exportSetName) throws IfsException
If an existing ExportSet does not exist with that name, null is returned.
exportSetName
- the export set nameIfsException
- if the operation failspublic void removeExportSet(String exportSetName, boolean freeExportSet) throws IfsException
If an existing ExportSet does not exist with that name, no exception is thrown.
exportSetName
- the export set namefreeExportSet
- whether to free the SimplePropertyTable object
that was removedIfsException
- if the operation failspublic void exportNerClassifierModelData(String absFileName, AttributeValueTable options) throws IfsException
absFileName
- the file name that will hold the exported dataoptions
- the options that control the set of documents exportedIfsException
- if the operation failspublic void exportRelationMentionModelData(String absFileName, AttributeValueTable options) throws IfsException
absFileName
- the file name that will hold the exported dataoptions
- the options that control the set of documents exportedIfsException
- if the operation failspublic void importNerClassifierModelData(String absFileName, boolean append, String docName, String docDesc, AccessControlList docAcl) throws IfsException
absFileName
- the file name that holds the data to be importedappend
- whether to append the data to any current training data;
if false, replaces the current data with the import datadocName
- the name to use for the new training data DocumentdocDesc
- the description to use for the new training data DocumentdocAcl
- the ACL to use for the new training data DocumentIfsException
- if the operation failspublic void importRelationMentionModelData(String absFileName, boolean append, String docName, String docDesc, AccessControlList docAcl) throws IfsException
absFileName
- the file name that holds the data to be importedappend
- whether to append the data to any current training data;
if false, replaces the current data with the import datadocName
- the name to use for the new training data DocumentdocDesc
- the description to use for the new training data DocumentdocAcl
- the ACL to use for the new training data DocumentIfsException
- if the operation failspublic static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session) throws IfsException
session
- the session contextIfsException
- if the operation fails.public static InformationExtractionTrainerSpecification[] findAll(LibrarySession session) throws IfsException
The instances will be sorted by name.
session
- the session contextIfsException
- if the operation fails.public static InformationExtractionTrainerSpecification findByName(LibrarySession session, String name) throws IfsException
InformationExtractionTrainerSpecification names are case sensitive, so this operations requires an exact match with respect to case.
session
- the session contextname
- the InformationExtractionTrainerSpecification nameIfsException
- if the operation fails.Copyright © 2023. All rights reserved.