Package com.azure.search.documents.indexes.models

Class AzureMachineLearningParameters

java.lang.Object
com.azure.search.documents.indexes.models.AzureMachineLearningParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureMachineLearningParameters>
public final class AzureMachineLearningParameters extends Object implements com.azure.json.JsonSerializable<AzureMachineLearningParameters>
Specifies the properties for connecting to an AML vectorizer.

  • Constructor Details

    • AzureMachineLearningParameters

      public AzureMachineLearningParameters(String scoringUri)
      Creates an instance of AzureMachineLearningParameters class.
      Parameters:
      scoringUri - the scoringUri value to set.

  • Method Details

    • getScoringUri

      public String getScoringUri()
      Get the scoringUri 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 scoringUri value.

    • getAuthenticationKey

      public String getAuthenticationKey()
      Get the authenticationKey property: (Required for key authentication) The key for the AML service.
      Returns:
      the authenticationKey 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.

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

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

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

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

    • getRegion

      public String getRegion()
      Get the region property: (Optional for token authentication). The region the AML service is deployed in.
      Returns:
      the region value.

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

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

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AzureMachineLearningParameters>
      Throws:
      IOException

    • fromJson

      public static AzureMachineLearningParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AzureMachineLearningParameters.