AzureAISearchKernelBuilderExtensions.AddAzureAISearchVectorStore Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
AddAzureAISearchVectorStore(IKernelBuilder, AzureAISearchVectorStoreOptions, String) |
Register an Azure AI Search IVectorStore with the specified service ID and where SearchIndexClient is retrieved from the dependency injection container. |
AddAzureAISearchVectorStore(IKernelBuilder, Uri, AzureKeyCredential, AzureAISearchVectorStoreOptions, String) |
Register an Azure AI Search IVectorStore with the provided Uri and AzureKeyCredential and the specified service ID. |
AddAzureAISearchVectorStore(IKernelBuilder, Uri, TokenCredential, AzureAISearchVectorStoreOptions, String) |
Register an Azure AI Search IVectorStore with the provided Uri and TokenCredential and the specified service ID. |
AddAzureAISearchVectorStore(IKernelBuilder, AzureAISearchVectorStoreOptions, String)
Register an Azure AI Search IVectorStore with the specified service ID and where SearchIndexClient is retrieved from the dependency injection container.
public static Microsoft.SemanticKernel.IKernelBuilder AddAzureAISearchVectorStore (this Microsoft.SemanticKernel.IKernelBuilder builder, Microsoft.SemanticKernel.Connectors.AzureAISearch.AzureAISearchVectorStoreOptions? options = default, string? serviceId = default);
static member AddAzureAISearchVectorStore : Microsoft.SemanticKernel.IKernelBuilder * Microsoft.SemanticKernel.Connectors.AzureAISearch.AzureAISearchVectorStoreOptions * string -> Microsoft.SemanticKernel.IKernelBuilder
<Extension()>
Public Function AddAzureAISearchVectorStore (builder As IKernelBuilder, Optional options As AzureAISearchVectorStoreOptions = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder
Parameters
- builder
- IKernelBuilder
The builder to register the IVectorStore on.
- options
- AzureAISearchVectorStoreOptions
Optional options to further configure the IVectorStore.
- serviceId
- String
An optional service id to use as the service key.
Returns
The kernel builder.
Applies to
AddAzureAISearchVectorStore(IKernelBuilder, Uri, AzureKeyCredential, AzureAISearchVectorStoreOptions, String)
Register an Azure AI Search IVectorStore with the provided Uri and AzureKeyCredential and the specified service ID.
public static Microsoft.SemanticKernel.IKernelBuilder AddAzureAISearchVectorStore (this Microsoft.SemanticKernel.IKernelBuilder builder, Uri endpoint, Azure.AzureKeyCredential credential, Microsoft.SemanticKernel.Connectors.AzureAISearch.AzureAISearchVectorStoreOptions? options = default, string? serviceId = default);
static member AddAzureAISearchVectorStore : Microsoft.SemanticKernel.IKernelBuilder * Uri * Azure.AzureKeyCredential * Microsoft.SemanticKernel.Connectors.AzureAISearch.AzureAISearchVectorStoreOptions * string -> Microsoft.SemanticKernel.IKernelBuilder
<Extension()>
Public Function AddAzureAISearchVectorStore (builder As IKernelBuilder, endpoint As Uri, credential As AzureKeyCredential, Optional options As AzureAISearchVectorStoreOptions = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder
Parameters
- builder
- IKernelBuilder
The builder to register the IVectorStore on.
- endpoint
- Uri
The service endpoint for Azure AI Search.
- credential
- AzureKeyCredential
The credential to authenticate to Azure AI Search with.
- options
- AzureAISearchVectorStoreOptions
Optional options to further configure the IVectorStore.
- serviceId
- String
An optional service id to use as the service key.
Returns
The kernel builder.
Applies to
AddAzureAISearchVectorStore(IKernelBuilder, Uri, TokenCredential, AzureAISearchVectorStoreOptions, String)
Register an Azure AI Search IVectorStore with the provided Uri and TokenCredential and the specified service ID.
public static Microsoft.SemanticKernel.IKernelBuilder AddAzureAISearchVectorStore (this Microsoft.SemanticKernel.IKernelBuilder builder, Uri endpoint, Azure.Core.TokenCredential tokenCredential, Microsoft.SemanticKernel.Connectors.AzureAISearch.AzureAISearchVectorStoreOptions? options = default, string? serviceId = default);
static member AddAzureAISearchVectorStore : Microsoft.SemanticKernel.IKernelBuilder * Uri * Azure.Core.TokenCredential * Microsoft.SemanticKernel.Connectors.AzureAISearch.AzureAISearchVectorStoreOptions * string -> Microsoft.SemanticKernel.IKernelBuilder
<Extension()>
Public Function AddAzureAISearchVectorStore (builder As IKernelBuilder, endpoint As Uri, tokenCredential As TokenCredential, Optional options As AzureAISearchVectorStoreOptions = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder
Parameters
- builder
- IKernelBuilder
The builder to register the IVectorStore on.
- endpoint
- Uri
The service endpoint for Azure AI Search.
- tokenCredential
- TokenCredential
The credential to authenticate to Azure AI Search with.
- options
- AzureAISearchVectorStoreOptions
Optional options to further configure the IVectorStore.
- serviceId
- String
An optional service id to use as the service key.
Returns
The kernel builder.