AzureOpenAI

Azure OpenAI Model Provider

yaml
type: "io.kestra.plugin.ai.provider.AzureOpenAI"

Examples

Chat completion with Azure OpenAI

yaml
id: chat_completion
namespace: company.ai

inputs:
  - id: prompt
    type: STRING

tasks:
  - id: chat_completion
    type: io.kestra.plugin.ai.completion.ChatCompletion
    provider:
      type: io.kestra.plugin.ai.provider.AzureOpenAI
      apiKey: "{{ kv('AZURE_API_KEY') }}"
      endpoint: https://your-resource.openai.azure.com/
      modelName: anthropic.claude-3-sonnet-20240229-v1:0
    messages:
      - type: SYSTEM
        content: You are a helpful assistant, answer concisely, avoid overly casual language or unnecessary verbosity.
      - type: USER
        content: "{{inputs.prompt}}"

Properties

endpoint*string

API endpoint

The Azure OpenAI endpoint in the format: https://{resource}.openai.azure.com/

modelName*string

Model name

apiKeystring

API Key

baseUrlstring

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPemstring

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientIdstring

Client ID

clientPemstring

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

clientSecretstring

Client secret

serviceVersionstring

API version

tenantIdstring

Tenant ID

Opensearch (EE)

This sub-group of plugins contains tasks for using Opensearch EE. Opensearch is a distributed, RESTful search and analytics engine capable of addressing a growing number of use cases.

Database

OpenSearch

This sub-group of plugins contains tasks for using Opensearch. Opensearch is a distributed, RESTful search and analytics engine capable of addressing a growing number of use cases.

Database