Package com.azure.ai.openai.models

Class OnYourDataEndpointVectorizationSource

java.lang.Object
com.azure.ai.openai.models.OnYourDataVectorizationSource
com.azure.ai.openai.models.OnYourDataEndpointVectorizationSource
All Implemented Interfaces:
com.azure.json.JsonSerializable<OnYourDataVectorizationSource>
public final class OnYourDataEndpointVectorizationSource extends OnYourDataVectorizationSource
The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on a public Azure OpenAI endpoint call for embeddings.

  • Constructor Details

    • OnYourDataEndpointVectorizationSource

      public OnYourDataEndpointVectorizationSource(String endpoint, OnYourDataVectorSearchAuthenticationOptions authentication)
      Creates an instance of OnYourDataEndpointVectorizationSource class.
      Parameters:
      endpoint - the endpoint value to set.
      authentication - the authentication value to set.

  • Method Details

    • getEndpoint

      public String getEndpoint()
      Get the endpoint property: Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed.
      Returns:
      the endpoint value.

    • getAuthentication

      public OnYourDataVectorSearchAuthenticationOptions getAuthentication()
      Get the authentication property: Specifies the authentication options to use when retrieving embeddings from the specified endpoint.
      Returns:
      the authentication 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 OnYourDataEndpointVectorizationSource fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of OnYourDataEndpointVectorizationSource from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of OnYourDataEndpointVectorizationSource 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 OnYourDataEndpointVectorizationSource.