Interface IInferenceRequestRepository

Interface for access stored inference requests.

Namespace: Monai.Deploy.InformaticsGateway.Database.Api.Repositories

Assembly: Monai.Deploy.InformaticsGateway.Database.Api.dll

Syntax

public interface IInferenceRequestRepository

Methods

| Improve this Doc View Source

AddAsync(InferenceRequest, CancellationToken)

Adds new inference request to the repository.

Declaration

Task AddAsync(InferenceRequest inferenceRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
InferenceRequest	inferenceRequest	The inference request to be added.
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Improve this Doc View Source

ExistsAsync(String, CancellationToken)

Exists checks whether if an existing request with the same transaction ID exists.

Declaration

Task<bool> ExistsAsync(string transactionId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	transactionId
CancellationToken	cancellationToken

Returns

Type	Description
Task<System.Boolean>

| Improve this Doc View Source

GetInferenceRequestAsync(Guid, CancellationToken)

Get returns the specified inference request.

Declaration

Task<InferenceRequest> GetInferenceRequestAsync(Guid inferenceRequestId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Guid	inferenceRequestId	The internal ID of the request.
CancellationToken	cancellationToken

Returns

Type	Description
Task<InferenceRequest>

| Improve this Doc View Source

GetInferenceRequestAsync(String, CancellationToken)

Get returns the specified inference request.

Declaration

Task<InferenceRequest> GetInferenceRequestAsync(string transactionId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	transactionId	The transactionId of the request.
CancellationToken	cancellationToken

Returns

Type	Description
Task<InferenceRequest>

| Improve this Doc View Source

GetStatusAsync(String, CancellationToken)

GetStatus returns the status of the specified inference request.

Declaration

Task<InferenceStatusResponse> GetStatusAsync(string transactionId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	transactionId	The transactionId from the original request.
CancellationToken	cancellationToken

Returns

Type	Description
Task<InferenceStatusResponse>

| Improve this Doc View Source

TakeAsync(CancellationToken)

Take returns the next pending inference request for data retrieval. The default implementation blocks the call until a pending inference request is available for process.

Declaration

Task<InferenceRequest> TakeAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	cancellation token used to cancel the action.

Returns

Type	Description
Task<InferenceRequest>	InferenceRequest

| Improve this Doc View Source

UpdateAsync(InferenceRequest, InferenceRequestStatus, CancellationToken)

Updates an inference request's status. The default implementation drops the request after 3 retries if status is Fail.

Declaration

Task UpdateAsync(InferenceRequest inferenceRequest, InferenceRequestStatus status, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
InferenceRequest	inferenceRequest	The inference request to be updated.
InferenceRequestStatus	status	Current status of the inference request.
CancellationToken	cancellationToken

Returns

Type	Description
Task