Interface IRequestSourceService

Namespace

FoundationaLLM.Vectorization.Interfaces

Assembly

FoundationaLLM.Vectorization.Engine.dll

Manages vectorization requests.

public interface IRequestSourceService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

SourceName

The name of the vectorization request source.

string SourceName { get; }

Property Value

string

Methods

DeleteRequest(string, string)

Removes a specified vectorization request from the source. This should happen when the request was successfully processed.

Task DeleteRequest(string messageId, string popReceipt)

Parameters

messageId string

The underlying message identifier of the request being removed.

popReceipt string

This value is required to delete the request.

Returns

Task

HasRequests()

Indicates whether the source has pending requests.

Task<bool> HasRequests()

Returns

Task<bool>

A bool indicating whether the source has pending requests or not.

ReceiveRequests(int)

Receives the specified number of requests. The received requests will be invisible for other clients for a default timeout of 30 seconds. They should be removed from the source by calling DeleteRequest(string, string) before the timeout expires.

Task<IEnumerable<VectorizationDequeuedRequest>> ReceiveRequests(int count)

Parameters

count int

The number of requests to receive.

Returns

Task<IEnumerable<VectorizationDequeuedRequest>>

A collection of VectorizationDequeuedRequest items.

SubmitRequest(string)

Submits a new vectorization request to the source.

Task<string> SubmitRequest(string requestName)

Parameters

requestName string

The name (unique identifier) of the vectorization request.

Returns

Task<string>

The underlying message identifier of the request being submitted.

TryUpdateRequest(string, string, TimeSpan)

Tries to update the visibility timeout of a request.

Task<bool> TryUpdateRequest(string messageId, string popReceipt, TimeSpan visibilityTimeout)

Parameters

messageId string

The underlying message identifier of the request being updated.

popReceipt string

The value requiored to update the underlying message.

visibilityTimeout TimeSpan

The new visibility timeout of the request.

Returns

Task<bool>

true if the update is successfull, false otherwise.