Class InferenceRequest

Structure that represents an inference request based on ACR's Platform-Model Communication for AI.

Inheritance
Object
InferenceRequest
Namespace: Monai.Deploy.InformaticsGateway.Api.Rest
Assembly: Monai.Deploy.InformaticsGateway.Api.dll
Syntax
public class InferenceRequest
Remarks

Refer to ACR DSI Model API for more information.

transactionID> is required.

inputMetadata> is required.

inputResources> is required.

Examples
{
    "transactionID": "ABCDEF123456",
    "priority": "255",
    "inputMetadata": { ... },
    "inputResources": [ ... ],
    "outputResources": [ ... ]
}

Constructors

| Improve this Doc View Source

InferenceRequest()

Declaration
public InferenceRequest()

Properties

| Improve this Doc View Source

Application

Declaration
[JsonIgnore]
public InputConnectionDetails Application { get; }
Property Value
Type Description
InputConnectionDetails
| Improve this Doc View Source

CreatedBy

Gets or set the user who created the DICOM entity.

Declaration
public string CreatedBy { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

DateTimeCreated

Gets or set the date and time the objects first created.

Declaration
public DateTime? DateTimeCreated { get; set; }
Property Value
Type Description
System.Nullable<DateTime>
| Improve this Doc View Source

InferenceRequestId

Unique identity for the request.

Declaration
public Guid InferenceRequestId { get; set; }
Property Value
Type Description
Guid
| Improve this Doc View Source

InputMetadata

Gets or sets the details of the data associated with the inference request.

Declaration
[JsonPropertyName("inputMetadata")]
public InferenceRequestMetadata InputMetadata { get; set; }
Property Value
Type Description
InferenceRequestMetadata
| Improve this Doc View Source

InputResources

Gets or set a list of data sources to query/retrieve data from. When multiple data sources are specified, the system will query based on the order the list was received.

Declaration
[JsonPropertyName("inputResources")]
public IList<RequestInputDataResource> InputResources { get; set; }
Property Value
Type Description
IList<RequestInputDataResource>
| Improve this Doc View Source

OutputResources

Gets or set a list of data sources to export results to. In order to export via DICOMweb, an Export Sink must be created and connected to the deployed application via the MONAI Workload Manager. Followed by registering the results using the MONAI App SDK.

Declaration
[JsonPropertyName("outputResources")]
public IList<RequestOutputDataResource> OutputResources { get; set; }
Property Value
Type Description
IList<RequestOutputDataResource>
| Improve this Doc View Source

Priority

Gets or sets the priority of a request.

Declaration
[JsonPropertyName("priority")]
public byte Priority { get; set; }
Property Value
Type Description
Byte
Remarks

Default value is 128 which maps to JOB_PRIORITY_NORMAL.

Any value lower than 128 is map to JOB_PRIORITY_LOWER.

Any value between 129-254 (inclusive) is set to JOB_PRIORITY_HIGHER.

Value of 255 maps to JOB_PRIORITY_IMMEDIATE.

| Improve this Doc View Source

State

Internal use only - get or sets the state of a inference request.

Declaration
[JsonPropertyName("state")]
public InferenceRequestState State { get; set; }
Property Value
Type Description
InferenceRequestState
Remarks

Internal use only.

| Improve this Doc View Source

Status

Internal use only - get or sets the status of a inference request.

Declaration
[JsonPropertyName("status")]
public InferenceRequestStatus Status { get; set; }
Property Value
Type Description
InferenceRequestStatus
Remarks

Internal use only.

| Improve this Doc View Source

TransactionId

Gets or set the transaction ID of a request.

Declaration
[JsonPropertyName("transactionID")]
public string TransactionId { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

TryCount

Internal use only - get or sets number of retries performed.

Declaration
[JsonPropertyName("tryCount")]
public int TryCount { get; set; }
Property Value
Type Description
Int32
Remarks

Internal use only.

Methods

| Improve this Doc View Source

IsValid(out String)

Declaration
public bool IsValid(out string details)
Parameters
Type Name Description
String details
Returns
Type Description
Boolean
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides