Jump to

• Request
• Response

(Preview) Get model deployment inference details

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/model-deployments/{deploymentId}/monitoring/inferences/{requestId}

(Preview) Returns request and response payloads for one correlated inference invocation identified by its request ID. The identifier contains forward slashes, so each slash must be percent-encoded as %2F in the path. Example `requestId`: `abc123%2Fdef456%2F789abc`.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• deploymentId(required): string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[0-9a-f]{32}$

  The unique 32-character hexadecimal ID of the model deployment.
• requestId(required): string
  Minimum Length: 1

  Maximum Length: 1024

  Request ID that identifies the inference invocation record, as returned in the requestId field of the search results. This value contains forward slashes, so each slash must be percent-encoded as %2F when the value is placed in the path. Example encoded value: abc123%2Fdef456%2F789abc.

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Inference invocation details are returned.

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 : InferenceInvocationDetails

Type: object

Details for a single correlated inference request and response record.

Show Source

• latencyMs: integer(int64)
  Minimum Value: 0

  Response latency in milliseconds.
• metadata(required): object InferenceInvocationMetadata
  Metadata recorded with the inference request and response events.
• modelVersion: string
  Model version associated with the invocation.
• requestId(required): string
  Request ID of the inference invocation, used to correlate the request and response events.
• requestPayload: object requestPayload
  Additional Properties Allowed: true

  Request payload captured in the inference request event.
• requestTimestamp(required): string(date-time)
  Timestamp recorded for the inference request event.
• requestUri(required): string
  Inference endpoint URI.
• responsePayload: object responsePayload
  Additional Properties Allowed: true

  Response payload captured in the inference response event.
• status(required): string
  Allowed Values: [ "SUCCESS", "MALFORMED", "FAILED", "UNKNOWN" ]

  Status derived from the correlated inference response event.

{
    "description":"Details for a single correlated inference request and response record.",
    "type":"object",
    "required":[
        "requestTimestamp",
        "requestUri",
        "status",
        "requestId",
        "metadata"
    ],
    "properties":{
        "requestTimestamp":{
            "description":"Timestamp recorded for the inference request event.",
            "type":"string",
            "format":"date-time"
        },
        "latencyMs":{
            "description":"Response latency in milliseconds.",
            "type":"integer",
            "format":"int64",
            "minimum":0
        },
        "requestUri":{
            "description":"Inference endpoint URI.",
            "type":"string"
        },
        "modelVersion":{
            "description":"Model version associated with the invocation.",
            "type":"string"
        },
        "status":{
            "description":"Status derived from the correlated inference response event.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/InferenceInvocationStatus",
            "enum":[
                "SUCCESS",
                "MALFORMED",
                "FAILED",
                "UNKNOWN"
            ]
        },
        "requestId":{
            "description":"Request ID of the inference invocation, used to correlate the request and response events.",
            "type":"string"
        },
        "requestPayload":{
            "description":"Request payload captured in the inference request event.",
            "type":"object",
            "additionalProperties":true
        },
        "responsePayload":{
            "description":"Response payload captured in the inference response event.",
            "type":"object",
            "additionalProperties":true
        },
        "metadata":{
            "$ref":"#/definitions/InferenceInvocationMetadata"
        }
    }
}

Nested Schema : InferenceInvocationMetadata

Type: object

Metadata recorded with the inference request and response events.

Show Source

• caller: string
  Caller recorded on the inference request event.
• region: string
  OCI region that served the inference invocation.
• replicaId: string
  Identifier of the model deployment replica that served the invocation.

{
    "description":"Metadata recorded with the inference request and response events.",
    "type":"object",
    "properties":{
        "region":{
            "description":"OCI region that served the inference invocation.",
            "type":"string"
        },
        "replicaId":{
            "description":"Identifier of the model deployment replica that served the invocation.",
            "type":"string"
        },
        "caller":{
            "description":"Caller recorded on the inference request event.",
            "type":"string"
        }
    }
}

Nested Schema : requestPayload

Type: object

Additional Properties Allowed: true

Request payload captured in the inference request event.

Nested Schema : responsePayload

Type: object

Additional Properties Allowed: true

Response payload captured in the inference response event.

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"
        }
    }
}

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