SearchModelFactory.WebApiVectorizerParameters Method

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Source:
SearchModelFactory.cs

Specifies the properties for connecting to a user-defined vectorizer.

public static Azure.Search.Documents.Indexes.Models.WebApiVectorizerParameters WebApiVectorizerParameters(Uri uri = default, System.Collections.Generic.IDictionary<string,string> httpHeaders = default, string httpMethod = default, TimeSpan? timeout = default, Azure.Core.ResourceIdentifier authResourceId = default, Azure.Search.Documents.Indexes.Models.SearchIndexerDataIdentity authIdentity = default);
static member WebApiVectorizerParameters : Uri * System.Collections.Generic.IDictionary<string, string> * string * Nullable<TimeSpan> * Azure.Core.ResourceIdentifier * Azure.Search.Documents.Indexes.Models.SearchIndexerDataIdentity -> Azure.Search.Documents.Indexes.Models.WebApiVectorizerParameters
Public Shared Function WebApiVectorizerParameters (Optional uri As Uri = Nothing, Optional httpHeaders As IDictionary(Of String, String) = Nothing, Optional httpMethod As String = Nothing, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional authResourceId As ResourceIdentifier = Nothing, Optional authIdentity As SearchIndexerDataIdentity = Nothing) As WebApiVectorizerParameters

Parameters

uri
Uri

The URI of the Web API providing the vectorizer.

httpHeaders
IDictionary<String,String>

The headers required to make the HTTP request.

httpMethod
String

The method for the HTTP request.

timeout
Nullable<TimeSpan>

The desired timeout for the request. Default is 30 seconds.

authResourceId
ResourceIdentifier

Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.

authIdentity
SearchIndexerDataIdentity

The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.

Returns

WebApiVectorizerParameters

A new WebApiVectorizerParameters instance for mocking.

Applies to