openai Embedding

Zilla runtime openai embedding resolves text to a vector using OpenAI's embeddings API. It backs semantic tool search or any other consumer of the embedding engine SPI with a hosted, managed embedding model.

Available in Zilla Plus

embedding:
  type: openai
  options:
    model: text-embedding-3-small
    credentials:
      api-key: ${{env.OPENAI_API_KEY}}

Configuration (* required)

options

object

The openai specific options.

options.model *

string

The OpenAI embedding model id, e.g. text-embedding-3-small or text-embedding-3-large.

options.credentials *

object

The OpenAI credentials.

options.credentials.api-key *

string

The OpenAI API key, sent as an Authorization: Bearer header on each request. Typically supplied via an environment variable reference, e.g. ${{env.OPENAI_API_KEY}}, rather than inlined directly.

Note

The key needs only one restricted permission: Model capabilities > Embeddings (/v1/embeddings): Request. No other scopes are required.