ジャンプ先

• リクエスト
• レスポンス

ジョブの更新

post

/omlmod/v1/jobs/{jobId}

ジョブを更新します。

リクエスト

パス・パラメータ

• jobId(required): string
  ジョブの一意のID

問合せパラメータ

• async: boolean
  更新を非同期で実行するかどうか。

  デフォルト値: false

  許容値: [ true, false ]
• purge: boolean
  削除済モデルを更新中にパージするかどうか。ターゲット・ジョブがモデル・モニタリング・ジョブの場合にのみ適用されます。削除済モデルをジョブからパージすると、ジョブのMODEL_DELETEDのjobFlagがクリアされます。

  デフォルト値: false

  許容値: [ true, false ]

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ : schema

型: object

ソースの表示

• jobSchedule: object JobSchedule
• updateProperties: updateProperties

{
    "type":"object",
    "properties":{
        "jobSchedule":{
            "$ref":"#/components/schemas/JobSchedule"
        },
        "updateProperties":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/UpdatableDataMonitoringJobProperties"
                },
                {
                    "$ref":"#/components/schemas/UpdatableModelMonitoringJobProperties"
                },
                {
                    "$ref":"#/components/schemas/UpdatableModelScoringJobDefinitionProperties"
                }
            ]
        }
    }
}

ネストされたスキーマ: JobSchedule

型: object

ソースの表示

• jobEndDate: string (date-time)
  ジョブの実行を終了する必要がある日時。このプロパティが省略されている場合に、maxRunsプロパティがないと、ジョブは取り消されるまでスケジュールに従って実行されます。ISO-8601日時書式(https://www.iso.org/ISO-8601-date-and-time-format.htmlを参照)にする必要があります

  例: 2022-05-12T02:33:16Z
• jobStartDate: string (date-time)
  ジョブの実行を開始する必要がある日時。このプロパティを省略すると、ジョブは即時に開始されます。ISO-8601日時書式(https://www.iso.org/ISO-8601-date-and-time-format.htmlを参照)にする必要があります

  例: 2022-05-12T02:33:16Z
• maxRuns: integer
  このスケジュールに従ってジョブを実行できる最大回数。
• repeatInterval: string
  ジョブの実行を繰り返す頻度。この指定は、dbms_schedulerカレンダ構文に従います。たとえば、日次ジョブはFREQ=DAILYと指定します。

{
    "type":"object",
    "properties":{
        "jobStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the job should start execution. If this property is omitted the job will be started immediately. The ISO-8601 date and time format is expected (see https://www.iso.org/iso-8601-date-and-time-format.html)",
            "example":"2022-05-12T02:33:16Z"
        },
        "repeatInterval":{
            "type":"string",
            "description":"How often the job execution should be repeated. The specification follows the dbms_scheduler calendaring syntax. For example, a daily job would be specified as FREQ=DAILY."
        },
        "jobEndDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the job should end execution. If this property is omitted and there is no maxRuns property, then the job will execute on schedule until cancelled. The ISO-8601 date and time format is expected (see https://www.iso.org/iso-8601-date-and-time-format.html)",
            "example":"2022-05-12T02:33:16Z"
        },
        "maxRuns":{
            "type":"integer",
            "description":"The maximum number of times the job can be executed according to this schedule."
        }
    }
}

ネストされたスキーマ: updateProperties

1つのスキーマに一致

ソースの表示

• object UpdatableDataMonitoringJobProperties
• object UpdatableModelMonitoringJobProperties
• object UpdatableModelScoringJobDefinitionProperties

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/UpdatableDataMonitoringJobProperties"
        },
        {
            "$ref":"#/components/schemas/UpdatableModelMonitoringJobProperties"
        },
        {
            "$ref":"#/components/schemas/UpdatableModelScoringJobDefinitionProperties"
        }
    ]
}

ネストされたスキーマ: UpdatableDataMonitoringJobProperties

型: object

ソースの表示

• featureList: array featureList
  データ・モニタリングを実行する特徴のリスト。リスト内の特徴の数は制限する必要があります(デフォルトは250)。特徴リストを指定しないと、すべての特徴でモニタリングが実行されます。250個を超える特徴がある場合は、エラーになります。特徴は数値またはカテゴリ型である必要があります。このリリースでは、テキスト、ネストまたは日付はサポートされていません。

{
    "type":"object",
    "properties":{
        "featureList":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of features to perform data monitoring on, there should be a limit on the number of features in the list (default 250). Monitoring will run on all features if feature list is not specified. If there are more than 250 features, it will error out. The features need to be either numeric or categorical. Text, nested, or date will not be supported in this release."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdatableMonitoringJobDefinitionProperties"
        }
    ]
}

すべて一致

ソースの表示

• object UpdatableMonitoringJobDefinitionProperties

{
    "type":"object",
    "properties":{
        "featureList":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of features to perform data monitoring on, there should be a limit on the number of features in the list (default 250). Monitoring will run on all features if feature list is not specified. If there are more than 250 features, it will error out. The features need to be either numeric or categorical. Text, nested, or date will not be supported in this release."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdatableMonitoringJobDefinitionProperties"
        }
    ]
}

ネストされたスキーマ: UpdatableModelMonitoringJobProperties

型: object

ソースの表示

• modelList: array modelList
  モニター対象のモデルのリスト。モデルは、modelIdで識別されます。1つのジョブでモニターされるモデルの数には制限があります(最大20)。

{
    "type":"object",
    "properties":{
        "modelList":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of models to be monitored. Models are identified by their modelIds. There is a limit on the number of models being monitored by a job (max 20)."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdatableMonitoringJobDefinitionProperties"
        }
    ]
}

すべて一致

ソースの表示

• object UpdatableMonitoringJobDefinitionProperties

{
    "type":"object",
    "properties":{
        "modelList":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of models to be monitored. Models are identified by their modelIds. There is a limit on the number of models being monitored by a job (max 20)."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdatableMonitoringJobDefinitionProperties"
        }
    ]
}

ネストされたスキーマ: UpdatableModelScoringJobDefinitionProperties

型: object

ソースの表示

• recompute: boolean
  デフォルト値: false

  すでに計算済の期間を更新するかどうかを示すフラグ。デフォルトはfalseです。recomputeがtrueの場合、結果表の指定期間の以前の結果が新しい結果で置き換えられます。

{
    "type":"object",
    "properties":{
        "recompute":{
            "type":"boolean",
            "default":false,
            "description":"A flag whether to update already computed periods. Default is false. If recompute is true, then new results will replace previous results for the specified time period in the result table."
        }
    }
}

ネストされたスキーマ: featureList

型: array

データ・モニタリングを実行する特徴のリスト。リスト内の特徴の数は制限する必要があります(デフォルトは250)。特徴リストを指定しないと、すべての特徴でモニタリングが実行されます。250個を超える特徴がある場合は、エラーになります。特徴は数値またはカテゴリ型である必要があります。このリリースでは、テキスト、ネストまたは日付はサポートされていません。

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"A list of features to perform data monitoring on, there should be a limit on the number of features in the list (default 250). Monitoring will run on all features if feature list is not specified. If there are more than 250 features, it will error out. The features need to be either numeric or categorical. Text, nested, or date will not be supported in this release."
}

ネストされたスキーマ: UpdatableMonitoringJobDefinitionProperties

型: object

ソースの表示

• endDate: string (date-time)
  newDataのモニタリングの終了日/タイムスタンプ。timeColumnが存在すると仮定しています。endDateを指定しないと、timeColumnの最新の日付が使用されます。ISO-8601日時書式(https://www.iso.org/ISO-8601-date-and-time-format.htmlを参照)にする必要があります

  例: 2022-05-12T02:33:16Z
• recompute: boolean
  デフォルト値: false

  すでに計算済の期間を更新するかどうかを示すフラグ。デフォルトはfalseです。つまり、結果表のデータよりも新しいデータがある期間だけが計算されます。選択した頻度によっては、新しい分析結果が既存の結果と重複する可能性があります。recomputeがtrueの場合、結果表の指定期間の以前の結果が新しい結果で置き換えられます。
• startDate: string (date-time)
  newDataのモニタリングの開始日/タイムスタンプ。timeColumnが存在すると仮定しています。startDateを指定しない場合は、頻度が指定されているかどうかによってstartDateが異なります。頻度が指定されていない場合は、timeColumnの最も早い日付がstartDateとして使用されます。それ以外の場合は、timeColumnの最も早い日付と最近のサイクルの10番目の開始日のうち、どちらか早い日付がstartDateとして使用されます。ISO-8601日時書式(https://www.iso.org/ISO-8601-date-and-time-format.htmlを参照)にする必要があります。

  例: 2022-05-12T02:33:16Z
• threshold: number (float)
  ドリフト・アラートをトリガーするしきい値。

{
    "type":"object",
    "properties":{
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"Start date/timestamp of the monitoring in newData. It assumes the existence of a timeColumn. If startDate is not provided, then the startDate depends on whether frequency has been provided. If frequency has not been provided, the earliest date in the timeColumn is used as the startDate. Otherwise, the more recent of the earliest date in the timeColumn and the starting date of the 10th most recent cycle is used as the startDate. The ISO-8601 date-time format is expected (see https://www.iso.org/iso-8601-date-and-time-format.html).",
            "example":"2022-05-12T02:33:16Z"
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"End date/timestamp of the monitoring in newData. It assumes the existence of a timeColumn. If endDate is not provided, the most recent date in the timeColumn will be used. The ISO-8601 date and time format is expected (see https://www.iso.org/iso-8601-date-and-time-format.html).",
            "example":"2022-05-12T02:33:16Z"
        },
        "threshold":{
            "type":"number",
            "format":"float",
            "description":"Threshold to trigger drift alert."
        },
        "recompute":{
            "type":"boolean",
            "default":false,
            "description":"A flag whether to update already computed periods. Default is false. That is, only periods with newer data than present in the result table will be computed. New analysis results may overlap with the existing results depending on the selected frequency. If recompute is true, then new results will replace previous results for the specified time period in the result table."
        }
    }
}

ネストされたスキーマ: modelList

型: array

モニター対象のモデルのリスト。モデルは、modelIdで識別されます。1つのジョブでモニターされるモデルの数には制限があります(最大20)。

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"A list of models to be monitored. Models are identified by their modelIds. There is a limit on the number of models being monitored by a job (max 20)."
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

202レスポンス

非同期ジョブ更新が受け入れられました。

ヘッダー

• Location(required):
  更新の完了をポーリングする場所。

204レスポンス

ジョブが正常に更新されました。

400レスポンス

不正なリクエストです。空のリスト、purge = true、存在しないモデルのみを含むリストを指定して、モデル・モニタリング・ジョブのモデル・リストを更新しようとした場合が含まれます。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

401レスポンス

認可されていません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

404レスポンス

リソースが見つかりません。少なくとも1つの削除済モデルが含まれるリストを指定して、purge = trueを指定せずにモデル・モニタリング・ジョブのモデル・リストを更新しようとした場合が含まれます。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

500レスポンス

予期しないエラーです。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る