Class InferenceRequest

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

Inheritance
Object
InferenceRequest
Namespace: Nvidia.Clara.DicomAdapter.API.Rest
Assembly: Nvidia.Clara.Dicom.API.dll
Syntax
public class InferenceRequest : object
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

Algorithm

Declaration
public InputConnectionDetails Algorithm { get; }
Property Value
Type Description
InputConnectionDetails
| Improve this Doc View Source

ClaraJobPriority

Declaration
public JobPriority ClaraJobPriority { get; }
Property Value
Type Description
JobPriority
| 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
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
public IList<RequestInputDataResource> InputResources { get; set; }
Property Value
Type Description
IList<RequestInputDataResource>
| Improve this Doc View Source

JobId

Internal use - gets or sets the Job ID for the request once public Guid InferenceRequestId { get; set; } = Guid.NewGuid(); the job is created with Clara Platform Jobs API.

Declaration
public string JobId { get; set; }
Property Value
Type Description
String
Remarks

Internal use only.

| Improve this Doc View Source

JobName

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

OutputResources

Gets or set a list of data sources to export results to. In order to export via DICOMweb, the Clara Pipeline must include and use Register Results Operator and register the results with agent name "DICOMweb" or the values configured in dicom>scu>export>agent field.

Declaration
public IList<RequestOutputDataResource> OutputResources { get; set; }
Property Value
Type Description
IList<RequestOutputDataResource>
| Improve this Doc View Source

PayloadId

Internal use only - get or sets the Payload ID for the request once the job is created with Clara Platform Jobs API.

Declaration
public string PayloadId { get; set; }
Property Value
Type Description
String
Remarks

Internal use only.

| Improve this Doc View Source

Priority

Gets or sets the priority of a request.

Declaration
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
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
public InferenceRequestStatus Status { get; set; }
Property Value
Type Description
InferenceRequestStatus
Remarks

Internal use only.

| Improve this Doc View Source

StoragePath

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

Declaration
public string StoragePath { get; set; }
Property Value
Type Description
String
Remarks

Internal use only.

| Improve this Doc View Source

TransactionId

Gets or set the transaction ID of a request.

Declaration
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
public int TryCount { get; set; }
Property Value
Type Description
Int32
Remarks

Internal use only.

Methods

| Improve this Doc View Source

ConfigureTemporaryStorageLocation(String)

Configures temporary storage location used to store retrieved data.

Declaration
public void ConfigureTemporaryStorageLocation(string storagePath)
Parameters
Type Name Description
String storagePath
| 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