This section details the classes in the Classify service.
An instance of this class is created on the client. It is used with the Classify() method to pass options to the Content Classification Service.
The class has the following properties:
Defines a locale so that results and error messages can be returned in the correct language.
Type: String
Format: A Microsoft LCID value, for example, ‘en-us’.
Default: The locale of the Content Classification Service installation.
Specifies the action that the Content Classification Service takes regarding the content. Refer to the AnalyzeDataActionType for details.
Type: AnalyzeDataActionType
(Optional) Specifies a timeout. If the results are not available in the specified number of milliseconds, return to the caller, but continue to classify the data on the server.
Note: Even with the default value, the call is eventually timed out by the IIS web server.
Type: uint
Default: 0, no timeout
(Optional) Specifies a classification age filter. If the cached classifications are older than the value passed in, then the content is reclassified, or the existing classifications are not returned.
Type: CCSAge
Default: No filtering or reclassification
(Optional) Specifies a modification age filter.
If this value is set to zero and the content's last modified date is later than the date of the current classification, the content is reclassified.
If this value is set to a positive value such as '5 days', the content's last modified date must be at least 5 days younger than the date of the current classification to provoke a reclassification. This can be useful for documents that are expected to be subject to frequent but minor updates.
Type: CCSAge
Default: No filtering or reclassification
Allows the content to be reclassified based on its last modified time. If the content’s last modified time is different from the last modified time stored with the cached classifications, the content is reclassified or the existing classifications are not returned.
Type: Boolean
Default: False
Specifies whether the caller wants the classifications returned.
Type: Boolean
Default: False
Specifies whether the generated classifications are not added to the cache.
Note: The default False value means the classification is cached.
Type: Boolean
Default: False
(Optional) Specifies which Dictionary Classifications are used for analysis or returned in the results. The filter is a list of ClassificationID values.
Type: ClassificationsFilterList
Default: No filtering
Specifies the list of content identifiers that you want to classify.
Type: ContentIdentifierList
Specifies the location type of the data.
Type: DataLocationType
(Optional) Defines content to be classified. Only required if the content data is being passed in.
Type: Byte Array
(Not implemented in the current version) Specifies whether to return diagnostic information about the classification process in the results.
Type: Boolean
Default: False
Contains the result information from the Classify method.
The class has the following properties:
Indicates the type of error; Information, Warning, or Error.
Type: CCSResultType
Indicates the error code. 0 = Success.
Other codes are CA Data Protection errors that can be used for reporting and diagnostics.
Type: Int
Indicates the CA Data Protection error message for the ErrorCode.
Type: String
Indicates a list of ClassificationItem objects.
Type: ClassificationsList
Indicates the date and time (in UTC) when the item was classified.
Type: DateTime
Creates a list of ClassificationsFilterItem objects. The specific methods depend on the client tools and environment used to process the WSDL.
Creates a filter based on ClassifiicationID.
The class has the following properties:
Specifies the unique identifier of the Dictionary Classification
Type: String
Creates a list of ClassificationItem objects. The specific methods depend on the client tools and environment used to process the WSDL.
An instance of this class is returned for each classification that is available for the submitted content identifiers.
The class has the following properties:
Indicates the unique id from the DictionaryClassification item.
Type: String
Indicates the date/time (UTC) when this classification was created.
Type: DateTime
Indicates the confidence rating of this classification. Initially, this rating will be the Confidence value as set on the DictionaryClassification, but this may change in the future to indicate the confidence in the classification of the content.
Type: uint
(Not implemented in the current version) Indicates diagnostic information related to generating this classification. Only available if ClassificationArgs.DiagnosticsOn is set to True.
Type: String
Creates a list of ContentIdentifier objects. The specific methods depend on the client tools and environment used to process the WSDL.
This class is used to pass information about the content to be classified. In most cases, a single content identifier is sufficient, but there are situations that require more than one identifier.
If you want to associate more than one Identifier with the content, you can use a single Classify call and add additional ContentIdentifer items to the list.
If the content must be retrieved, only one identifier can be marked with ‘CanAccessContent = True’. If multiple identifiers are marked in this way, the CCS handles them as an error and the call fails. The caller is responsible for making sure that the content referenced by the identifiers is the same.
If the identifier you want to add to the Classification cache is different from the identifier needed to access the data, add a ContentIdentifier for each identifier:
The class has the following properties:
Specifies the type of identifier.
Type: ContentIdentifierType
Specifies an identifier for the content.
Type: string
Format: The format must match the Identifier type.
The string format can be any legitimate format for the Identifier type. But if your application uses the CCS Preclassification Agent, you must follow the following normalization rules:
If you follow these normalization rules, you maximize the probability of finding a matching classification in the CCS cache for any subsequent classification requests made using the API.
(Optional) Specifies the last modified time (UTC) of the content. Only required when reclassifying content based on the last modified date of the content and when CanRetrieveLastModifiedDate is set to False.
Type: DateTime
Specifies whether this ContentIdentifier can be used to access the content if necessary.
Type: Boolean
Default: False
Specifies whether the Content Classification Service attempts to retrieve the last modified date of the content.
Do not set this property to True if the LastModified property is set.
Type: Boolean
Default: False
(Optional) Defines the access credentials. Only required if the Content Classification Service needs it to access the content.
Type: ContentIdentifierCredentials
Specifies whether this identifier is not added to the classifications cache.
Note: Take care when setting this counter-intuitive property. The default False value means the identifier is cached. Set this value to False for an AnalyzeAction.None request.
Type: Boolean
Default: False
Defines the credentials that are passed to the CCS and which enable the CCS to retrieve the content to be classified.
The class has the following properties:
Defines the scheme identifier.
Type: String
Defines the credentials data.
Type:Byte Array
|
Copyright © 2015 CA Technologies.
All rights reserved.
|
|