Jump to

• Request
• Response
• Examples

Train an Intelligence Model

post

/rest/v19/intelligenceSetup/models/{modelId}/actions/train

Use this endpoint start an intelligence model training session.

Request

Supported Media Types

• application/json

Path Parameters

• modelId(required): integer(int64)

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : IntelligenceTraining

Type: object

Show Source

• analyticsInfo: string()
  Title: Training Information

  Read Only: true

  Information about the training.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Training.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Training.
• duration: integer()
  Title: Duration

  Read Only: true

  Training duration.
• id: integer()
  Title: ID

  Read Only: true

  ID of the Intelligence Training.
• lastDeployed: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Last Deployed

  Read Only: true

  Date of the training's last deployment.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• learningTimeElapsed: string()
  Title: Learning Time

  Read Only: true

  Learning time elapsed.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• message: string()
  Title: Message

  Read Only: true

  Training message.
• status: string()
  Title: Status

  Read Only: true

  Allowed Values: [ "Started", "Completed", "Failed" ]

  Training status.
• testErrorRate: number()
  Title: Test Error Rate

  Read Only: true

  Test error rate.
• totalRecords: integer()
  Title: Total Records

  Read Only: true

  Total number of records used for training.
• trainingErrorRate: number()
  Title: Training Error Rate

  Read Only: true

  Training error rate.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"ID of the Intelligence Training.",
            "title":"ID",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Training.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Training.",
            "title":"Date Added",
            "readOnly":true
        },
        "learningTimeElapsed":{
            "type":"string",
            "format":"",
            "description":"Learning time elapsed.",
            "title":"Learning Time",
            "readOnly":true
        },
        "duration":{
            "type":"integer",
            "format":"",
            "description":"Training duration.",
            "title":"Duration",
            "readOnly":true
        },
        "trainingErrorRate":{
            "type":"number",
            "format":"",
            "description":"Training error rate.",
            "title":"Training Error Rate",
            "readOnly":true
        },
        "testErrorRate":{
            "type":"number",
            "format":"",
            "description":"Test error rate.",
            "title":"Test Error Rate",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "format":"",
            "description":"Training status.",
            "title":"Status",
            "readOnly":true,
            "enum":[
                "Started",
                "Completed",
                "Failed"
            ]
        },
        "message":{
            "type":"string",
            "format":"",
            "description":"Training message.",
            "title":"Message",
            "readOnly":true
        },
        "analyticsInfo":{
            "type":"string",
            "format":"",
            "description":"Information about the training.",
            "title":"Training Information",
            "readOnly":true
        },
        "lastDeployed":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Date of the training's last deployment.",
            "title":"Last Deployed",
            "readOnly":true
        },
        "totalRecords":{
            "type":"integer",
            "format":"",
            "description":"Total number of records used for training.",
            "title":"Total Records",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to start an intelligence model training session by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/intelligenceSetup/models/321456/actions/train

Request Body Sample

[{
    "id": 321456,
    "startDate": "2024-08-09T07:00:00Z",
    "status": "In Progress"
  }
]

Back to Top