DocumentClassification
Request | Response | Model | |
---|---|---|---|
Classify | ClassifyDocumentOnlineRequest | ClassificationResponse | ClassificationResult |
ClassifyDocumentRequest | |||
ClassifyRequest |
ClassificationResult
Represents a single classification result.
This class is used in ClassificationResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
ClassName | string | Gets or sets the name of the class. |
ClassProbability | double | Gets or sets the probability of class. |
ClassificationResponse
Represents a REST response with data on multi-class text classification.
This class is inherited from WordsResponse and used in WordsApi.
The following properties are defined:
Property | Type | Description |
---|---|---|
RequestId | string | Gets or sets the request Id. |
BestClassName | string | Gets or sets the best class name. |
BestClassProbability | double | Gets or sets the best class probability. |
BestResults | List<ClassificationResult> | Gets or sets the array of best classes results. |
ClassifyDocumentOnlineRequest
Represents a request model for WordsApi.ClassifyDocumentOnline() operation.
An object of the ClassifyDocumentOnlineRequest class is created by the following constructor methods:
- ClassifyDocumentOnlineRequest()
- ClassifyDocumentOnlineRequest(Stream document, string loadEncoding, string password, string encryptedPassword, string bestClassesCount, string taxonomy)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
bestClassesCount | BestClassesCount | string | The number of the best classes to return. |
taxonomy | Taxonomy | string | The taxonomy to use. |
ClassifyDocumentRequest
Represents a request model for WordsApi.ClassifyDocument() operation.
An object of the ClassifyDocumentRequest class is created by the following constructor methods:
- ClassifyDocumentRequest()
- ClassifyDocumentRequest(string name, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string bestClassesCount, string taxonomy)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The document name. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
bestClassesCount | BestClassesCount | string | The number of the best classes to return. |
taxonomy | Taxonomy | string | The taxonomy to use. |
ClassifyRequest
Represents a request model for WordsApi.Classify() operation.
An object of the ClassifyRequest class is created by the following constructor methods:
- ClassifyRequest()
- ClassifyRequest(string text, string bestClassesCount)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
text | Text | string | The text to classify. |
bestClassesCount | BestClassesCount | string | The number of the best classes to return. |