Package com.github.copilot.sdk.json

Class AzureOptions

java.lang.Object
com.github.copilot.sdk.json.AzureOptions
public class AzureOptions extends Object
Azure OpenAI-specific configuration options.

When using a BYOK (Bring Your Own Key) setup with Azure OpenAI, this class allows you to specify Azure-specific settings such as the API version to use.

Example Usage


 var provider = new ProviderConfig().setType("azure-openai").setHost("your-resource.openai.azure.com")
 		.setApiKey("your-api-key").setAzure(new AzureOptions().setApiVersion("2024-02-01"));
Since:
1.0.0
See Also:

  • Constructor Details

    • AzureOptions

      public AzureOptions()

  • Method Details

    • getApiVersion

      public String getApiVersion()
      Gets the Azure OpenAI API version.
      Returns:
      the API version string

    • setApiVersion

      public AzureOptions setApiVersion(String apiVersion)
      Sets the Azure OpenAI API version to use.

      Examples: "2024-02-01", "2023-12-01-preview"

      Parameters:
      apiVersion - the API version string
      Returns:
      this options object for method chaining