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

Class AzureOpenAIVectorizerParameters

java.lang.Object
com.azure.search.documents.indexes.models.AzureOpenAIVectorizerParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureOpenAIVectorizerParameters>
public class AzureOpenAIVectorizerParameters extends Object implements com.azure.json.JsonSerializable<AzureOpenAIVectorizerParameters>
Specifies the parameters for connecting to the Azure OpenAI resource.

  • Constructor Details

    • AzureOpenAIVectorizerParameters

      public AzureOpenAIVectorizerParameters()
      Creates an instance of AzureOpenAIVectorizerParameters class.

  • Method Details

    • getResourceUrl

      public String getResourceUrl()
      Get the resourceUrl property: The resource URI of the Azure OpenAI resource.
      Returns:
      the resourceUrl value.

    • setResourceUrl

      public AzureOpenAIVectorizerParameters setResourceUrl(String resourceUrl)
      Set the resourceUrl property: The resource URI of the Azure OpenAI resource.
      Parameters:
      resourceUrl - the resourceUrl value to set.
      Returns:
      the AzureOpenAIVectorizerParameters object itself.

    • getDeploymentName

      public String getDeploymentName()
      Get the deploymentName property: ID of the Azure OpenAI model deployment on the designated resource.
      Returns:
      the deploymentName value.

    • setDeploymentName

      public AzureOpenAIVectorizerParameters setDeploymentName(String deploymentName)
      Set the deploymentName property: ID of the Azure OpenAI model deployment on the designated resource.
      Parameters:
      deploymentName - the deploymentName value to set.
      Returns:
      the AzureOpenAIVectorizerParameters object itself.

    • getApiKey

      public String getApiKey()
      Get the apiKey property: API key of the designated Azure OpenAI resource.
      Returns:
      the apiKey value.

    • setApiKey

      public AzureOpenAIVectorizerParameters setApiKey(String apiKey)
      Set the apiKey property: API key of the designated Azure OpenAI resource.
      Parameters:
      apiKey - the apiKey value to set.
      Returns:
      the AzureOpenAIVectorizerParameters object itself.

    • getAuthIdentity

      public SearchIndexerDataIdentity getAuthIdentity()
      Get the authIdentity property: The user-assigned managed identity used for outbound connections.
      Returns:
      the authIdentity value.

    • setAuthIdentity

      public AzureOpenAIVectorizerParameters setAuthIdentity(SearchIndexerDataIdentity authIdentity)
      Set the authIdentity property: The user-assigned managed identity used for outbound connections.
      Parameters:
      authIdentity - the authIdentity value to set.
      Returns:
      the AzureOpenAIVectorizerParameters object itself.

    • getModelName

      public AzureOpenAIModelName getModelName()
      Get the modelName property: The name of the embedding model that is deployed at the provided deploymentId path.
      Returns:
      the modelName value.

    • setModelName

      public AzureOpenAIVectorizerParameters setModelName(AzureOpenAIModelName modelName)
      Set the modelName property: The name of the embedding model that is deployed at the provided deploymentId path.
      Parameters:
      modelName - the modelName value to set.
      Returns:
      the AzureOpenAIVectorizerParameters 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<AzureOpenAIVectorizerParameters>
      Throws:
      IOException

    • fromJson

      public static AzureOpenAIVectorizerParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AzureOpenAIVectorizerParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AzureOpenAIVectorizerParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the AzureOpenAIVectorizerParameters.