Package com.azure.ai.openai.models

Class OnYourDataDeploymentNameVectorizationSource

java.lang.Object
com.azure.ai.openai.models.OnYourDataVectorizationSource
com.azure.ai.openai.models.OnYourDataDeploymentNameVectorizationSource
All Implemented Interfaces:
com.azure.json.JsonSerializable<OnYourDataVectorizationSource>
public final class OnYourDataDeploymentNameVectorizationSource extends OnYourDataVectorizationSource
The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on an internal embeddings model deployment name in the same Azure OpenAI resource.

  • Constructor Details

    • OnYourDataDeploymentNameVectorizationSource

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

  • Method Details

    • getDeploymentName

      public String getDeploymentName()
      Get the deploymentName property: The embedding model deployment name within the same Azure OpenAI resource. This enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
      Returns:
      the deploymentName value.

    • getType

      public OnYourDataVectorizationSourceType getType()
      Get the type property: The type of vectorization source to use.
      Overrides:
      getType in class OnYourDataVectorizationSource
      Returns:
      the type value.

    • toJson

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

    • fromJson

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

    • getDimensions

      public Integer getDimensions()
      Get the dimensions property: The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models.
      Returns:
      the dimensions value.

    • setDimensions

      public OnYourDataDeploymentNameVectorizationSource setDimensions(Integer dimensions)
      Set the dimensions property: The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models.
      Parameters:
      dimensions - the dimensions value to set.
      Returns:
      the OnYourDataDeploymentNameVectorizationSource object itself.