Update a metric
patch
/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBaseMetrics/{KnowledgeBaseName}
Request
Path Parameters
-
KnowledgeBaseName(required): string
Name of the knowledge base.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CategoryId: integer
Value that uniquely identifies the category.
-
Keyword: string
Maximum Length:
255
A word within a transaction, usually separated by space, comma or identified based on the lexer definition. -
NewKnowledgeBaseName: string
Maximum Length:
255
Name of the knowledge base created after improvements are done to its training sets. -
OperationName: string
Maximum Length:
255
Name of the action performed on the transactions in a training set. -
OrphanTransactionsCount: integer
(int32)
Number of transactions that do not have category assignments.
-
TransactionList: string
Maximum Length:
255
List of transactions satisfying a specified criteria.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : spendClassificationKnowledgeBaseMetrics-item-response
Type:
Show Source
object
-
AttributesCount: integer
(int32)
Read Only:
true
Number of significant attributes populated in the training set. -
CategoryId: integer
Value that uniquely identifies the category.
-
ConflictingKeywordsCount: integer
(int32)
Read Only:
true
Number of keywords that appear in training records of more than two categories. -
DataSetNames: string
Read Only:
true
Maximum Length:2000
Data set name. -
DatasetSynchronizedFlag: boolean
Read Only:
true
Indicates if the data set is synchronized. -
EffectivelyTrainedCategoriesCount: integer
(int32)
Read Only:
true
Number of categories that have overall training confidence more than 80. -
Keyword: string
Maximum Length:
255
A word within a transaction, usually separated by space, comma or identified based on the lexer definition. -
KnowledgeBaseName: string
Read Only:
true
Maximum Length:90
Name of the knowledge base. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the knowledge base was updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewKnowledgeBaseName: string
Maximum Length:
255
Name of the knowledge base created after improvements are done to its training sets. -
OperationName: string
Maximum Length:
255
Name of the action performed on the transactions in a training set. -
OrphanCategoriesCount: integer
(int32)
Read Only:
true
Number of categories in the taxonomy for which no training has been provided. -
OrphanTransactionsCount: integer
(int32)
Number of transactions that do not have category assignments.
-
PhraseAttributes: string
Read Only:
true
Maximum Length:4000
Attributes selected for phrase-based learning. -
TaxonomyId: integer
(int64)
Read Only:
true
Value that uniquely identifies a taxonomy. -
TaxonomyName: string
Read Only:
true
Maximum Length:80
Name of the taxonomy. -
TaxonomySynchronizedFlag: boolean
Read Only:
true
Indicates if the taxonomy is synchronized. -
TrainingAccuracy: number
Read Only:
true
Percentage of training records having confidence more than 80, when classified using the same knowledge base they were used to create. -
TrainingExclusionsCount: integer
(int32)
Read Only:
true
Number of keywords that have been added as training exclusions for the knowledge base. -
TrainingRecordsCount: integer
(int64)
Read Only:
true
Total number of transactions used to create the knowledge base. -
TransactionList: string
Maximum Length:
255
List of transactions satisfying a specified criteria. -
UnderTrainedCategoriesCount: integer
(int32)
Read Only:
true
Number of categories having overall confidence less than 80, when classified using the same knowledge base they were used to create.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.