Interface IVectorizationManagementClient

Namespace

FoundationaLLM.Client.Management.Interfaces

Assembly

FoundationaLLM.Client.Management.dll

Provides methods to manage vectorization resources.

public interface IVectorizationManagementClient

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

ActivateVectorizationPipelineAsync(string)

Activates a vectorization pipeline.

Task<VectorizationResult> ActivateVectorizationPipelineAsync(string pipelineName)

Parameters

pipelineName string

The vectorization pipeline to activate.

Returns

Task<VectorizationResult>

CheckIndexingProfileNameAsync(ResourceName)

Checks the availability of a resource name for an indexing profile. If the name is available, the Status value will be "Allowed". If the name is not available, the Status value will be "Denied" and the Message will explain the reason why. Typically, a denied name is due to a name conflict with an existing indexing profile or an indexing profile that was deleted but not purged.

Task<ResourceNameCheckResult> CheckIndexingProfileNameAsync(ResourceName resourceName)

Parameters

resourceName ResourceName

Contains the name of the resource to check.

Returns

Task<ResourceNameCheckResult>

Exceptions

ArgumentException

Thrown when the required properties within the argument are empty or missing.

DeactivateVectorizationPipelineAsync(string)

Deactivates a vectorization pipeline.

Task<VectorizationResult> DeactivateVectorizationPipelineAsync(string pipelineName)

Parameters

pipelineName string

The vectorization pipeline to deactivate.

Returns

Task<VectorizationResult>

DeleteIndexingProfileAsync(string)

Deletes an indexing profile resource by name. Please note that all deletes are soft deletes. The resource will be marked as deleted but not purged. To permanently remove a resource, execute the PurgeIndexingProfileAsync(string) method with the same name.

Task DeleteIndexingProfileAsync(string name)

Parameters

name string

The name of the indexing profile resource to delete.

Returns

Task

DeleteTextEmbeddingProfileAsync(string)

Deletes a text embedding profile resource by name. Please note that all deletes are soft deletes. The resource will be marked as deleted but not purged. To permanently remove a resource, execute the PurgeTextEmbeddingProfileAsync(string) method with the same name.

Task DeleteTextEmbeddingProfileAsync(string name)

Parameters

name string

The name of the text embedding profile resource to delete.

Returns

Task

DeleteTextPartitioningProfileAsync(string)

Deletes a text partitioning profile resource by name. Please note that all deletes are soft deletes. The resource will be marked as deleted but not purged. To permanently remove a resource, execute the PurgeTextPartitioningProfileAsync(string) method with the same name.

Task DeleteTextPartitioningProfileAsync(string name)

Parameters

name string

The name of the text partitioning profile resource to delete.

Returns

Task

DeleteVectorizationPipelineAsync(string)

Deletes a vectorization pipeline resource by name. Please note that all deletes are soft deletes. The resource will be marked as deleted but not purged. To permanently remove a resource, execute the PurgeVectorizationPipelineAsync(string) method with the same name.

Task DeleteVectorizationPipelineAsync(string name)

Parameters

name string

The name of the vectorization pipeline resource to delete.

Returns

Task

FilterIndexingProfileAsync(ResourceFilter)

Returns indexing profiles that match the filter criteria.

Task<List<IndexingProfile>> FilterIndexingProfileAsync(ResourceFilter resourceFilter)

Parameters

resourceFilter ResourceFilter

The filter criteria to apply to the request.

Returns

Task<List<IndexingProfile>>

GetIndexingProfileAsync(string)

Retrieves a specific indexing profile by name.

Task<ResourceProviderGetResult<IndexingProfile>> GetIndexingProfileAsync(string name)

Parameters

name string

The name of the indexing profile to retrieve.

Returns

Task<ResourceProviderGetResult<IndexingProfile>>

GetIndexingProfilesAsync()

Retrieves all indexing profiles.

Task<List<ResourceProviderGetResult<IndexingProfile>>> GetIndexingProfilesAsync()

Returns

Task<List<ResourceProviderGetResult<IndexingProfile>>>

All indexing profiles to which the caller has access and which have not been marked as deleted.

GetTextEmbeddingProfileAsync(string)

Retrieves a specific text embedding profile by name.

Task<ResourceProviderGetResult<TextEmbeddingProfile>> GetTextEmbeddingProfileAsync(string name)

Parameters

name string

The name of the text embedding profile to retrieve.

Returns

Task<ResourceProviderGetResult<TextEmbeddingProfile>>

GetTextEmbeddingProfilesAsync()

Retrieves all text embedding profiles.

Task<List<ResourceProviderGetResult<TextEmbeddingProfile>>> GetTextEmbeddingProfilesAsync()

Returns

Task<List<ResourceProviderGetResult<TextEmbeddingProfile>>>

All text embedding profiles to which the caller has access and which have not been marked as deleted.

GetTextPartitioningProfileAsync(string)

