Jump to

• Request
• Response

(Preview) Log experiment run inputs

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-inputs

(Preview) Logs experiment run inputs.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  The key of the Workspace

Header Parameters

• dh-user-principal: string
  The DH User Principal Header .
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

Details of experiment run inputs.

Root Schema : LogExperimentRunInputsDetails

Type: object

Run inputs.

Show Source

• dataset_inputs: array dataset_inputs
  Dataset inputs for the run.
• run_id(required): string
  Unique identifier for the run.

{
    "description":"Run inputs.",
    "type":"object",
    "required":[
        "run_id"
    ],
    "properties":{
        "run_id":{
            "type":"string",
            "description":"Unique identifier for the run."
        },
        "dataset_inputs":{
            "type":"array",
            "description":"Dataset inputs for the run.",
            "items":{
                "$ref":"#/definitions/DatasetInput"
            }
        }
    }
}

Nested Schema : dataset_inputs

Type: array

Dataset inputs for the run.

Show Source

• Array of: object DatasetInput
  DatasetInput

{
    "type":"array",
    "description":"Dataset inputs for the run.",
    "items":{
        "$ref":"#/definitions/DatasetInput"
    }
}

Nested Schema : DatasetInput

Type: object

DatasetInput

Show Source

• dataset(required): object Dataset
  Dataset. Represents a reference to data used for training, testing, or evaluation during the model development process.
• tags: array tags
  Tags for the dataset input.

{
    "description":"DatasetInput",
    "type":"object",
    "required":[
        "dataset"
    ],
    "properties":{
        "dataset":{
            "$ref":"#/definitions/Dataset"
        },
        "tags":{
            "type":"array",
            "description":"Tags for the dataset input.",
            "items":{
                "$ref":"#/definitions/InputTag"
            }
        }
    }
}

Nested Schema : Dataset

Type: object

Dataset. Represents a reference to data used for training, testing, or evaluation during the model development process.

Show Source

• digest(required): string
  Digest (hash) of the dataset.
• name(required): string
  Name of the dataset.
• profile: string
  Profile of the dataset.
• schema: string
  Schema of the dataset.
• source(required): string
  URI or path to the dataset source.
• source_type(required): string
  Type of the dataset source.

{
    "type":"object",
    "description":"Dataset. Represents a reference to data used for training, testing, or evaluation during the model development process.",
    "required":[
        "name",
        "digest",
        "source_type",
        "source"
    ],
    "properties":{
        "name":{
            "description":"Name of the dataset.",
            "type":"string"
        },
        "digest":{
            "description":"Digest (hash) of the dataset.",
            "type":"string"
        },
        "source_type":{
            "description":"Type of the dataset source.",
            "type":"string"
        },
        "source":{
            "description":"URI or path to the dataset source.",
            "type":"string"
        },
        "schema":{
            "description":"Schema of the dataset.",
            "type":"string"
        },
        "profile":{
            "description":"Profile of the dataset.",
            "type":"string"
        }
    }
}

Nested Schema : tags

Type: array

Tags for the dataset input.

Show Source

• Array of: object InputTag
  Run tag.

{
    "type":"array",
    "description":"Tags for the dataset input.",
    "items":{
        "$ref":"#/definitions/InputTag"
    }
}

Nested Schema : InputTag

Type: object

Run tag.

Show Source

• key(required): string
  Key of the tag.
• value(required): string
  Value of the tag.

{
    "type":"object",
    "description":"Run tag.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "description":"Key of the tag.",
            "type":"string"
        },
        "value":{
            "description":"Value of the tag.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Experiment run inputs are logged.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : LogExperimentRunInputsResponseDetails

Type: object

Response object for logging experiment run inputs.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top