Package com.azure.ai.openai.models

Class AzureCosmosDBChatExtensionParameters

java.lang.Object
com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureCosmosDBChatExtensionParameters>
public final class AzureCosmosDBChatExtensionParameters extends Object implements com.azure.json.JsonSerializable<AzureCosmosDBChatExtensionParameters>
Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for MongoDB vCore. The supported authentication type is ConnectionString.

  • Constructor Details

    • AzureCosmosDBChatExtensionParameters

      public AzureCosmosDBChatExtensionParameters(String databaseName, String containerName, String indexName, AzureCosmosDBFieldMappingOptions fieldsMapping, OnYourDataVectorizationSource embeddingDependency)
      Creates an instance of AzureCosmosDBChatExtensionParameters class.
      Parameters:
      databaseName - the databaseName value to set.
      containerName - the containerName value to set.
      indexName - the indexName value to set.
      fieldsMapping - the fieldsMapping value to set.
      embeddingDependency - the embeddingDependency 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters object itself.

    • getDatabaseName

      public String getDatabaseName()
      Get the databaseName property: The MongoDB vCore database name to use with Azure Cosmos DB.
      Returns:
      the databaseName value.

    • getContainerName

      public String getContainerName()
      Get the containerName property: The name of the Azure Cosmos DB resource container.
      Returns:
      the containerName value.

    • getIndexName

      public String getIndexName()
      Get the indexName property: The MongoDB vCore index name to use with Azure Cosmos DB.
      Returns:
      the indexName value.

    • getFieldsMapping

      public AzureCosmosDBFieldMappingOptions getFieldsMapping()
      Get the fieldsMapping property: Customized field mapping behavior to use when interacting with the search index.
      Returns:
      the fieldsMapping value.

    • getEmbeddingDependency

      public OnYourDataVectorizationSource getEmbeddingDependency()
      Get the embeddingDependency property: The embedding dependency for vector search.
      Returns:
      the embeddingDependency value.

    • toJson

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

    • fromJson

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

    • 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters 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 AzureCosmosDBChatExtensionParameters object itself.