SearchModelFactory.AzureMachineLearningParameters Method

Definition

Specifies the properties for connecting to an AML vectorizer.

public static Azure.Search.Documents.Indexes.Models.AzureMachineLearningParameters AzureMachineLearningParameters(Uri scoringUri = default, string authenticationKey = default, string resourceId = default, TimeSpan? timeout = default, string region = default, Azure.Search.Documents.Indexes.Models.AIFoundryModelCatalogName? modelName = default);
static member AzureMachineLearningParameters : Uri * string * string * Nullable<TimeSpan> * string * Nullable<Azure.Search.Documents.Indexes.Models.AIFoundryModelCatalogName> -> Azure.Search.Documents.Indexes.Models.AzureMachineLearningParameters
Public Shared Function AzureMachineLearningParameters (Optional scoringUri As Uri = Nothing, Optional authenticationKey As String = Nothing, Optional resourceId As String = Nothing, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional region As String = Nothing, Optional modelName As Nullable(Of AIFoundryModelCatalogName) = Nothing) As AzureMachineLearningParameters

Parameters

scoringUri
Uri

(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed.

authenticationKey
String

(Required for key authentication) The key for the AML service.

resourceId
String

(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.

timeout
Nullable<TimeSpan>

(Optional) When specified, indicates the timeout for the http client making the API call.

region
String

(Optional for token authentication). The region the AML service is deployed in.

modelName
Nullable<AIFoundryModelCatalogName>

The name of the embedding model from the Azure AI Foundry Catalog that is deployed at the provided endpoint.

Returns

A new AzureMachineLearningParameters instance for mocking.

Applies to