Jump to

• Request
• Response

Classify a transaction

post

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

Classifies a transaction and provides category suggestions using machine learning or GenAI.

Request

Path Parameters

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

Header Parameters

• Metadata-Context: string
  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: string
  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

• classificationMode: string
  Value that determines whether GenAI or ML to be used for classification.
• generateKeywordsFlag: string
  Contains one of the following values: Y or N. If Y, then the keywords are generated while classifying the transaction. If N, then the keywords aren???t generated. The default value is N.
• knowledgeBaseName: string
  Name of the knowledge base that includes the knowledge or patterns available in a data set.
• taxonomyId: number
  Value that uniquely identifies the taxonomy.
• transactionDescription: string
  Description of the transaction.

{
    "type":"object",
    "properties":{
        "taxonomyId":{
            "type":"number",
            "description":"Value that uniquely identifies the taxonomy.",
            "nullable":true
        },
        "knowledgeBaseName":{
            "type":"string",
            "description":"Name of the knowledge base that includes the knowledge or patterns available in a data set.",
            "nullable":true
        },
        "generateKeywordsFlag":{
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the keywords are generated while classifying the transaction. If N, then the keywords aren???t generated. The default value is N.",
            "nullable":true
        },
        "transactionDescription":{
            "type":"string",
            "description":"Description of the transaction.",
            "nullable":true
        },
        "classificationMode":{
            "type":"string",
            "description":"Value that determines whether GenAI or ML to be used for classification.",
            "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, then this action returns the top 3 predicted categories along with the confidence threshold.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"If the request is successful, then this action returns the top 3 predicted categories along with the confidence threshold."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"If the request is successful, then this action returns the top 3 predicted categories along with the confidence threshold."
}

If the request is successful, then this action returns the top 3 predicted categories along with the confidence threshold.

Back to Top