機械学習モデルの作成
post
/crmRestApi/resources/11.13.18.05/salesMLModels
リクエスト
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadata: string
レコードのオブジェクト・バージョン番号。
-
CriteriaFilterExpr: string
エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
-
DebugFlag: boolean
モデルがデバッグ・モードかどうかを示します。
-
DebugMessage: string
デバッグ・モードに関連付けられたメッセージ。
-
DeployFlag: boolean
フィールドをデプロイできるかどうかを示します。
-
JobDescription: string
最大長:
1040
モデルの説明。 -
JobId: integer (int64)
モデルの一意の識別子。
-
JobName(required): string
最大長:
2000
機械学習モデルの名前。 -
JobStatus: string
最大長:
255
機械学習モデルのステータス。 -
NumofFeatures: integer
モデルの選択した属性の数。
-
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
QueryMetadata: string
モデルに関連付けられた問合せの詳細。
-
QueryResultSet: string
モデルに関連付けられている問合せの結果。
-
Schedule: string
最大長:
1000
機械学習実験の実行に使用されるスケジュール。 -
Status: string
最大長:
80
機械学習モデルのステータス。 -
StorePredCriteriaFilter: string
販売機械学習モデルの予測データセットを定義し、予測を格納するためのフィルタ基準。
-
StorePrediction: string
最大長:
1
営業機械学習モデルの実行時に予測を格納する機能。 -
StorePredProbColumnName: string
最大長:
60
予測値として格納された販売機械学習モデルの結果。 -
StorePredSchedule: string
最大長:
1000
営業機械学習モデルの実行時に予測を格納する機能。 -
StorePredValueColumnName: string
最大長:
60
販売機械学習モデルの予測値を格納する列の名前。 -
SubmitFlag: boolean
モデルを発行できるかどうかを示します。
-
UsecaseCode(required): string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。 -
UsecaseName: string
ユースケースの名前。
-
ZcaOmlFixedFieldRules: array Model Validation and Transformation Rules
タイトル:
Model Validation and Transformation Rules
モデル検証および変換ルール -
ZcaOmlJobsSelFields: array Model Selected Fields
タイトル:
Model Selected Fields
モデル選択済フィールド -
ZcaOmlJobStatistics: array Machine Learning Job Statistics Details
タイトル:
Machine Learning Job Statistics Details
モデル統計 -
ZcaOmlUsecaseFixedFields: array Use Case Selected Fields
タイトル:
Use Case Selected Fields
Sales Machine Learningの選択した機能
ネストされたスキーマ : モデル検証および変換ルール
タイプ:
array
タイトル:
Model Validation and Transformation Rules
モデル検証および変換ルール
ソースを表示
ネストされたスキーマ : ユースケース選択フィールド
タイプ:
array
タイトル:
Use Case Selected Fields
Sales Machine Learningの選択した機能
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadata: 文字列(バイト)
機械学習モデルに関する追加の詳細。
-
FieldName: string
最大長:
200
シノニムに関連付けられたrootキーワード。 -
FieldRuleCode: string
最大長:
800
ルールの一意の識別子。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
RuleCode: string
最大長:
200
ルールの一意の識別子。 -
RuleValue: 文字列(バイト)
モデルに関連付けられたルールの値。
-
UsecaseCode: string
最大長:
200
ユース・ケースに関連付けられたコード。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadata: string
レコードのオブジェクト・バージョン番号。
-
FieldDataType(required): string
最大長:
200
ブール、文字列など、選択したフィールドの日付タイプ。 -
FieldName(required): string
最大長:
800
MLモデルに関連付けられているフィールドの名前。 -
FieldTitle: string
最大長:
800
使用可能なフィールドの表示名。 -
IsFeature: string
最大長:
20
フィールドが機能かどうかを示します。 有効な値ははい、いいえまたはNULLです。 -
JobId(required): integer (int64)
モデルの検索に使用される一意の識別子。
-
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
UsecaseCode(required): string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。 -
ZcaOmlJobRules: array Model Validation and Transformation Rules
タイトル:
Model Validation and Transformation Rules
営業機械学習モデル・ルール
ネストされたスキーマ : モデル検証および変換ルール
タイプ:
array
タイトル:
Model Validation and Transformation Rules
営業機械学習モデル・ルール
ソースを表示
ネストされたスキーマ : salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-post-request
タイプ:
ソースを表示
object
-
FieldName: string
最大長:
800
選択したフィールドの名前。 -
JobId: integer (int64)
モデルの一意の識別子。
-
JobRuleId: integer (int64)
検証ルールまたは変換ルールの一意の識別子。
-
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
RuleCode: string
最大長:
200
検証ルールまたは変換ルールの一意の識別子。 -
RuleValue: string
モデルに関連付けられたルールの値。
-
UsecaseCode: string
最大長:
200
ユース・ケースの一意の識別子。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadataJson: string
機械学習モデルの追加のJSON詳細。
-
DataSourceName: string
最大長:
700
ユース・ケースに関連付けられているデータ・ソースの名前。 -
DataSourceSQL: string
ユースケースに関連付けられたデータ・ソースのSQL問合せ。
-
DataSourceType: string
最大長:
80
ユース・ケースに関連付けられているデータ・ソースのタイプ。 -
ExplainabilityMetrics: string
モデルとそのパフォーマンスの説明に使用されるメトリック。
-
JobId: integer (int64)
モデルの検索に使用される一意の識別子。
-
JobName: string
最大長:
2000
機械学習モデルの名前。 -
JobRunId: integer (int64)
ジョブ実行の一意の識別子。
-
ModelAccuracy: string
最大長:
200
機械学習モデルの精度。 -
ModelStatus: string
最大長:
20
機械学習モデルのステータス。 -
ModelType: string
最大長:
200
ユース・ケースに関連付けられているモデル・タイプ。 モデルのタイプは、実行するタスクによって異なります。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
RangeValues: string
基礎となるモデル属性に指定可能な値の範囲。
-
SelectedAlgorithm: string
最大長:
200
ユースケース用に選択されたアルゴリズム。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadata: 文字列(バイト)
レコードのオブジェクト・バージョン番号。
-
FieldDataType: string
最大長:
200
文字列、ブールなど、フィールドのデータ型。 -
FieldName: string
最大長:
800
使用可能なフィールドの表示名。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
UsecaseCode: string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : salesMLModels-item-response
タイプ:
ソースを表示
object
-
AdditionalMetadata: string
レコードのオブジェクト・バージョン番号。
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
CriteriaFilterExpr: string
エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
-
DebugFlag: boolean
モデルがデバッグ・モードかどうかを示します。
-
DebugMessage: string
デバッグ・モードに関連付けられたメッセージ。
-
DeployFlag: boolean
フィールドをデプロイできるかどうかを示します。
-
JobDescription: string
最大長:
1040
モデルの説明。 -
JobId: integer (int64)
モデルの一意の識別子。
-
JobName: string
最大長:
2000
機械学習モデルの名前。 -
JobStatus: string
最大長:
255
機械学習モデルのステータス。 -
LastUpdateDate: string (date-time)
読取り専用:
true
モデル・レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
モデルを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
モデルを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NumofFeatures: integer
モデルの選択した属性の数。
-
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
QueryMetadata: string
モデルに関連付けられた問合せの詳細。
-
QueryResultSet: string
モデルに関連付けられている問合せの結果。
-
Schedule: string
最大長:
1000
機械学習実験の実行に使用されるスケジュール。 -
Status: string
最大長:
80
機械学習モデルのステータス。 -
StorePredCriteriaFilter: string
販売機械学習モデルの予測データセットを定義し、予測を格納するためのフィルタ基準。
-
StorePrediction: string
最大長:
1
営業機械学習モデルの実行時に予測を格納する機能。 -
StorePredProbColumnName: string
最大長:
60
予測値として格納された販売機械学習モデルの結果。 -
StorePredSchedule: string
最大長:
1000
営業機械学習モデルの実行時に予測を格納する機能。 -
StorePredValueColumnName: string
最大長:
60
販売機械学習モデルの予測値を格納する列の名前。 -
SubmitFlag: boolean
モデルを発行できるかどうかを示します。
-
UsecaseCode: string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。 -
UsecaseName: string
ユースケースの名前。
-
ZcaOmlFixedFieldRules: array Model Validation and Transformation Rules
タイトル:
Model Validation and Transformation Rules
モデル検証および変換ルール -
ZcaOmlJobsSelFields: array Model Selected Fields
タイトル:
Model Selected Fields
モデル選択済フィールド -
ZcaOmlJobStatistics: array Machine Learning Job Statistics Details
タイトル:
Machine Learning Job Statistics Details
モデル統計 -
ZcaOmlUsecaseFixedFields: array Use Case Selected Fields
タイトル:
Use Case Selected Fields
Sales Machine Learningの選択した機能
ネストされたスキーマ : モデル検証および変換ルール
タイプ:
array
タイトル:
Model Validation and Transformation Rules
モデル検証および変換ルール
ソースを表示
ネストされたスキーマ : ユースケース選択フィールド
タイプ:
array
タイトル:
Use Case Selected Fields
Sales Machine Learningの選択した機能
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : salesMLModels-ZcaOmlFixedFieldRules-item-response
タイプ:
ソースを表示
object
-
AdditionalMetadata: 文字列(バイト)
機械学習モデルに関する追加の詳細。
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
FieldName: string
最大長:
200
シノニムに関連付けられたrootキーワード。 -
FieldRuleCode: string
最大長:
800
ルールの一意の識別子。 -
LastUpdateDate: string (date-time)
読取り専用:
true
モデル・レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
モデルを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
モデルを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
RuleCode: string
最大長:
200
ルールの一意の識別子。 -
RuleValue: 文字列(バイト)
モデルに関連付けられたルールの値。
-
UsecaseCode: string
最大長:
200
ユース・ケースに関連付けられたコード。
ネストされたスキーマ : salesMLModels-ZcaOmlJobsSelFields-item-response
タイプ:
ソースを表示
object
-
AdditionalMetadata: string
レコードのオブジェクト・バージョン番号。
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
FieldDataType: string
最大長:
200
ブール、文字列など、選択したフィールドの日付タイプ。 -
FieldName: string
最大長:
800
MLモデルに関連付けられているフィールドの名前。 -
FieldTitle: string
最大長:
800
使用可能なフィールドの表示名。 -
IsFeature: string
最大長:
20
フィールドが機能かどうかを示します。 有効な値ははい、いいえまたはNULLです。 -
JobId: integer (int64)
モデルの検索に使用される一意の識別子。
-
LastUpdateDate: string (date-time)
読取り専用:
true
モデル・レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
モデルを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
モデルを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
UsecaseCode: string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。 -
ZcaOmlJobRules: array Model Validation and Transformation Rules
タイトル:
Model Validation and Transformation Rules
営業機械学習モデル・ルール
ネストされたスキーマ : モデル検証および変換ルール
タイプ:
array
タイトル:
Model Validation and Transformation Rules
営業機械学習モデル・ルール
ソースを表示
ネストされたスキーマ : salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
FieldName: string
最大長:
800
選択したフィールドの名前。 -
JobId: integer (int64)
モデルの一意の識別子。
-
JobRuleId: integer (int64)
検証ルールまたは変換ルールの一意の識別子。
-
LastUpdateDate: string (date-time)
読取り専用:
true
モデル・レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
モデルを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
モデルを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
RuleCode: string
最大長:
200
検証ルールまたは変換ルールの一意の識別子。 -
RuleValue: string
モデルに関連付けられたルールの値。
-
UsecaseCode: string
最大長:
200
ユース・ケースの一意の識別子。
ネストされたスキーマ : salesMLModels-ZcaOmlJobStatistics-item-response
タイプ:
ソースを表示
object
-
AdditionalMetadataJson: string
機械学習モデルの追加のJSON詳細。
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
DataSourceName: string
最大長:
700
ユース・ケースに関連付けられているデータ・ソースの名前。 -
DataSourceSQL: string
ユースケースに関連付けられたデータ・ソースのSQL問合せ。
-
DataSourceType: string
最大長:
80
ユース・ケースに関連付けられているデータ・ソースのタイプ。 -
ExplainabilityMetrics: string
モデルとそのパフォーマンスの説明に使用されるメトリック。
-
JobId: integer (int64)
モデルの検索に使用される一意の識別子。
-
JobName: string
最大長:
2000
機械学習モデルの名前。 -
JobRunId: integer (int64)
ジョブ実行の一意の識別子。
-
LastUpdateDate: string (date-time)
読取り専用:
true
モデル・レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
モデルを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
モデルを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ModelAccuracy: string
最大長:
200
機械学習モデルの精度。 -
ModelStatus: string
最大長:
20
機械学習モデルのステータス。 -
ModelType: string
最大長:
200
ユース・ケースに関連付けられているモデル・タイプ。 モデルのタイプは、実行するタスクによって異なります。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
RangeValues: string
基礎となるモデル属性に指定可能な値の範囲。
-
SelectedAlgorithm: string
最大長:
200
ユースケース用に選択されたアルゴリズム。
ネストされたスキーマ : salesMLModels-ZcaOmlUsecaseFixedFields-item-response
タイプ:
ソースを表示
object
-
AdditionalMetadata: 文字列(バイト)
レコードのオブジェクト・バージョン番号。
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
FieldDataType: string
最大長:
200
文字列、ブールなど、フィールドのデータ型。 -
FieldName: string
最大長:
800
使用可能なフィールドの表示名。 -
LastUpdateDate: string (date-time)
読取り専用:
true
モデル・レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
モデルを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
モデルを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
UsecaseCode: string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。
リンク
- ZcaOmlFixedFieldRules
-
パラメータ:
- JobId:
$request.path.JobId
モデル検証および変換ルール - JobId:
- ZcaOmlJobStatistics
-
パラメータ:
- JobId:
$request.path.JobId
モデル統計 - JobId:
- ZcaOmlJobsSelFields
-
パラメータ:
- JobId:
$request.path.JobId
モデル選択済フィールド - JobId:
- ZcaOmlUsecaseFixedFields
-
パラメータ:
- JobId:
$request.path.JobId
Sales Machine Learningの選択した機能 - JobId: