TokenAuthAzureMachineLearningVectorizerParameters interface

Package:

@azure/search-documents

Specifies the properties for connecting to an AML vectorizer with a managed identity.

Extends

BaseAzureMachineLearningVectorizerParameters

Properties

authKind	Indicates how the service should attempt to identify itself to the AML instance
region	The region the AML service is deployed in.
resourceId	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}.

Inherited Properties

modelName	The name of the embedding model from the Azure AI Foundry Catalog that is deployed at the provided endpoint.
timeout	When specified, indicates the timeout for the http client making the API call.

Property Details

authKind

Indicates how the service should attempt to identify itself to the AML instance

authKind: "token"

Property Value

"token"

region

The region the AML service is deployed in.

region?: string

Property Value

string

resourceId

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}.

resourceId: string

Property Value

string

Inherited Property Details

modelName

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

modelName?: string

Property Value

string

Inherited From BaseAzureMachineLearningVectorizerParameters.modelName

timeout

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

timeout?: string

Property Value

string

Inherited From BaseAzureMachineLearningVectorizerParameters.timeout