Retrieves a specific text partitioning profile by name.

Task<ResourceProviderGetResult<TextPartitioningProfile>> GetTextPartitioningProfileAsync(string name)

Parameters

name string

The name of the text partitioning profile to retrieve.

Returns

Task<ResourceProviderGetResult<TextPartitioningProfile>>

GetTextPartitioningProfilesAsync()

Retrieves all text partitioning profiles.

Task<List<ResourceProviderGetResult<TextPartitioningProfile>>> GetTextPartitioningProfilesAsync()

Returns

Task<List<ResourceProviderGetResult<TextPartitioningProfile>>>

All text partitioning profiles to which the caller has access and which have not been marked as deleted.

GetVectorizationPipelineAsync(string)

Retrieves a specific vectorization pipeline by name.

Task<ResourceProviderGetResult<VectorizationPipeline>> GetVectorizationPipelineAsync(string name)

Parameters

name string

The name of the vectorization pipeline to retrieve.

Returns

Task<ResourceProviderGetResult<VectorizationPipeline>>

GetVectorizationPipelinesAsync()

Retrieves all vectorization pipelines.

Task<List<ResourceProviderGetResult<VectorizationPipeline>>> GetVectorizationPipelinesAsync()

Returns

Task<List<ResourceProviderGetResult<VectorizationPipeline>>>

All vectorization pipelines to which the caller has access and which have not been marked as deleted.

PurgeIndexingProfileAsync(string)

Purges a deleted indexing profile by its name. This action is irreversible.

Task<ResourceProviderActionResult> PurgeIndexingProfileAsync(string indexingProfileName)

Parameters

indexingProfileName string

The name of the indexing profile to purge.

Returns

Task<ResourceProviderActionResult>

PurgeTextEmbeddingProfileAsync(string)

Purges a deleted text embedding profile by its name. This action is irreversible.

Task<ResourceProviderActionResult> PurgeTextEmbeddingProfileAsync(string textEmbeddingProfileName)

Parameters

textEmbeddingProfileName string

The name of the text embedding profile to purge.

Returns

Task<ResourceProviderActionResult>

PurgeTextPartitioningProfileAsync(string)

Purges a deleted text partitioning profile by its name. This action is irreversible.

Task<ResourceProviderActionResult> PurgeTextPartitioningProfileAsync(string textPartitioningProfileName)

Parameters

textPartitioningProfileName string

The name of the text partitioning profile to purge.

Returns

Task<ResourceProviderActionResult>

PurgeVectorizationPipelineAsync(string)

Purges a deleted vectorization pipeline by its name. This action is irreversible.

Task<ResourceProviderActionResult> PurgeVectorizationPipelineAsync(string pipelineName)

Parameters

pipelineName string

The name of the vectorization pipeline to purge.

Returns

Task<ResourceProviderActionResult>

UpsertIndexingProfileAsync(IndexingProfile)

Upserts an indexing profile resource. If an indexing profile does not exist, it will be created. If an indexing profile does exist, it will be updated.

Task<ResourceProviderUpsertResult> UpsertIndexingProfileAsync(IndexingProfile resource)

Parameters

resource IndexingProfile

The resource to create or update.

Returns

Task<ResourceProviderUpsertResult>

Returns a ResourceProviderUpsertResult, which contains the Object ID of the resource.

UpsertTextEmbeddingProfileAsync(TextEmbeddingProfile)

Upserts a text embedding profile resource. If a text embedding profile does not exist, it will be created. If a text embedding profile does exist, it will be updated.

Task<ResourceProviderUpsertResult> UpsertTextEmbeddingProfileAsync(TextEmbeddingProfile resource)

Parameters

resource TextEmbeddingProfile

The resource to create or update.

Returns

Task<ResourceProviderUpsertResult>

Returns a ResourceProviderUpsertResult, which contains the Object ID of the resource.

UpsertTextPartitioningProfileAsync(TextPartitioningProfile)

Upserts a text partitioning profile resource. If a text partitioning profile does not exist, it will be created. If a text partitioning profile does exist, it will be updated.

Task<ResourceProviderUpsertResult> UpsertTextPartitioningProfileAsync(TextPartitioningProfile resource)

Parameters

resource TextPartitioningProfile

The resource to create or update.

Returns

Task<ResourceProviderUpsertResult>

Returns a ResourceProviderUpsertResult, which contains the Object ID of the resource.

UpsertVectorizationPipelineAsync(VectorizationPipeline)

Upserts a vectorization pipeline resource. If a vectorization pipeline does not exist, it will be created. If a vectorization pipeline does exist, it will be updated.

Task<ResourceProviderUpsertResult> UpsertVectorizationPipelineAsync(VectorizationPipeline resource)

Parameters

resource VectorizationPipeline

The resource to create or update.

Returns

Task<ResourceProviderUpsertResult>

Returns a ResourceProviderUpsertResult, which contains the Object ID of the resource.