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

Class AIServicesVisionParameters

java.lang.Object
com.azure.search.documents.indexes.models.AIServicesVisionParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<AIServicesVisionParameters>
public final class AIServicesVisionParameters extends Object implements com.azure.json.JsonSerializable<AIServicesVisionParameters>
Specifies the AI Services Vision parameters for vectorizing a query image or text.

  • Constructor Details

    • AIServicesVisionParameters

      public AIServicesVisionParameters(String modelVersion, String resourceUri)
      Creates an instance of AIServicesVisionParameters class.
      Parameters:
      modelVersion - the modelVersion value to set.
      resourceUri - the resourceUri value to set.

  • Method Details

    • getModelVersion

      public String getModelVersion()
      Get the modelVersion property: The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified.
      Returns:
      the modelVersion value.

    • getResourceUri

      public String getResourceUri()
      Get the resourceUri property: The resource URI of the AI Services resource.
      Returns:
      the resourceUri value.

    • getApiKey

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

    • setApiKey

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

    • getAuthIdentity

      public SearchIndexerDataIdentity getAuthIdentity()
      Get the authIdentity property: The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the index, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.
      Returns:
      the authIdentity value.

    • setAuthIdentity

      public AIServicesVisionParameters setAuthIdentity(SearchIndexerDataIdentity authIdentity)
      Set the authIdentity property: The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the index, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.
      Parameters:
      authIdentity - the authIdentity value to set.
      Returns:
      the AIServicesVisionParameters 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<AIServicesVisionParameters>
      Throws:
      IOException

    • fromJson

      public static AIServicesVisionParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AIServicesVisionParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AIServicesVisionParameters 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 AIServicesVisionParameters.