MENU
      Create service

        Create service


        Article summary

        Available in Classic and VPC

        Create a new service to use the AiTEMS service.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        POST/services

        Request headers

        For headers common to all AiTEMS APIs, see Common AiTEMS headers.

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        nameStringRequiredService name
        • 3 to 20 characters, including English letters, numbers, and the special character "_" and "_", and must begin with an English letter or "_"
        descriptionStringOptionalService description
        • 0 - 100 characters
        typeStringOptionalService type
        • batch (default) | interval
          • batch: one-time training upon execution
          • interval: Retrain at regular intervals after execution

        Request example

        The following is a sample request.

        curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/services' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json' \
        --data '{
            "name": "service",
            "description": "test",
            "type": "batch"
        }'
        Shell

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        serviceIdString-Service ID
        nameString-Service name
        descriptionString-Service description
        statusString-Service status
        • scheduled | scheduledLearning | learnable | learning | deleting | deleted | disable | drafted | requestLearning | datasetRequired
          • scheduled: scheduled
          • scheduledLearning: scheduled training in progress
          • learnable: trainable
          • learning: training in progress
          • deleting: deleting
          • deleted: deleted
          • disable: training unavailable
          • drafted: draft status
          • requestLearning: training requested
          • datasetRequired: no dataset specified after service creation
        datasetsArray-Information of dataset set to service
        hpConfigObject-Hyperparameter optimization (HPO) settings information
        hpConfig.is_enabledBoolean-HPO configuration status
        • true | false
          • true: HPO configured, optimal training models can be implemented
          • false: HPO not configured, trained by AiTEMS' own internal algorithms
        hpConfig.{option}String, Long, Boolean-Configured HPO value
        • See HPO for value details
        infersArray-Training result information
        • Displayed only if type is interval
        createdDateString-Service creation date and time
        updatedDateString-Last update date and time of the service
        typeString-Service type
        • batch | interval
          • batch: one-time training upon execution
          • interval: Retrain at regular intervals after execution

        datasets

        The following describes datasets.

        FieldTypeRequiredDescription
        datasetIdString-Dataset ID set to the service
        typeString-Dataset type set to the service
        • user | item | interaction
          • user: data containing user information (age, gender, etc.)
          • item: data with product-related information (price, release date, category, etc.)
          • interaction: data that captures the history of interactions between users and products
        nameString-Dataset name set to the service
        schemaNameString-Dataset schema name set to the service
        statusString-Status of dataset set to the service
        • learnable | disable | uploading | updateRequired
          • learnable: training available
          • disable: training unavailable
          • uploading: uploading
          • updatedRequired: updated dataset registration required (automatically registered when training)
        createdDateString-Creation date and time of dataset set to the service
        updatedDateString-Last update date and time of dataset set to the service

        infers

        The following describes infers.

        FieldTypeRequiredDescription
        dataTypeString-Dataset type of training result
        • user | item | interaction
          • user: data containing user information (age, gender, etc.)
          • item: data with product-related information (price, release date, category, etc.)
          • interaction: data that captures the history of interactions between users and products
        trainVersionString-Training result version
        statusString-Training result status
        • enable | waiting | pending | processing | updateFailed | disable
          • enable: update available
          • waiting: waiting for update
          • pending: pending update
          • processing: updating
          • updateFailed: update failed
          • disable: update unavailable
        rowCountString-Result data count

        Response status codes

        For response status codes common to all AiTEMS APIs, see Common AiTEMS API response status codes.

        Response example

        The following is a sample example.

        {
            "serviceId": "fboyb******",
            "name": "service",
            "description": "test",
            "status": "datasetRequired",
            "datasets": [],
            "hpConfig": {
                "is_enabled": false
            },
            "infers": [],
            "createdDate": "2024-07-29T16:17:37.235",
            "updatedDate": "2024-07-29T16:17:37.235",
            "type": "batch"
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.