HuggingFaceKernelBuilderExtensions.AddHuggingFaceTextEmbeddingGeneration 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
| AddHuggingFaceTextEmbeddingGeneration(IKernelBuilder, Uri, String, String, HttpClient) |
Adds an Hugging Face text embedding generation service with the specified configuration. |
| AddHuggingFaceTextEmbeddingGeneration(IKernelBuilder, String, Uri, String, String, HttpClient) |
Adds an Hugging Face text embedding generation service with the specified configuration. |
AddHuggingFaceTextEmbeddingGeneration(IKernelBuilder, Uri, String, String, HttpClient)
Adds an Hugging Face text embedding generation service with the specified configuration.
public static Microsoft.SemanticKernel.IKernelBuilder AddHuggingFaceTextEmbeddingGeneration (this Microsoft.SemanticKernel.IKernelBuilder builder, Uri endpoint, string? apiKey = default, string? serviceId = default, System.Net.Http.HttpClient? httpClient = default);static member AddHuggingFaceTextEmbeddingGeneration : Microsoft.SemanticKernel.IKernelBuilder * Uri * string * string * System.Net.Http.HttpClient -> Microsoft.SemanticKernel.IKernelBuilder<Extension()>
Public Function AddHuggingFaceTextEmbeddingGeneration (builder As IKernelBuilder, endpoint As Uri, Optional apiKey As String = Nothing, Optional serviceId As String = Nothing, Optional httpClient As HttpClient = Nothing) As IKernelBuilderParameters
- builder
- IKernelBuilder
The IKernelBuilder instance to augment.
- endpoint
- Uri
The endpoint for the text embedding generation service.
- apiKey
- String
The API key required for accessing the Hugging Face service.
- serviceId
- String
A local identifier for the given AI service.
- httpClient
- HttpClient
The HttpClient to use with this service.
Returns
The same instance as builder.
Applies to
AddHuggingFaceTextEmbeddingGeneration(IKernelBuilder, String, Uri, String, String, HttpClient)
Adds an Hugging Face text embedding generation service with the specified configuration.
public static Microsoft.SemanticKernel.IKernelBuilder AddHuggingFaceTextEmbeddingGeneration (this Microsoft.SemanticKernel.IKernelBuilder builder, string model, Uri? endpoint = default, string? apiKey = default, string? serviceId = default, System.Net.Http.HttpClient? httpClient = default);static member AddHuggingFaceTextEmbeddingGeneration : Microsoft.SemanticKernel.IKernelBuilder * string * Uri * string * string * System.Net.Http.HttpClient -> Microsoft.SemanticKernel.IKernelBuilder<Extension()>
Public Function AddHuggingFaceTextEmbeddingGeneration (builder As IKernelBuilder, model As String, Optional endpoint As Uri = Nothing, Optional apiKey As String = Nothing, Optional serviceId As String = Nothing, Optional httpClient As HttpClient = Nothing) As IKernelBuilderParameters
- builder
- IKernelBuilder
The IKernelBuilder instance to augment.
- model
- String
The name of the Hugging Face model.
- endpoint
- Uri
The endpoint for the text embedding generation service.
- apiKey
- String
The API key required for accessing the Hugging Face service.
- serviceId
- String
A local identifier for the given AI service.
- httpClient
- HttpClient
The HttpClient to use with this service.
Returns
The same instance as builder.