Package com.azure.ai.openai.models

Class AzureMachineLearningIndexChatExtensionParameters

java.lang.Object
com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureMachineLearningIndexChatExtensionParameters>
public final class AzureMachineLearningIndexChatExtensionParameters extends Object implements com.azure.json.JsonSerializable<AzureMachineLearningIndexChatExtensionParameters>
Parameters for the Azure Machine Learning vector index chat extension. The supported authentication types are AccessToken, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.

  • Constructor Details

    • AzureMachineLearningIndexChatExtensionParameters

      public AzureMachineLearningIndexChatExtensionParameters(String projectResourceId, String name, String version)
      Creates an instance of AzureMachineLearningIndexChatExtensionParameters class.
      Parameters:
      projectResourceId - the projectResourceId value to set.
      name - the name value to set.
      version - the version value to set.

  • Method Details

    • getAuthentication

      public OnYourDataAuthenticationOptions getAuthentication()
      Get the authentication property: The authentication method to use when accessing the defined data source. Each data source type supports a specific set of available authentication methods; please see the documentation of the data source for supported mechanisms. If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) authentication.
      Returns:
      the authentication value.

    • setAuthentication

      public AzureMachineLearningIndexChatExtensionParameters setAuthentication(OnYourDataAuthenticationOptions authentication)
      Set the authentication property: The authentication method to use when accessing the defined data source. Each data source type supports a specific set of available authentication methods; please see the documentation of the data source for supported mechanisms. If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) authentication.
      Parameters:
      authentication - the authentication value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters object itself.

    • getTopNDocuments

      public Integer getTopNDocuments()
      Get the topNDocuments property: The configured top number of documents to feature for the configured query.
      Returns:
      the topNDocuments value.

    • setTopNDocuments

      public AzureMachineLearningIndexChatExtensionParameters setTopNDocuments(Integer topNDocuments)
      Set the topNDocuments property: The configured top number of documents to feature for the configured query.
      Parameters:
      topNDocuments - the topNDocuments value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters object itself.

    • isInScope

      public Boolean isInScope()
      Get the inScope property: Whether queries should be restricted to use of indexed data.
      Returns:
      the inScope value.

    • setInScope

      public AzureMachineLearningIndexChatExtensionParameters setInScope(Boolean inScope)
      Set the inScope property: Whether queries should be restricted to use of indexed data.
      Parameters:
      inScope - the inScope value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters object itself.

    • getStrictness

      public Integer getStrictness()
      Get the strictness property: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.
      Returns:
      the strictness value.

    • setStrictness

      public AzureMachineLearningIndexChatExtensionParameters setStrictness(Integer strictness)
      Set the strictness property: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.
      Parameters:
      strictness - the strictness value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters object itself.

    • getRoleInformation

      public String getRoleInformation()
      Get the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.
      Returns:
      the roleInformation value.

    • setRoleInformation

      public AzureMachineLearningIndexChatExtensionParameters setRoleInformation(String roleInformation)
      Set the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.
      Parameters:
      roleInformation - the roleInformation value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters object itself.

    • getProjectResourceId

      public String getProjectResourceId()
      Get the projectResourceId property: The resource ID of the Azure Machine Learning project.
      Returns:
      the projectResourceId value.

    • getName

      public String getName()
      Get the name property: The Azure Machine Learning vector index name.
      Returns:
      the name value.

    • getVersion

      public String getVersion()
      Get the version property: The version of the Azure Machine Learning vector index.
      Returns:
      the version value.

    • getFilter

      public String getFilter()
      Get the filter property: Search filter. Only supported if the Azure Machine Learning vector index is of type AzureSearch.
      Returns:
      the filter value.

    • setFilter

      public AzureMachineLearningIndexChatExtensionParameters setFilter(String filter)
      Set the filter property: Search filter. Only supported if the Azure Machine Learning vector index is of type AzureSearch.
      Parameters:
      filter - the filter value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters 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<AzureMachineLearningIndexChatExtensionParameters>
      Throws:
      IOException

    • fromJson

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

    • getMaxSearchQueries

      public Integer getMaxSearchQueries()
      Get the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.
      Returns:
      the maxSearchQueries value.

    • setMaxSearchQueries

      public AzureMachineLearningIndexChatExtensionParameters setMaxSearchQueries(Integer maxSearchQueries)
      Set the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.
      Parameters:
      maxSearchQueries - the maxSearchQueries value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters object itself.

    • isAllowPartialResult

      public Boolean isAllowPartialResult()
      Get the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails.
      Returns:
      the allowPartialResult value.

    • setAllowPartialResult

      public AzureMachineLearningIndexChatExtensionParameters setAllowPartialResult(Boolean allowPartialResult)
      Set the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails.
      Parameters:
      allowPartialResult - the allowPartialResult value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters object itself.

    • getIncludeContexts

      public List<OnYourDataContextProperty> getIncludeContexts()
      Get the includeContexts property: The included properties of the output context. If not specified, the default value is `citations` and `intent`.
      Returns:
      the includeContexts value.

    • setIncludeContexts

      public AzureMachineLearningIndexChatExtensionParameters setIncludeContexts(List<OnYourDataContextProperty> includeContexts)
      Set the includeContexts property: The included properties of the output context. If not specified, the default value is `citations` and `intent`.
      Parameters:
      includeContexts - the includeContexts value to set.
      Returns:
      the AzureMachineLearningIndexChatExtensionParameters object itself.