Class StorageQueueRequestSourceService

Namespace

FoundationaLLM.Vectorization.Services.RequestSources

Assembly

FoundationaLLM.Vectorization.Engine.dll

Implements a request source that uses Azure storage queues.

public class StorageQueueRequestSourceService : IRequestSourceService

Inheritance

object

StorageQueueRequestSourceService

Implements

IRequestSourceService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

StorageQueueRequestSourceService(RequestSourceServiceSettings, ILogger<StorageQueueRequestSourceService>)

Creates a new instance of the request source.

public StorageQueueRequestSourceService(RequestSourceServiceSettings settings, ILogger<StorageQueueRequestSourceService> logger)

Parameters

settings RequestSourceServiceSettings

The RequestSourceServiceSettings object providing the settings.

logger ILogger<StorageQueueRequestSourceService>

The logger used for logging.

Properties

SourceName

The name of the vectorization request source.

public 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.

public 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.

public 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.

public 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.

public 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.

public 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.