AzureMachineLearningParameters Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.indexes.models.AzureMachineLearningParameters

Implements

JsonSerializable<AzureMachineLearningParameters>

public final class AzureMachineLearningParameters
implements JsonSerializable<AzureMachineLearningParameters>

Specifies the properties for connecting to an AML vectorizer.

Constructor Summary

Constructor Description
AzureMachineLearningParameters(String scoringUrl)

Creates an instance of AzureMachineLearningParameters class.

Method Summary

Modifier and Type Method and Description
static AzureMachineLearningParameters fromJson(JsonReader jsonReader)

Reads an instance of AzureMachineLearningParameters from the JsonReader.
String getAuthenticationKey()

Get the authenticationKey property: (Required for key authentication) The key for the AML service.
AIFoundryModelCatalogName getModelName()

Get the modelName property: The name of the embedding model from the Azure AI Foundry Catalog that is deployed at the provided endpoint.
String getRegion()

Get the region property: (Optional for token authentication).
String getResourceId()

Get the resourceId property: (Required for token authentication).
String getScoringUrl()

Get the scoringUrl property: (Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent.
Duration getTimeout()

Get the timeout property: (Optional) When specified, indicates the timeout for the http client making the API call.
AzureMachineLearningParameters setAuthenticationKey(String authenticationKey)

Set the authenticationKey property: (Required for key authentication) The key for the AML service.
AzureMachineLearningParameters setModelName(AIFoundryModelCatalogName modelName)

Set the modelName property: The name of the embedding model from the Azure AI Foundry Catalog that is deployed at the provided endpoint.
AzureMachineLearningParameters setRegion(String region)

Set the region property: (Optional for token authentication).
AzureMachineLearningParameters setResourceId(String resourceId)

Set the resourceId property: (Required for token authentication).
AzureMachineLearningParameters setTimeout(Duration timeout)

Set the timeout property: (Optional) When specified, indicates the timeout for the http client making the API call.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureMachineLearningParameters

public AzureMachineLearningParameters(String scoringUrl)

Creates an instance of AzureMachineLearningParameters class.

Parameters:

scoringUrl - the scoringUrl value to set.

Method Details

fromJson

public static AzureMachineLearningParameters fromJson(JsonReader jsonReader)

Reads an instance of AzureMachineLearningParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureMachineLearningParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getAuthenticationKey

public String getAuthenticationKey()

Get the authenticationKey property: (Required for key authentication) The key for the AML service.

Returns:

the authenticationKey value.

getModelName

public AIFoundryModelCatalogName getModelName()

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

Returns:

the modelName value.

getRegion

public String getRegion()

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

Returns:

the region value.

getResourceId

public String getResourceId()

Get the resourceId property: (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}.

Returns:

the resourceId value.

getScoringUrl

public String getScoringUrl()

Get the scoringUrl property: (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.

Returns:

the scoringUrl value.

getTimeout

public Duration getTimeout()

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

Returns:

the timeout value.

setAuthenticationKey

public AzureMachineLearningParameters setAuthenticationKey(String authenticationKey)

Set the authenticationKey property: (Required for key authentication) The key for the AML service.

Parameters:

authenticationKey - the authenticationKey value to set.

Returns:

the AzureMachineLearningParameters object itself.

setModelName

public AzureMachineLearningParameters setModelName(AIFoundryModelCatalogName modelName)

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

Parameters:

modelName - the modelName value to set.

Returns:

the AzureMachineLearningParameters object itself.

setRegion

public AzureMachineLearningParameters setRegion(String region)

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

Parameters:

region - the region value to set.

Returns:

the AzureMachineLearningParameters object itself.

setResourceId

public AzureMachineLearningParameters setResourceId(String resourceId)

Set the resourceId property: (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}.

Parameters:

resourceId - the resourceId value to set.

Returns:

the AzureMachineLearningParameters object itself.

setTimeout

public AzureMachineLearningParameters setTimeout(Duration timeout)

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

Parameters:

timeout - the timeout value to set.

Returns:

the AzureMachineLearningParameters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to