KeyAuthAzureMachineLearningVectorizerParameters interface

Package:

@azure/search-documents

Specifies the properties for connecting to an AML vectorizer with an authentication key.

Extends

BaseAzureMachineLearningVectorizerParameters

Properties

authenticationKey	The key for the AML service.
authKind	Indicates how the service should attempt to identify itself to the AML instance
scoringUri	The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed.

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

authenticationKey

The key for the AML service.

authenticationKey: string

Property Value

string

authKind

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

authKind: "key"

Property Value

"key"

scoringUri

The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed.

scoringUri: 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