Package com.azure.ai.openai.models

Class AzureCognitiveSearchChatExtensionConfiguration

java.lang.Object
com.azure.ai.openai.models.AzureCognitiveSearchChatExtensionConfiguration
public class AzureCognitiveSearchChatExtensionConfiguration extends Object
A specific representation of configurable options for Azure Cognitive Search when using it as an Azure OpenAI chat extension.

  • Constructor Details

    • AzureCognitiveSearchChatExtensionConfiguration

      public AzureCognitiveSearchChatExtensionConfiguration(String endpoint, String key, String indexName)
      Creates an instance of AzureCognitiveSearchChatExtensionConfiguration
      Parameters:
      endpoint - absolute path for the Azure Cognitive Search resource
      key - the API key for the Azure Cognitive search endpoint
      indexName - the name of the index to use in the referenced Azure Cognitive Search resource

  • Method Details

    • getEndpoint

      public String getEndpoint()
      Gets the endpoint of this Azure Cognitive Search resource configuration
      Returns:
      The endpoint value as a String

    • setEndpoint

      public AzureCognitiveSearchChatExtensionConfiguration setEndpoint(String endpoint)
      Sets the endpoint of this Azure Cognitive Search resource configuration
      Parameters:
      endpoint - String URL representing the endpoint
      Returns:
      the AzureCognitiveSearchChatExtensionConfiguration object itself

    • getKey

      public String getKey()
      Gets the Azure Cognitive Search API key value as a String
      Returns:
      the value of the API key as a String

    • setKey

      public AzureCognitiveSearchChatExtensionConfiguration setKey(String key)
      Sets the Azure Cognitive Search API key value as a String
      Parameters:
      key - the value of the key for the resource
      Returns:
      the AzureCognitiveSearchChatExtensionConfiguration object itself

    • getIndexName

      public String getIndexName()
      Gets the Index Name of the document of the Azure Cognitive Search resource
      Returns:
      the Index Name of the document as a String

    • setIndexName

      public AzureCognitiveSearchChatExtensionConfiguration setIndexName(String indexName)
      Sets the Index Name of the document of the Azure Cognitive Search resource
      Parameters:
      indexName - the Index Name of the document as a String
      Returns:
      the AzureCognitiveSearchChatExtensionConfiguration object itself