Skip to content

feat(api)!: support extra_body to embeddings and vector_stores APIs #3794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashwinb merged 10 commits into from
Oct 13, 2025
Merged

feat(api)!: support extra_body to embeddings and vector_stores APIs #3794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
74e2976
feat(api)!: support passing extra_body to embeddings and vector_store…
ashwinb Oct 11, 2025
8fa91f9
fix(router): update VectorIORouter to use new params signature
ashwinb Oct 12, 2025
3568ccd
fix: extract llama-stack params from model_extra, not as explicit fields
ashwinb Oct 12, 2025
58fcaa4
fix: update VectorIORouter to get provider before calling openai_* me…
ashwinb Oct 12, 2025
bf59d26
fixes
ashwinb Oct 12, 2025
e5a1cdf
more fixes
ashwinb Oct 12, 2025
eaa91aa
pre-commit and unit test fixes
ashwinb Oct 13, 2025
33d7119
Merge remote-tracking branch 'origin/main' into embeddings_extra_body
ashwinb Oct 13, 2025
e642849
undo vector_store_id in params
ashwinb Oct 13, 2025
bbdde4e
fix batch embeddings
ashwinb Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 23 additions & 31 deletions docs/static/deprecated-llama-stack-spec.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1662,7 +1662,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenaiEmbeddingsRequest"
"$ref": "#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody"
}
}
},
Expand Down Expand Up @@ -2436,13 +2436,13 @@
"VectorIO"
],
"summary": "Creates a vector store.",
"description": "Creates a vector store.",
"description": "Creates a vector store.\nGenerate an OpenAI-compatible vector store with the given parameters.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenaiCreateVectorStoreRequest"
"$ref": "#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody"
}
}
},
Expand Down Expand Up @@ -2622,7 +2622,7 @@
"VectorIO"
],
"summary": "Create a vector store file batch.",
"description": "Create a vector store file batch.",
"description": "Create a vector store file batch.\nGenerate an OpenAI-compatible vector store file batch for the given vector store.",
"parameters": [
{
"name": "vector_store_id",
Expand All @@ -2638,7 +2638,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenaiCreateVectorStoreFileBatchRequest"
"$ref": "#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody"
}
}
},
Expand Down Expand Up @@ -8174,7 +8174,7 @@
"title": "OpenAICompletionChoice",
"description": "A choice from an OpenAI-compatible completion response."
},
"OpenaiEmbeddingsRequest": {
"OpenAIEmbeddingsRequestWithExtraBody": {
"type": "object",
"properties": {
"model": {
Expand All @@ -8197,6 +8197,7 @@
},
"encoding_format": {
"type": "string",
"default": "float",
"description": "(Optional) The format to return the embeddings in. Can be either \"float\" or \"base64\". Defaults to \"float\"."
},
"dimensions": {
Expand All @@ -8213,7 +8214,8 @@
"model",
"input"
],
"title": "OpenaiEmbeddingsRequest"
"title": "OpenAIEmbeddingsRequestWithExtraBody",
"description": "Request parameters for OpenAI-compatible embeddings endpoint."
},
"OpenAIEmbeddingData": {
"type": "object",
Expand Down Expand Up @@ -12061,19 +12063,19 @@
"title": "VectorStoreObject",
"description": "OpenAI Vector Store object."
},
"OpenaiCreateVectorStoreRequest": {
"OpenAICreateVectorStoreRequestWithExtraBody": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A name for the vector store."
"description": "(Optional) A name for the vector store"
},
"file_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files."
"description": "List of file IDs to include in the vector store"
},
"expires_after": {
"type": "object",
Expand All @@ -12099,7 +12101,7 @@
}
]
},
"description": "The expiration policy for a vector store."
"description": "(Optional) Expiration policy for the vector store"
},
"chunking_strategy": {
"type": "object",
Expand All @@ -12125,7 +12127,7 @@
}
]
},
"description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy."
"description": "(Optional) Strategy for splitting files into chunks"
},
"metadata": {
"type": "object",
Expand All @@ -12151,23 +12153,12 @@
}
]
},
"description": "Set of 16 key-value pairs that can be attached to an object."
},
"embedding_model": {
"type": "string",
"description": "The embedding model to use for this vector store."
},
"embedding_dimension": {
"type": "integer",
"description": "The dimension of the embedding vectors (default: 384)."
},
"provider_id": {
"type": "string",
"description": "The ID of the provider to use for this vector store."
"description": "Set of key-value pairs that can be attached to the vector store"
}
},
"additionalProperties": false,
"title": "OpenaiCreateVectorStoreRequest"
"title": "OpenAICreateVectorStoreRequestWithExtraBody",
"description": "Request to create a vector store with extra_body support."
},
"OpenaiUpdateVectorStoreRequest": {
"type": "object",
Expand Down Expand Up @@ -12337,15 +12328,15 @@
"title": "VectorStoreChunkingStrategyStaticConfig",
"description": "Configuration for static chunking strategy."
},
"OpenaiCreateVectorStoreFileBatchRequest": {
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody": {
"type": "object",
"properties": {
"file_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of File IDs that the vector store should use."
"description": "A list of File IDs that the vector store should use"
},
"attributes": {
"type": "object",
Expand All @@ -12371,18 +12362,19 @@
}
]
},
"description": "(Optional) Key-value attributes to store with the files."
"description": "(Optional) Key-value attributes to store with the files"
},
"chunking_strategy": {
"$ref": "#/components/schemas/VectorStoreChunkingStrategy",
"description": "(Optional) The chunking strategy used to chunk the file(s). Defaults to auto."
"description": "(Optional) The chunking strategy used to chunk the file(s). Defaults to auto"
}
},
"additionalProperties": false,
"required": [
"file_ids"
],
"title": "OpenaiCreateVectorStoreFileBatchRequest"
"title": "OpenAICreateVectorStoreFileBatchRequestWithExtraBody",
"description": "Request to create a vector store file batch with extra_body support."
},
"VectorStoreFileBatchObject": {
"type": "object",
Expand Down
68 changes: 35 additions & 33 deletions docs/static/deprecated-llama-stack-spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1203,7 +1203,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenaiEmbeddingsRequest'
$ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody'
required: true
deprecated: true
/v1/openai/v1/files:
Expand Down Expand Up @@ -1792,13 +1792,16 @@ paths:
tags:
- VectorIO
summary: Creates a vector store.
description: Creates a vector store.
description: >-
Creates a vector store.

Generate an OpenAI-compatible vector store with the given parameters.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenaiCreateVectorStoreRequest'
$ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody'
required: true
deprecated: true
/v1/openai/v1/vector_stores/{vector_store_id}:
Expand Down Expand Up @@ -1924,7 +1927,11 @@ paths:
tags:
- VectorIO
summary: Create a vector store file batch.
description: Create a vector store file batch.
description: >-
Create a vector store file batch.

Generate an OpenAI-compatible vector store file batch for the given vector
store.
parameters:
- name: vector_store_id
in: path
Expand All @@ -1937,7 +1944,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenaiCreateVectorStoreFileBatchRequest'
$ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody'
required: true
deprecated: true
/v1/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}:
Expand Down Expand Up @@ -6035,7 +6042,7 @@ components:
title: OpenAICompletionChoice
description: >-
A choice from an OpenAI-compatible completion response.
OpenaiEmbeddingsRequest:
OpenAIEmbeddingsRequestWithExtraBody:
type: object
properties:
model:
Expand All @@ -6054,6 +6061,7 @@ components:
multiple inputs in a single request, pass an array of strings.
encoding_format:
type: string
default: float
description: >-
(Optional) The format to return the embeddings in. Can be either "float"
or "base64". Defaults to "float".
Expand All @@ -6071,7 +6079,9 @@ components:
required:
- model
- input
title: OpenaiEmbeddingsRequest
title: OpenAIEmbeddingsRequestWithExtraBody
description: >-
Request parameters for OpenAI-compatible embeddings endpoint.
OpenAIEmbeddingData:
type: object
properties:
Expand Down Expand Up @@ -9147,19 +9157,18 @@ components:
- metadata
title: VectorStoreObject
description: OpenAI Vector Store object.
OpenaiCreateVectorStoreRequest:
"OpenAICreateVectorStoreRequestWithExtraBody":
type: object
properties:
name:
type: string
description: A name for the vector store.
description: (Optional) A name for the vector store
file_ids:
type: array
items:
type: string
description: >-
A list of File IDs that the vector store should use. Useful for tools
like `file_search` that can access files.
List of file IDs to include in the vector store
expires_after:
type: object
additionalProperties:
Expand All @@ -9171,7 +9180,7 @@ components:
- type: array
- type: object
description: >-
The expiration policy for a vector store.
(Optional) Expiration policy for the vector store
chunking_strategy:
type: object
additionalProperties:
Expand All @@ -9183,8 +9192,7 @@ components:
- type: array
- type: object
description: >-
The chunking strategy used to chunk the file(s). If not set, will use
the `auto` strategy.
(Optional) Strategy for splitting files into chunks
metadata:
type: object
additionalProperties:
Expand All @@ -9196,21 +9204,12 @@ components:
- type: array
- type: object
description: >-
Set of 16 key-value pairs that can be attached to an object.
embedding_model:
type: string
description: >-
The embedding model to use for this vector store.
embedding_dimension:
type: integer
description: >-
The dimension of the embedding vectors (default: 384).
provider_id:
type: string
description: >-
The ID of the provider to use for this vector store.
Set of key-value pairs that can be attached to the vector store
additionalProperties: false
title: OpenaiCreateVectorStoreRequest
title: >-
OpenAICreateVectorStoreRequestWithExtraBody
description: >-
Request to create a vector store with extra_body support.
OpenaiUpdateVectorStoreRequest:
type: object
properties:
Expand Down Expand Up @@ -9331,15 +9330,15 @@ components:
title: VectorStoreChunkingStrategyStaticConfig
description: >-
Configuration for static chunking strategy.
OpenaiCreateVectorStoreFileBatchRequest:
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody":
type: object
properties:
file_ids:
type: array
items:
type: string
description: >-
A list of File IDs that the vector store should use.
A list of File IDs that the vector store should use
attributes:
type: object
additionalProperties:
Expand All @@ -9351,16 +9350,19 @@ components:
- type: array
- type: object
description: >-
(Optional) Key-value attributes to store with the files.
(Optional) Key-value attributes to store with the files
chunking_strategy:
$ref: '#/components/schemas/VectorStoreChunkingStrategy'
description: >-
(Optional) The chunking strategy used to chunk the file(s). Defaults to
auto.
auto
additionalProperties: false
required:
- file_ids
title: OpenaiCreateVectorStoreFileBatchRequest
title: >-
OpenAICreateVectorStoreFileBatchRequestWithExtraBody
description: >-
Request to create a vector store file batch with extra_body support.
VectorStoreFileBatchObject:
type: object
properties:
Expand Down
Loading
Loading