aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--tools/openapi.yaml15
1 files changed, 8 insertions, 7 deletions
diff --git a/tools/openapi.yaml b/tools/openapi.yaml
index 3381dca..657502b 100644
--- a/tools/openapi.yaml
+++ b/tools/openapi.yaml
@@ -3,11 +3,12 @@ info:
title: embed.c server API
version: "1.0.0"
description: >
- HTTP API served by `embed-server` for pplx-embed and Qwen3-Embedding models.
- The endpoints follow the Perplexity API (pplx-embed) and the Qwen/DashScope
- OpenAI-compatible API (Qwen3-Embedding). How an embedding is encoded on the
- wire depends on the model family; see `encoding_format`. Always compare
- embeddings with cosine similarity.
+ HTTP API served by `embed-server` for pplx-embed, Qwen3-Embedding, GTE-Qwen2,
+ BERT/BGE, and multilingual XLM-R (E5, Arctic) embedding models. Requests
+ follow one of two conventions by model family: the Perplexity API (pplx-embed)
+ or the Qwen/DashScope OpenAI-compatible API (every other family). How an
+ embedding is encoded on the wire depends on the model family; see
+ `encoding_format`. Always compare embeddings with cosine similarity.
license:
name: MIT
servers:
@@ -113,8 +114,8 @@ components:
type: integer
description: >
Matryoshka truncation, from the model minimum (32 for Qwen3, 128 for
- pplx) up to the model's native dimension. Truncated vectors are
- re-normalized.
+ pplx, 256 for arctic-embed) up to the model's native dimension.
+ Truncated vectors are re-normalized.
EmbeddingsResponse:
type: object
properties: