Package com.azure.ai.openai.models

Class AzureSearchChatExtensionParameters

java.lang.Object
com.azure.ai.openai.models.AzureSearchChatExtensionParameters
public final class AzureSearchChatExtensionParameters extends Object
Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.

  • Constructor Details

    • AzureSearchChatExtensionParameters

      public AzureSearchChatExtensionParameters(String endpoint, String indexName)
      Creates an instance of AzureSearchChatExtensionParameters class.
      Parameters:
      endpoint - the endpoint value to set.
      indexName - the indexName 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters 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 AzureSearchChatExtensionParameters object itself.

    • getEndpoint

      public String getEndpoint()
      Get the endpoint property: The absolute endpoint path for the Azure Cognitive Search resource to use.
      Returns:
      the endpoint value.

    • getIndexName

      public String getIndexName()
      Get the indexName property: The name of the index to use as available in the referenced Azure Cognitive Search resource.
      Returns:
      the indexName value.

    • getFieldsMapping

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

    • setFieldsMapping

      public AzureSearchChatExtensionParameters setFieldsMapping(AzureSearchIndexFieldMappingOptions fieldsMapping)
      Set the fieldsMapping property: Customized field mapping behavior to use when interacting with the search index.
      Parameters:
      fieldsMapping - the fieldsMapping value to set.
      Returns:
      the AzureSearchChatExtensionParameters object itself.

    • getQueryType

      public AzureSearchQueryType getQueryType()
      Get the queryType property: The query type to use with Azure Cognitive Search.
      Returns:
      the queryType value.

    • setQueryType

      public AzureSearchChatExtensionParameters setQueryType(AzureSearchQueryType queryType)
      Set the queryType property: The query type to use with Azure Cognitive Search.
      Parameters:
      queryType - the queryType value to set.
      Returns:
      the AzureSearchChatExtensionParameters object itself.

    • getSemanticConfiguration

      public String getSemanticConfiguration()
      Get the semanticConfiguration property: The additional semantic configuration for the query.
      Returns:
      the semanticConfiguration value.

    • setSemanticConfiguration

      public AzureSearchChatExtensionParameters setSemanticConfiguration(String semanticConfiguration)
      Set the semanticConfiguration property: The additional semantic configuration for the query.
      Parameters:
      semanticConfiguration - the semanticConfiguration value to set.
      Returns:
      the AzureSearchChatExtensionParameters object itself.

    • getFilter

      public String getFilter()
      Get the filter property: Search filter.
      Returns:
      the filter value.

    • setFilter

      public AzureSearchChatExtensionParameters setFilter(String filter)
      Set the filter property: Search filter.
      Parameters:
      filter - the filter value to set.
      Returns:
      the AzureSearchChatExtensionParameters object itself.

    • getEmbeddingDependency

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

    • setEmbeddingDependency

      public AzureSearchChatExtensionParameters setEmbeddingDependency(OnYourDataVectorizationSource embeddingDependency)
      Set the embeddingDependency property: The embedding dependency for vector search.
      Parameters:
      embeddingDependency - the embeddingDependency value to set.
      Returns:
      the AzureSearchChatExtensionParameters object itself.