WeaviateEx.API.Vectorizers.Text2VecAzureOpenAI (WeaviateEx v0.7.4)

Text2Vec-Azure-OpenAI vectorizer configuration.

Uses Azure OpenAI's embedding models for text vectorization.

Example

Text2VecAzureOpenAI.new(
  resource_name: "my-azure-resource",
  deployment_id: "my-embedding-deployment"
)

Summary

Types

t()

Functions

from_api(map)

Parse configuration from API response.

new(opts \\ [])

Create a new Text2Vec-Azure-OpenAI configuration.

to_api(config)

Convert configuration to API format.

vectorizer_name()

Returns the vectorizer name for the API.

Types

t()

@type t() :: %WeaviateEx.API.Vectorizers.Text2VecAzureOpenAI{
  base_url: String.t() | nil,
  deployment_id: String.t() | nil,
  resource_name: String.t() | nil,
  vectorize_collection_name: boolean()
}

Functions

from_api(map)

@spec from_api(map()) :: t()

Parse configuration from API response.

new(opts \\ [])

@spec new(keyword()) :: t()

Create a new Text2Vec-Azure-OpenAI configuration.

Options

:resource_name - Azure resource name (required)
:deployment_id - Azure deployment ID (required)
:base_url - Custom API endpoint
:vectorize_collection_name - Include collection name (default: true)

to_api(config)

@spec to_api(t()) :: map()

Convert configuration to API format.

vectorizer_name()

@spec vectorizer_name() :: String.t()

Returns the vectorizer name for the API.