@salesforce/lds-adapters-platform-cdp-machine-learning 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1874 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  CdpAssetBaseRepresentation:
+    description: Represents a base Asset
+    type: object
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string | nil
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string | nil
+      name:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string | nil
+      url:
+        description: Url
+        type: string
+  CdpAssetReferenceRepresentation:
+    description: Represents Cdp Asset Reference
+    type: object
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string | nil
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string | nil
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string | nil
+      name?:
+        description: Name of the asset
+        type: string | nil
+      namespace?:
+        description: Namespace of the asset
+        type: string | nil
+      url?:
+        description: Url
+        type: string | nil
+  MlConnectorEndpointRepresentation:
+    description: Representation for Cdp Ml Connector Endpoint
+    type: object
+    properties:
+      authHeader?:
+        description: The authentication header
+        type: string
+      authentication?:
+        description: Connector endpoint authentication type - jwt or authkey based
+        type: string
+        enum:
+          - ApiKey
+          - GoogleSac
+          - Jwt
+          - Oauth
+      connectorType?:
+        description: The connector type
+        type: string
+        enum:
+          - Anthropic
+          - AzureOpenAI
+          - Databricks
+          - EinsteinText
+          - Generic
+          - OpenAI
+          - SageMaker
+          - VertexAI
+          - Bedrock
+      endpointUrl?:
+        description: URL of the connect endpoint
+        type: string
+      foundationalModelName?:
+        description: Foundational model name
+        type: string
+      label?:
+        description: label
+        type: string
+      name?:
+        description: name
+        type: string
+      namedCredential?:
+        description: Named Credential used in the endpoint
+        type: CdpAssetReferenceRepresentation
+      privateKeyId?:
+        description: The private key ID
+        type: string
+      region?:
+        description: Region for AWS connection
+        type: string
+      registeredModelApiName?:
+        description: Registered Model API name on the Provider
+        type: string
+      requestFormat?:
+        description: Connector endpoint request format
+        type: string
+        enum:
+          - Csv
+          - DataFrameRecords
+          - DataFrameSplit
+          - Json
+          - JsonDense
+          - NumpyInput
+          - NumpyInstance
+      responseFormat?:
+        description: Connector endpoint response format
+        type: string
+        enum:
+          - Csv
+          - DataFrameRecords
+          - DataFrameSplit
+          - Json
+          - JsonDense
+          - NumpyInput
+          - NumpyInstance
+      serviceAccountEmail?:
+        description: The service account email
+        type: string
+  CdpMlConfiguredModelCollectionRepresentation:
+    description: Represents Cdp Ml Configured Model Collection
+    type: object
+    properties:
+      models?:
+        description: List of configured models
+        type: array
+        items:
+          type: CdpMlConfiguredModelRepresentation
+      totalSize:
+        description: Total size of collection
+        type: integer
+      url:
+        description: Url
+        type: string
+  CdpMlModelParameterOverrideBaseRepresentation:
+    description: Cdp Ml Model Parameter Override Base Representation
+    discriminator: type
+    type: object
+    properties:
+      parameterName:
+        description: Parameter Name
+        type: string
+      type:
+        description: Parameter Type
+        type: string
+        enum:
+          - Continuous
+          - Discrete
+  CdpUserRepresentation:
+    description: Represents a user
+    type: object
+    properties:
+      id:
+        description: The 18 character user ID
+        type: string
+      name:
+        description: The name of the user
+        type: string
+      profilePhotoUrl:
+        description: The Chatter profile photo of the user
+        type: string
+  CdpMlModelArtifactBaseRepresentation:
+    description: Cdp Ml Model Artifact Base Representation
+    discriminator: modelType
+    type: object
+    properties:
+      deprecationConfiguration?:
+        description: Deprecation strategy when the model is deprecated
+        type: MlDeprecationConfigurationRepresentation
+      description?:
+        description: Description
+        type: string | nil
+      inputFields:
+        description: Input Fields
+        type: array
+        items:
+          type: CdpMlModelInputFieldBaseRepresentation
+      modelConnectorEndpoint?:
+        description: Model connector endpoint definition
+        type: MlConnectorEndpointRepresentation
+      modelCount?:
+        description: Number of configured models from this model artifact
+        type: integer
+      modelType:
+        description: Model Type
+        type: string
+        enum:
+          - Generative
+          - Predictive
+          - Unknown
+      outputFields:
+        description: Output Fields
+        type: array
+        items:
+          type: CdpMlModelOutputFieldRepresentation
+      parameters:
+        description: List of Model Parameter Definitions
+        type: array
+        items:
+          type: CdpMlModelParameterDefinitionBaseRepresentation
+      runtimeType:
+        description: Runtime Type
+        type: string
+        enum:
+          - External
+          - Internal
+      setupContainer?:
+        description: Setup Container
+        type: CdpAssetReferenceRepresentation
+      source?:
+        description: Source
+        type: CdpAssetReferenceRepresentation
+      sourceContainer?:
+        description: Source Container
+        type: CdpAssetReferenceRepresentation
+      sourceType:
+        description: SourceType
+        type: string
+        enum:
+          - EdcNoCode
+          - ModelConnector
+          - OutOfTheBox
+      status?:
+        description: Model artifact status
+        type: string
+        enum:
+          - Deprecated
+          - Disabled
+          - Draft
+          - Enabled
+          - Rerouted
+      syncStatus?:
+        description: Sync status
+        type: string
+        enum:
+          - Error
+          - NotSynced
+          - Synced
+          - Syncing
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string | nil
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string | nil
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string | nil
+      name:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string | nil
+      url:
+        description: Url
+        type: string
+  CdpMlModelParameterOverrideInputRepresentation:
+    description: Input representation for a Cdp Ml Model Parameter Override
+    type: object
+    properties:
+      continuousValue?:
+        description: Model parameter continuous value
+        type: number | nil
+      discreteValue?:
+        description: Model parameter discrete value
+        type: string | nil
+      parameterName?:
+        description: Model parameter definition Id to which override is provided
+        type: string | nil
+  CdpAssetReferenceInputRepresentation:
+    description: Represents an asset
+    type: object
+    properties:
+      id?:
+        description: Id
+        type: string | nil
+      name?:
+        description: Name
+        type: string | nil
+      namespace?:
+        description: Namespace
+        type: string | nil
+  CdpMlCustomizableFieldDefinitionInputRepresentation:
+    description: Input representation for a Cdp Ml Customizable Field Definition
+    type: object
+    properties:
+      filter:
+        description: Filter
+        type: object
+      templateText:
+        description: Template Text
+        type: string
+  CdpMlCustomizableFieldInputRepresentation:
+    description: Input representation for a Cdp Ml Customizable Field
+    type: object
+    properties:
+      customDefinitions:
+        description: Custom Definitions
+        type: array
+        items:
+          type: CdpMlCustomizableFieldDefinitionInputRepresentation
+      name:
+        description: Name
+        type: string
+      type:
+        description: Type
+        type: string
+        enum:
+          - ActionableVariable
+          - TopFactor
+  CdpMlConfiguredModelInputRepresentation:
+    description: Input representation for a Cdp Ml Configured Model (Active Partition)
+    type: object
+    properties:
+      actionableFields?:
+        description: Actionable Fields
+        type: array
+        items:
+          type: CdpMlCustomizableFieldInputRepresentation
+      artifact?:
+        description: Artifact
+        type: CdpAssetReferenceInputRepresentation
+      capability?:
+        description: Model capability
+        type: string
+        enum:
+          - ChatCompletion
+          - Completion
+          - Embedding
+      customizableFields?:
+        description: Customizable Fields
+        type: array
+        items:
+          type: CdpMlCustomizableFieldInputRepresentation
+      description?:
+        description: Model description
+        type: string | nil
+      filter?:
+        description: Filter
+        type: object
+      label?:
+        description: Model label
+        type: string | nil
+      parameterOverrides?:
+        description: Model Parameter override
+        type: array
+        items:
+          type: CdpMlModelParameterOverrideInputRepresentation
+      position?:
+        description: Position
+        type: integer
+      status?:
+        description: Model status
+        type: string
+        enum:
+          - Disabled
+          - Enabled
+  CdpMlConfiguredModelRepresentation:
+    description: Represents Cdp Ml Configured Model (Active Partition)
+    type: object
+    properties:
+      actionableFields?:
+        description: List of actionable fields
+        type: array
+        items:
+          type: CdpMlCustomizableFieldRepresentation
+      artifact:
+        description: AI model
+        type: CdpAssetReferenceRepresentation
+      capability:
+        description: Model capability
+        type: string
+        enum:
+          - ChatCompletion
+          - Completion
+          - Embedding
+      customizableFields:
+        description: List of customizable fields
+        type: array
+        items:
+          type: CdpMlCustomizableFieldRepresentation
+      description?:
+        description: Model description
+        type: string | nil
+      filter:
+        description: Model filters
+        type: CdpMlFilterRepresentation
+      lastActivatedBy?:
+        description: Last activated by
+        type: CdpUserRepresentation
+      lastActivatedDate?:
+        description: Last activated date
+        type: string
+      metricsUrl?:
+        description: Live metrics url
+        type: string | nil
+      parameterOverrides:
+        description: List of Model Parameter Overrides
+        type: array
+        items:
+          type: CdpMlModelParameterOverrideBaseRepresentation
+      position:
+        description: Model position
+        type: integer
+      status:
+        description: Model status
+        type: string
+        enum:
+          - Deprecated
+          - Disabled
+          - Enabled
+          - Rerouted
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string | nil
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string | nil
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string | nil
+      name:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string | nil
+      url:
+        description: Url
+        type: string
+  CdpMlCustomizableFieldDefinitionRepresentation:
+    description: Represents Cdp Ml Customizable Field Definition
+    type: object
+    properties:
+      filter:
+        description: Filter rules for enabling custom text, catch all is assumed when
+          null is set
+        type: CdpMlFilterRepresentation
+      templateText:
+        description: Template text to be replaced with
+        type: string
+  CdpMlCustomizableFieldRepresentation:
+    description: Represents Cdp Ml Customizable Field
+    type: object
+    properties:
+      customDefinitions:
+        description: List of customizable field definitions
+        type: array
+        items:
+          type: CdpMlCustomizableFieldDefinitionRepresentation
+      field:
+        description: Customizable field
+        type: CdpMlModelInputFieldBaseRepresentation
+      type:
+        description: Customizable field type
+        type: string
+        enum:
+          - ActionableVariable
+          - TopFactor
+  CdpMlFieldRepresentation:
+    description: Cdp Ml Field
+    type: object
+    properties:
+      label:
+        description: label
+        type: string
+      name:
+        description: name
+        type: string
+  CdpMlFilterCriterionBaseRepresentation:
+    description: Represents Base Cdp Ml Filter Criterion
+    type: object
+    properties:
+      operator:
+        description: Operator type
+        type: string
+        enum:
+          - Between
+          - Contains
+          - EndsWith
+          - Equal
+          - GreaterThan
+          - GreaterThanOrEqual
+          - InSet
+          - LessThan
+          - LessThanOrEqual
+          - NotBetween
+          - NotEqual
+          - NotIn
+          - StartsWith
+      type:
+        description: Filter type
+        type: string
+        enum:
+          - CalculatedInsightObjectField
+          - DataModelObjectField
+          - ModelInputField
+      values:
+        description: Ordered list of values to be applied in the filter
+        type: array
+        items:
+          type: CdpMlFilterValueRepresentation
+  CdpMlFilterRepresentation:
+    description: Represents Cdp Ml filter
+    type: object
+    properties:
+      criteria:
+        description: filter criteria
+        type: array
+        items:
+          type: CdpMlFilterCriterionBaseRepresentation
+  CdpMlFilterValueRepresentation:
+    description: Represents Cdp Ml Filter Value
+    type: object
+    properties:
+      type:
+        description: Filter value type
+        type: string
+        enum:
+          - Constant
+          - Placeholder
+      value:
+        description: Filter value can be a constant or a valid placeholder
+        type: string
+  CdpMlModelParameterDefinitionBaseRepresentation:
+    description: Cdp Ml Model Parameter Base Representation
+    discriminator: type
+    type: object
+    properties:
+      description:
+        description: Parameter description
+        type: string
+      parameterName:
+        description: Parameter Name
+        type: string
+      type:
+        description: Parameter Type
+        type: string
+        enum:
+          - Continuous
+          - Discrete
+  CdpMlModelOutputFieldRepresentation:
+    description: Cdp Ml Model Output Field Representation
+    type: object
+    properties:
+      dataType:
+        description: Field data type
+        type: string
+        enum:
+          - Date
+          - Number
+          - Text
+      position:
+        description: Field position
+        type: integer
+  CdpPaginatedResponseBaseRepresentation:
+    description: Base paginated response representation
+    type: object
+    properties:
+      currentPageUrl:
+        description: Current page url
+        type: string
+      nextPageUrl:
+        description: Next page url if it exists
+        type: string | nil
+      totalSize:
+        description: Total size of collection
+        type: integer
+  CdpMlModelArtifactCollectionRepresentation:
+    description: Cdp Ml Model Artifact Collection Representation
+    type: object
+    properties:
+      modelArtifacts:
+        description: List of model artifacts
+        type: array
+        items:
+          type: CdpMlModelArtifactBaseRepresentation
+      currentPageUrl:
+        description: Current page url
+        type: string
+      nextPageUrl:
+        description: Next page url if it exists
+        type: string | nil
+      totalSize:
+        description: Total size of collection
+        type: integer
+  CdpMlModelFieldBaseRepresentation:
+    description: Cdp Ml Model Field Base Representation
+    type: object
+    properties:
+      dataType:
+        description: Field data type
+        type: string
+        enum:
+          - Date
+          - Number
+          - Text
+      position:
+        description: Field position
+        type: integer
+      label:
+        description: label
+        type: string
+      name:
+        description: name
+        type: string
+  CdpMlModelInputFieldBaseRepresentation:
+    description: Represents Base Cdp Ml Model Input Field
+    type: object
+    properties:
+      isDisparateImpact:
+        description: Whether this field is a disparate impact field
+        type: boolean
+      isPartitionField:
+        description: Is this field used for partition
+        type: boolean
+      isSensitive:
+        description: Whether this field is a sensitive field
+        type: boolean
+      dataType:
+        description: Field data type
+        type: string
+        enum:
+          - Date
+          - Number
+          - Text
+      position:
+        description: Field position
+        type: integer
+  CdpMlModelOutcomeDefinitionRepresentation:
+    description: Cdp Ml Model Outcome Definition Representation
+    type: object
+    properties:
+      fields:
+        description: Model output fields
+        type: array
+        items:
+          type: CdpMlModelOutputFieldRepresentation
+      goal:
+        description: Model outcome goal
+        type: string
+        enum:
+          - Maximize
+          - Minimize
+          - None
+  CdpMlModelTypeRepresentation:
+    description: Cdp Ml Model Type
+    type: object
+    properties:
+      connectorType?:
+        description: Connector Type
+        type: string | nil
+        enum:
+          - OpenAI
+          - SageMaker
+      modelType?:
+        description: Model type
+        type: string | nil
+        enum:
+          - Generative
+          - Predictive
+      sourceType?:
+        description: Source type
+        type: string | nil
+        enum:
+          - EdcNoCode
+          - ModelConnector
+          - OutOfTheBox
+  CdpMlModelRefreshRecipientRepresentation:
+    description: Cdp Ml Model Refresh Recipient Representation
+    type: object
+    properties:
+      displayName:
+        description: Refresh recipient name
+        type: string
+      id:
+        description: Model refresh recipient Id
+        type: string
+      type:
+        description: Refresh recipient type
+        type: string
+        enum:
+          - Group
+          - User
+  CdpMlModelRefreshConfigRepresentation:
+    description: Cdp Ml Model Refresh Configuration Representation
+    type: object
+    properties:
+      isEnabled:
+        description: Returns the value of the enabled flag (true or false)
+        type: boolean
+      recipients:
+        description: List of model recipients
+        type: array
+        items:
+          type: CdpMlModelRefreshRecipientRepresentation
+      schedule:
+        description: Model refresh schedule
+        type: CdpScheduleRepresentation
+  CdpMlWorkspaceBaseRepresentation:
+    description: Cdp Ml Workspace Base Representation
+    type: object
+    properties:
+      activeSetup:
+        description: The active setup, if it exists
+        type: CdpAssetReferenceRepresentation
+      activeSetupVersionNumber:
+        description: The version number of the active setup
+        type: integer
+      description:
+        description: Model description
+        type: string
+      historiesUrl:
+        description: Histories URL
+        type: string
+      latestSetup:
+        description: The latest setup, if it exists
+        type: CdpAssetReferenceRepresentation
+      modelCount:
+        description: Model count
+        type: integer
+      modelType:
+        description: Model type
+        type: CdpMlModelTypeRepresentation
+      modelsUrl:
+        description: Models URL
+        type: string
+      outcomeDefinition:
+        description: Model outcome definition
+        type: CdpMlModelOutcomeDefinitionRepresentation
+      predictionType:
+        description: Model prediction type
+        type: string
+        enum:
+          - BinaryClassification
+          - MulticlassClassification
+          - Regression
+      refreshConfig:
+        description: Model refresh config
+        type: CdpMlModelRefreshConfigRepresentation
+      setupVersionsUrl:
+        description: Setup versions URL
+        type: string
+      status:
+        description: Model status
+        type: string
+        enum:
+          - Disabled
+          - Draft
+          - Enabled
+      totalInferenceCount:
+        description: Model total inference count
+        type: integer
+      totalWarningsCount:
+        description: Model total warnings count
+        type: integer
+      createdBy:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate:
+        description: Created date
+        type: string
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label:
+        description: Label of the asset
+        type: string
+      lastModifiedBy:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate:
+        description: Last modified date
+        type: string
+      name:
+        description: Name of the asset
+        type: string
+      namespace:
+        description: Namespace of the asset
+        type: string
+      url:
+        description: Url
+        type: string
+  CdpMlWorkspaceDetailRepresentation:
+    description: Cdp Ml Workspace Details Representation
+    type: object
+    properties:
+      activations:
+        description: List of activations
+        type: array
+        items:
+          type: string
+          enum:
+            - Flow
+            - PredictionJob
+      activeSetup?:
+        description: The active setup, if it exists
+        type: CdpAssetReferenceRepresentation
+      activeSetupVersionNumber?:
+        description: The version number of the active setup
+        type: integer | nil
+      description?:
+        description: Model description
+        type: string | nil
+      historiesUrl?:
+        description: Histories URL
+        type: string | nil
+      latestSetup?:
+        description: The latest setup, if it exists
+        type: CdpAssetReferenceRepresentation
+      modelCount:
+        description: Model count
+        type: integer
+      modelType?:
+        description: Model type
+        type: CdpMlModelTypeRepresentation
+      modelsUrl?:
+        description: Models URL
+        type: string | nil
+      outcomeDefinition?:
+        description: Model outcome definition
+        type: CdpMlModelOutcomeDefinitionRepresentation
+      predictionType?:
+        description: Model prediction type
+        type: string | nil
+        enum:
+          - BinaryClassification
+          - MulticlassClassification
+          - Regression
+      refreshConfig?:
+        description: Model refresh config
+        type: CdpMlModelRefreshConfigRepresentation
+      setupVersionsUrl?:
+        description: Setup versions URL
+        type: string | nil
+      status:
+        description: Model status
+        type: string
+        enum:
+          - Disabled
+          - Draft
+          - Enabled
+      totalInferenceCount?:
+        description: Model total inference count
+        type: integer | nil
+      totalWarningsCount?:
+        description: Model total warnings count
+        type: integer | nil
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string | nil
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string | nil
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string | nil
+      name:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string | nil
+      url:
+        description: Url
+        type: string
+  CdpMlWorkspaceRepresentation:
+    description: Cdp Ml Workspace Representation
+    type: object
+    properties:
+      activeSetup?:
+        description: The active setup, if it exists
+        type: CdpAssetReferenceRepresentation
+      activeSetupVersionNumber?:
+        description: The version number of the active setup
+        type: integer | nil
+      description?:
+        description: Model description
+        type: string | nil
+      historiesUrl?:
+        description: Histories URL
+        type: string | nil
+      latestSetup?:
+        description: The latest setup, if it exists
+        type: CdpAssetReferenceRepresentation
+      modelCount:
+        description: Model count
+        type: integer
+      modelType:
+        description: Model type
+        type: CdpMlModelTypeRepresentation
+      modelsUrl:
+        description: Models URL
+        type: string
+      outcomeDefinition?:
+        description: Model outcome definition
+        type: CdpMlModelOutcomeDefinitionRepresentation
+      predictionType?:
+        description: Model prediction type
+        type: string | nil
+        enum:
+          - BinaryClassification
+          - MulticlassClassification
+          - Regression
+      refreshConfig?:
+        description: Model refresh config
+        type: CdpMlModelRefreshConfigRepresentation
+      setupVersionsUrl?:
+        description: Setup versions URL
+        type: string | nil
+      status:
+        description: Model status
+        type: string
+        enum:
+          - Disabled
+          - Draft
+          - Enabled
+      totalInferenceCount?:
+        description: Model total inference count
+        type: integer | nil
+      totalWarningsCount?:
+        description: Model total warnings count
+        type: integer | nil
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string | nil
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string | nil
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string | nil
+      name:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string | nil
+      url:
+        description: Url
+        type: string
+  CdpMlWorkspaceCollectionRepresentation:
+    description: Cdp Ml Workspace Collection Representation
+    type: object
+    properties:
+      workspaces:
+        description: List of workspaces
+        type: array
+        items:
+          type: CdpMlWorkspaceRepresentation
+      currentPageUrl?:
+        description: Current page url
+        type: string | nil
+      nextPageUrl?:
+        description: Next page url if it exists
+        type: string | nil
+      totalSize:
+        description: Total size of collection
+        type: integer
+  CdpTimeRepresentation:
+    description: Cdp Time Representation
+    type: object
+    properties:
+      hour:
+        description: Hour
+        type: integer
+      minute:
+        description: Minute
+        type: integer
+      timezone:
+        description: Time Zone
+        type: CdpTimeZoneRepresentation
+  CdpTimeZoneRepresentation:
+    description: Cdp Time Zone Representation
+    type: object
+    properties:
+      gmtOffset:
+        description: Time zone offset to GMT
+        format: double
+        type: number
+      name:
+        description: Time zone name
+        type: string
+      zoneId:
+        description: Time zone identifier
+        type: string
+  CdpScheduleRepresentation:
+    description: Cdp Schedule Representation
+    type: object
+    properties:
+      frequency:
+        description: Schedule frequency
+        type: string
+        enum:
+          - Daily
+          - Hourly
+          - Minutely
+          - Monthly
+          - MonthlyRelative
+          - None
+          - Weekly
+      nextScheduledDate:
+        description: Next Scheduled Date
+        type: string
+      time:
+        description: Schedule Time
+        type: CdpTimeRepresentation
+  MlConfiguredModelCollectionRepresentation:
+    description: Represents Ml Configured Model Collection
+    type: object
+    properties:
+      configuredModels:
+        description: List of configured models
+        type: array
+        items:
+          type: MlConfiguredModelRepresentation
+      currentPageUrl?:
+        description: Current page url
+        type: string
+      nextPageUrl?:
+        description: Next page url if it exists
+        type: string | nil
+      totalSize?:
+        description: Total size of collection
+        type: integer
+  MlConfiguredModelRepresentation:
+    description: Represents Ml Configured Model
+    type: object
+    properties:
+      activations?:
+        description: List of activations
+        type: array
+        items:
+          type: string
+          enum:
+            - Flow
+            - PredictionJob
+      artifact:
+        description: Model Artifact
+        type: CdpAssetReferenceRepresentation
+      capability:
+        description: Model capability
+        type: string
+        enum:
+          - BinaryClassification
+          - ChatCompletion
+          - Completion
+          - Embedding
+          - Generic
+          - MulticlassClassification
+          - Regression
+      connectorType?:
+        description: Connector Type, if the configured model is referencing a model
+          connector
+        type: string | nil
+        enum:
+          - Anthropic
+          - AzureOpenAI
+          - Databricks
+          - EinsteinText
+          - Generic
+          - OpenAI
+          - SageMaker
+          - VertexAI
+          - Bedrock
+      deprecationConfiguration?:
+        description: Deprecation strategy when the model is deprecated
+        type: MlDeprecationConfigurationRepresentation
+      description?:
+        description: User defined description
+        type: string | nil
+      lastActivatedBy?:
+        description: Last activated by
+        type: CdpUserRepresentation
+      lastActivatedDate?:
+        description: Last activated date
+        type: string
+      modelType?:
+        description: Referenced model type
+        type: string
+        enum:
+          - Generative
+          - Predictive
+          - Unknown
+      parameterOverrides?:
+        description: List of Model Parameter Overrides
+        type: array
+        items:
+          type: CdpMlModelParameterOverrideBaseRepresentation
+      region?:
+        description: Region for AWS connection
+        type: string
+      setupType?:
+        description: Referenced setup type
+        type: string
+        enum:
+          - EdcNoCode
+          - ModelConnector
+          - OutOfTheBox
+      status?:
+        description: Model status
+        type: string
+        enum:
+          - Deprecated
+          - Disabled
+          - Enabled
+          - Rerouted
+      visibility?:
+        description: Model visibility
+        type: string
+        enum:
+          - Hidden
+          - Shown
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string | nil
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string | nil
+      name:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string | nil
+      url:
+        description: Url
+        type: string
+  CdpMlAggregatePredictConditionRepresentation:
+    description: Cdp Ml Aggregate Prediction Contribution
+    type: object
+    properties:
+      count?:
+        description: Count of rows included in the aggregate condition
+        type: integer
+  CdpMlPredictionBaseRepresentation:
+    description: Base representation for a prediction result
+    discriminator: status
+    type: object
+    properties:
+      status:
+        description: prediction status
+        type: string
+        enum:
+          - Success
+          - Error
+  CdpMlPredictionErrorRepresentation:
+    description: Failed prediction
+    type: CdpMlPredictionBaseRepresentation
+    discriminatorValue: Error
+    properties:
+      errorCode:
+        description: Error Code for the Error Message
+        type: string
+        enum:
+          - TimedOut
+          - NoMatch
+          - Error
+      message:
+        description: Error Message for Predict Error
+        type: string
+  CdpMlPredictionSuccessBaseRepresentation:
+    description: Base representation for a successful prediction result
+    type: CdpMlPredictionBaseRepresentation
+    discriminator: type
+    discriminatorValue: Success
+    properties:
+      type:
+        description: Prediction type
+        type: string
+        enum:
+          - Regression
+          - BinaryClassification
+          - Generic
+      partition:
+        description: Model partition that's used for this prediction
+        type: CdpAssetReferenceRepresentation
+      warnings:
+        description: Warnings that are generated by the prediction
+        type: CdpMlPredictionWarningsRepresentation
+      factors:
+        description: A list of top factors associated with prediction
+        type: array
+        items:
+          type: CdpMlPredictionContributionBaseRepresentation
+      prescriptions:
+        description: A list of recommendations associated with this prediction
+        type: array
+        items:
+          type: CdpMlPredictionContributionBaseRepresentation
+  CdpMlRegressionPredictionResultRepresentation:
+    description: Representation for a successful regression prediction result
+    type: CdpMlPredictionSuccessBaseRepresentation
+    discriminatorValue: Regression
+    properties:
+      predictedValue:
+        description: Representation for a successful regression prediction result
+        format: double
+        type: number
+  CdpMlBinaryClassificationPredictionResultRepresentation:
+    description: Representation for a successful binary classification prediction result
+    type: CdpMlPredictionSuccessBaseRepresentation
+    discriminatorValue: BinaryClassification
+    properties:
+      predictedValue:
+        description: Predicted value
+        format: double
+        type: number
+      threshold:
+        description: Threshold used
+        format: double
+        type: number
+  CdpMlGenericPredictionResultRepresentation:
+    description: Representation for a successful generic prediction result
+    type: CdpMlPredictionSuccessBaseRepresentation
+    discriminatorValue: Generic
+    properties:
+      outputs:
+        description: Name
+        type: array
+        items:
+          type: CdpMlGenericPredictionOutputValueRepresentation
+  CdpMlGenericPredictionOutputValueRepresentation:
+    description: Representation for a successful generic prediction result
+    type: object
+    properties:
+      name:
+        description: Name
+        type: string
+      value:
+        description: Output Value
+        type: object
+      type:
+        description: Output Data type
+        type: string
+        enum:
+          - Text
+          - Number
+          - Date
+          - Boolean
+  CdpMlPredictionContributionBaseRepresentation:
+    description: Base representation for a Prediction Contribution
+    type: object
+    properties:
+      value:
+        description: Contribution value
+        format: double
+        type: number
+      fields:
+        description: List of field and values that have the same contribution value
+        type: array
+        items:
+          type: CdpMlPredictionContributionFieldRepresentation
+  CdpMlPredictionContributionFieldRepresentation:
+    description: Cdp Ml Prediction Contribution Field
+    type: object
+    properties:
+      prescribedValue:
+        description: Model output value for the field (i.e. recommended value to improve prediction)
+        type: string
+      inputValue:
+        description: Input value used for this field
+        type: string
+      customText:
+        description:
+        type: CdpMlPredictionFieldCustomTextRepresentation
+  CdpMlPredictionFieldCustomTextRepresentation:
+    description: Cdp Ml Prediction Field Custom Text
+    type: object
+    properties:
+      templateText:
+        description: Template text if custom override is defined for the column.
+        type: string
+      mergeFieldValues:
+        description: Provides placeholder to resolved value defined in the template text. Null if there are no placeholders.
+        type: any
+      isHidden:
+        description:
+        type: boolean
+  CdpMlPredictionWarningsRepresentation:
+    description: Representation for prediction warnings
+    type: object
+    properties:
+      outOfBoundsFields:
+        description: A list of fields that contain values that are not seen in the model
+        type: array
+        items:
+          type: CdpMlFieldValueRepresentation
+      missingFielsNames:
+        description: A list of missing field names
+        type: array
+        items:
+          type: string
+  CdpMlFieldValueRepresentation:
+    description: Cdp Ml Field Value
+    type: object
+    properties:
+      value:
+        description: Field value
+        type: string
+      count:
+        description: Count of the value
+        type: integer
+  CdpMlAggregatePredictionRepresentation:
+    description: Cdp Ml Prediction result representation
+    type: object
+    properties:
+      status?:
+        description: Status of aggregate prediction
+        type: string | nil
+        enum:
+          - Success
+          - Error
+      type?:
+        description: Type of aggregate prediction
+        type: string | nil
+        enum:
+          - Average
+          - Median
+          - Sum
+      factors?:
+        description: Top factors associated to this aggregate prediction
+        type: array
+        items:
+          type: CdpMlAggregatePredictConditionRepresentation
+      prescriptions?:
+        description: Prescriptions associated to this aggregate prediction
+        type: array
+        items:
+          type: CdpMlAggregatePredictConditionRepresentation
+      value?:
+        description: Aggregate prediction value
+        format: double
+        type: number
+  CdpMlPredictSettingsInputRepresentation:
+    description: Predict Settings Representation
+    type: object
+    properties:
+      maxPrescriptions?:
+        description: Maximum recommendation count. Default value is -1 (unlimited) and the allowed range is [-1, 200]
+        type: integer
+      prescriptionImpactPercentage?:
+        description: Impact Percentage of Prescriptions, Default is set at 0
+        type: integer
+      maxTopFactors?:
+        description: Maximum top factor count. Default value is 0 and the allowed range is [0, 3]
+        type: integer
+      aggregateFunctions?:
+        description: List of aggregate functions
+        type: array
+        items:
+          type: string | nil
+  CdpMlPredictResultRepresentation:
+    description: Cdp Ml Prediction result representation
+    type: object
+    properties:
+      model:
+        description: Model asset reference used as part of the prediction request
+        type: CdpAssetReferenceRepresentation
+      predictionType:
+        description: Prediction Type
+        type: string
+        enum:
+          - Regression
+          - BinaryClassification
+          - MulticlassClassification
+          - Generic/Unknown
+      predictions?:
+        description: A list of prediction results
+        type: array
+        items:
+          type: CdpMlPredictionBaseRepresentation
+      aggregatePredictions?:
+        description: Aggregate Result List
+        type: array
+        items:
+          type: CdpMlAggregatePredictionRepresentation
+      settings:
+        description: Settings used for the prediction
+        type: CdpMlPredictSettingsInputRepresentation
+  MlConfiguredModelInputRepresentation:
+    description: Input representation for a Ml Configured Model
+    type: object
+    properties:
+      artifact?:
+        description: Artifact
+        type: CdpAssetReferenceInputRepresentation
+      capability?:
+        description: Model capability
+        type: string
+        enum:
+          - BinaryClassification
+          - ChatCompletion
+          - Completion
+          - Embedding
+          - Generic
+          - MulticlassClassification
+          - Regression
+      description?:
+        description: Model description
+        type: string
+      label?:
+        description: Model label
+        type: string
+      parameterOverrides?:
+        description: Model Parameter override
+        type: array
+        items:
+          type: CdpMlModelParameterOverrideInputRepresentation
+      status?:
+        description: Model status
+        type: string
+        enum:
+          - Disabled
+          - Enabled
+      visibility?:
+        description: Model visibility
+        type: string
+        enum:
+          - Hidden
+          - Shown
+  MlDeprecationConfigurationRepresentation:
+    description: Ml Deprecation Configuration Representation
+    type: object
+    properties:
+      deprecationDate?:
+        description: Deprecation date
+        type: string | nil
+      endOfLifeDate?:
+        description: End of life date
+        type: string | nil
+      endOfLifePolicy?:
+        description: End of life policy
+        type: string | nil
+        enum:
+          - RollOver
+      rollOverModelArtifactReference?:
+        description: Roll over model artifact reference if policy is rollover
+        type: CdpAssetReferenceRepresentation
+  CdpMlPredictRawDataInputRepresentation:
+    description: Raw Data Input Representation
+    type: object
+    properties:
+      type:
+        description: prediction type enum
+        type: string
+        enum:
+          - Records
+          - RawData
+          - RecordOverrides
+      model:
+        description: Model Reference
+        type: CdpAssetReferenceInputRepresentation
+      fieldNames:
+        description: Field names
+        type: array
+        items:
+          type: string
+      rows:
+        description: Rows of values
+        type: array
+        items:
+          type: array
+          items:
+            type: string
+/ssot:
+  /machine-learning:
+    /model-artifacts:
+      get:
+        displayName: getCdpMlModelArtifactCollection
+        description: Get Model Artifacts
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpMlModelArtifactCollectionRepresentation
+        queryParameters:
+          limit:
+            type: integer
+            required: false
+          modelType:
+            type: string
+            required: false
+            enum:
+              - Generative
+              - Predictive
+              - Unknown
+          offset:
+            type: integer
+            required: false
+          sourceType:
+            type: string
+            required: false
+            enum:
+              - EdcNoCode
+              - ModelConnector
+              - OutOfTheBox
+    /model-artifacts/{modelArtifactIdOrName}:
+      get:
+        displayName: getCdpMlModelArtifact
+        description: Get Model Artifact
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpMlModelArtifactBaseRepresentation
+      uriParameters:
+        modelArtifactIdOrName:
+          type: string
+          required: true
+    /configured-models:
+      get:
+        displayName: getMlConfiguredModelCollection
+        description: Get configured models
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: MlConfiguredModelCollectionRepresentation
+        queryParameters:
+          assetIdOrName:
+            type: string
+            required: false
+          assetType:
+            type: string
+            required: false
+            enum:
+              - ModelArtifact
+              - ModelSetup
+          capabilities:
+            type: array
+            required: false
+            items:
+              type: string
+              enum:
+                - BinaryClassification
+                - ChatCompletion
+                - Completion
+                - Embedding
+                - Generic
+                - MulticlassClassification
+                - Regression
+              (oas-collectionFormat): csv
+          connectorType:
+            type: string
+            required: false
+            enum:
+              - Anthropic
+              - AzureOpenAI
+              - Databricks
+              - EinsteinText
+              - Generic
+              - OpenAI
+              - SageMaker
+              - VertexAI
+              - Bedrock
+          limit:
+            type: integer
+            required: false
+          modelType:
+            type: string
+            required: false
+            enum:
+              - Generative
+              - Predictive
+              - Unknown
+          offset:
+            type: integer
+            required: false
+          outOfTheBox:
+            type: boolean
+            required: false
+          search:
+            type: string
+            required: false
+          sourceType:
+            type: string
+            required: false
+            enum:
+              - EdcNoCode
+              - ModelConnector
+              - OutOfTheBox
+      post:
+        displayName: createMlConfiguredModel
+        description: Create a new configured model
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: MlConfiguredModelRepresentation
+        body:
+          application/json:
+            type: MlConfiguredModelInputRepresentation
+            (oas-body-name): configuredModel
+    /configured-models/{configuredModelIdOrName}:
+      get:
+        displayName: getMlConfiguredModel
+        description: Get a configured model
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: MlConfiguredModelRepresentation
+        queryParameters:
+          filterGroup:
+            type: string
+            required: false
+      patch:
+        displayName: updateMlConfiguredModel
+        description: Update a configured model
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: MlConfiguredModelRepresentation
+        body:
+          application/json:
+            type: MlConfiguredModelInputRepresentation
+            (oas-body-name): configuredModel
+      uriParameters:
+        configuredModelIdOrName:
+          type: string
+          required: true
+    /workspaces:
+      get:
+        displayName: getCdpMlWorkspaceCollection
+        description: Get workspaces
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpMlWorkspaceCollectionRepresentation
+        queryParameters:
+          limit:
+            type: integer
+            required: false
+          modelType:
+            type: string
+            required: false
+            enum:
+              - Generative
+              - Predictive
+              - Unknown
+          offset:
+            type: integer
+            required: false
+          predictionType:
+            type: string
+            required: false
+            enum:
+              - BinaryClassification
+              - Generic
+              - MulticlassClassification
+              - Regression
+          search:
+            type: string
+            required: false
+          sourceType:
+            type: string
+            required: false
+            enum:
+              - EdcNoCode
+              - ModelConnector
+              - OutOfTheBox
+          status:
+            type: string
+            required: false
+            enum:
+              - Disabled
+              - Draft
+              - Enabled
+    /workspaces/{workspaceIdOrName}:
+      get:
+        displayName: getCdpMlWorkspace
+        description: Get workspace
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpMlWorkspaceDetailRepresentation
+      uriParameters:
+        workspaceIdOrName:
+          type: string
+          required: true
+      /models:
+        get:
+          displayName: getCdpMlConfiguredModelCollection
+          description: Get configured models
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CdpMlConfiguredModelCollectionRepresentation
+          queryParameters:
+            capabilities:
+              type: array
+              required: false
+              items:
+                type: string
+                enum:
+                  - BinaryClassification
+                  - ChatCompletion
+                  - Completion
+                  - Embedding
+                  - Generic
+                  - MulticlassClassification
+                  - Regression
+                (oas-collectionFormat): csv
+        post:
+          displayName: createCdpMlConfiguredModel
+          description: Create a new configured model
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CdpMlConfiguredModelRepresentation
+          body:
+            application/json:
+              type: CdpMlConfiguredModelInputRepresentation
+              (oas-body-name): model
+        uriParameters:
+          workspaceIdOrName:
+            type: string
+            required: true
+      /models/{modelIdOrName}:
+        get:
+          displayName: getCdpMlConfiguredModel
+          description: Get a configured model
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CdpMlConfiguredModelRepresentation
+        patch:
+          displayName: updateCdpMlConfiguredModel
+          description: Update a configured model
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CdpMlConfiguredModelRepresentation
+          body:
+            application/json:
+              type: CdpMlConfiguredModelInputRepresentation
+              (oas-body-name): model
+        uriParameters:
+          modelIdOrName:
+            type: string
+            required: true
+          workspaceIdOrName:
+            type: string
+            required: true
+    /predict:
+      post:
+        displayName: CdpMlPredictResult
+        description: Get prediction result
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpMlPredictResultRepresentation
+        body:
+          application/json:
+            type: CdpMlPredictRawDataInputRepresentation
+            (oas-body-name): predictInput