ExBifrost.Api.AzureIntegration (ex_bifrost v0.1.0)

Copy Markdown View Source

API calls for all endpoints tagged AzureIntegration.

Summary

Functions

azure_create_chat_completion(connection, deployment_id, open_ai_chat_request, opts \\ [])

Create chat completion (Azure OpenAI) Creates a chat completion using Azure OpenAI deployment.

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • deployment_id (String.t): Azure deployment ID
  • open_ai_chat_request (OpenAiChatRequest):
  • opts (keyword): Optional parameters
    • :"api-version" (String.t): Azure API version

Returns

  • {:ok, ExBifrost.Model.ChatCompletionResponse.t} on success
  • {:error, Tesla.Env.t} on failure

azure_create_embedding(connection, deployment_id, open_ai_embedding_request, opts \\ [])

Create embeddings (Azure OpenAI)

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • deployment_id (String.t): Azure deployment ID
  • open_ai_embedding_request (OpenAiEmbeddingRequest):
  • opts (keyword): Optional parameters
    • :"api-version" (String.t):

Returns

  • {:ok, ExBifrost.Model.EmbeddingResponse.t} on success
  • {:error, Tesla.Env.t} on failure

azure_create_image(connection, deployment_id, openai_create_image_request, opts \\ [])

Create image (Azure OpenAI) Generates images from text prompts using Azure OpenAI deployment.

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • deployment_id (String.t): Azure deployment ID
  • openai_create_image_request (OpenaiCreateImageRequest):
  • opts (keyword): Optional parameters
    • :"api-version" (String.t): Azure API version

Returns

  • {:ok, ExBifrost.Model.OpenaiCreateImage200Response.t} on success
  • {:error, Tesla.Env.t} on failure

azure_create_response(connection, deployment_id, open_ai_responses_request, opts \\ [])

Create response (Azure OpenAI)

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • deployment_id (String.t): Azure deployment ID
  • open_ai_responses_request (OpenAiResponsesRequest):
  • opts (keyword): Optional parameters
    • :"api-version" (String.t):

Returns

  • {:ok, ExBifrost.Model.ResponsesResponse.t} on success
  • {:error, Tesla.Env.t} on failure

azure_create_speech(connection, deployment_id, open_ai_speech_request, opts \\ [])

@spec azure_create_speech(
  Tesla.Env.client(),
  String.t(),
  ExBifrost.Model.OpenAiSpeechRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.BifrostError.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Create speech (Azure OpenAI TTS)

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • deployment_id (String.t): Azure deployment ID
  • open_ai_speech_request (OpenAiSpeechRequest):
  • opts (keyword): Optional parameters
    • :"api-version" (String.t):

Returns

  • {:ok, String.t} on success
  • {:error, Tesla.Env.t} on failure

azure_create_text_completion(connection, deployment_id, open_ai_text_completion_request, opts \\ [])

Create text completion (Azure OpenAI)

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • deployment_id (String.t): Azure deployment ID
  • open_ai_text_completion_request (OpenAiTextCompletionRequest):
  • opts (keyword): Optional parameters
    • :"api-version" (String.t):

Returns

  • {:ok, ExBifrost.Model.TextCompletionResponse.t} on success
  • {:error, Tesla.Env.t} on failure

azure_create_transcription(connection, deployment_id, model, file, opts \\ [])

@spec azure_create_transcription(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.BifrostError.t()}
  | {:ok, ExBifrost.Model.TranscriptionResponse.t()}
  | {:error, Tesla.Env.t()}

Create transcription (Azure OpenAI)

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • deployment_id (String.t): Azure deployment ID
  • model (String.t): Model identifier (e.g., whisper-1)
  • file (String.t): Audio file to transcribe
  • opts (keyword): Optional parameters
    • :"api-version" (String.t):
    • :language (String.t): Language of the audio (ISO 639-1)
    • :prompt (String.t): Prompt to guide transcription
    • :response_format (String.t):
    • :temperature (number()):
    • :timestamp_granularities ([String.t]):
    • :stream (boolean()):
    • :fallbacks ([String.t]):

Returns

  • {:ok, ExBifrost.Model.TranscriptionResponse.t} on success
  • {:error, Tesla.Env.t} on failure

azure_list_models(connection, deployment_id, opts \\ [])

@spec azure_list_models(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExBifrost.Model.OpenAiListModelsResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

List models (Azure OpenAI)

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • deployment_id (String.t): Azure deployment ID
  • opts (keyword): Optional parameters
    • :"api-version" (String.t):

Returns

  • {:ok, ExBifrost.Model.OpenAiListModelsResponse.t} on success
  • {:error, Tesla.Env.t} on failure