Jump to

• Request
• Response

Create a sample training set.

post

/fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/createSample

Creates a sample training set that contains the subset of unique transactions in the data set.

Request

Path Parameters

• DataSetName(required): string
  Name of the data set.

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• algorithm: string
  Name of algorithm used to create the sample training set.
• businessUnitId: number
  Value that uniquely identifies the business unit.
• cleanMetaData: string
  Contains one of the following values: Y or N. If Y, then the metadata is removed while creating the sample training set. If N, then the metadata is retained. The default value is Y
• clusterSize: number
  Number of similar objects that are grouped together as a cluster.
• distanceFactor: string
  Method used to determine the distance between two keywords within a cluster. In data mining, similarity is measured as the distance with dimensions describing object features.
• fromDate: string (date)
• maximumWords: number
  Maximum number of words that can be extracted from a transaction by the extraction algorithms.
• toDate: string (date)
• trainingSetName: string
  Name of the sample training set.
• volume: number
  Number that indicates the percentage of transactions used to create the sample training set.

{
    "type":"object",
    "properties":{
        "volume":{
            "type":"number",
            "description":"Number that indicates the percentage of transactions used to create the sample training set.",
            "nullable":true
        },
        "fromDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "cleanMetaData":{
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the metadata is removed while creating the sample training set. If N, then the metadata is retained. The default value is Y",
            "nullable":true
        },
        "toDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "distanceFactor":{
            "type":"string",
            "description":"Method used to determine the distance between two keywords within a cluster. In data mining, similarity is measured as the distance with dimensions describing object features.",
            "nullable":true
        },
        "maximumWords":{
            "type":"number",
            "description":"Maximum number of words that can be extracted from a transaction by the extraction algorithms.",
            "nullable":true
        },
        "trainingSetName":{
            "type":"string",
            "description":"Name of the sample training set.",
            "nullable":true
        },
        "businessUnitId":{
            "type":"number",
            "description":"Value that uniquely identifies the business unit.",
            "nullable":true
        },
        "algorithm":{
            "type":"string",
            "description":"Name of algorithm used to create the sample training set.",
            "nullable":true
        },
        "clusterSize":{
            "type":"number",
            "description":"Number of similar objects that are grouped together as a cluster.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  If the request is successful, this action returns the sample training data set.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"If the request is successful, this action returns the sample training data set."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"If the request is successful, this action returns the sample training data set."
}

If the request is successful, this action returns the sample training data set.

Back to Top