mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-14 14:27:58 +00:00
feat(api)!: support extra_body to embeddings and vector_stores APIs (#3794)
Some checks failed
Integration Auth Tests / test-matrix (oauth2_token) (push) Failing after 0s
Python Package Build Test / build (3.12) (push) Failing after 1s
Unit Tests / unit-tests (3.13) (push) Failing after 4s
SqlStore Integration Tests / test-postgres (3.12) (push) Failing after 0s
SqlStore Integration Tests / test-postgres (3.13) (push) Failing after 0s
Test External Providers Installed via Module / test-external-providers-from-module (venv) (push) Has been skipped
Python Package Build Test / build (3.13) (push) Failing after 1s
Integration Tests (Replay) / Integration Tests (, , , client=, ) (push) Failing after 3s
Vector IO Integration Tests / test-matrix (push) Failing after 5s
Test External API and Providers / test-external (venv) (push) Failing after 5s
Unit Tests / unit-tests (3.12) (push) Failing after 4s
API Conformance Tests / check-schema-compatibility (push) Successful in 10s
UI Tests / ui-tests (22) (push) Successful in 40s
Pre-commit / pre-commit (push) Successful in 1m23s
Some checks failed
Integration Auth Tests / test-matrix (oauth2_token) (push) Failing after 0s
Python Package Build Test / build (3.12) (push) Failing after 1s
Unit Tests / unit-tests (3.13) (push) Failing after 4s
SqlStore Integration Tests / test-postgres (3.12) (push) Failing after 0s
SqlStore Integration Tests / test-postgres (3.13) (push) Failing after 0s
Test External Providers Installed via Module / test-external-providers-from-module (venv) (push) Has been skipped
Python Package Build Test / build (3.13) (push) Failing after 1s
Integration Tests (Replay) / Integration Tests (, , , client=, ) (push) Failing after 3s
Vector IO Integration Tests / test-matrix (push) Failing after 5s
Test External API and Providers / test-external (venv) (push) Failing after 5s
Unit Tests / unit-tests (3.12) (push) Failing after 4s
API Conformance Tests / check-schema-compatibility (push) Successful in 10s
UI Tests / ui-tests (22) (push) Successful in 40s
Pre-commit / pre-commit (push) Successful in 1m23s
Applies the same pattern from https://github.com/llamastack/llama-stack/pull/3777 to embeddings and vector_stores.create() endpoints. This should _not_ be a breaking change since (a) our tests were already using the `extra_body` parameter when passing in to the backend (b) but the backend probably wasn't extracting the parameters correctly. This PR will fix that. Updated APIs: `openai_embeddings(), openai_create_vector_store(), openai_create_vector_store_file_batch()`
This commit is contained in:
Ashwin Bharambe
GitHub
parent
3bb6ef351b
commit
ecc8a554d2
26 changed files with 451 additions and 426 deletions
54
docs/static/deprecated-llama-stack-spec.html
vendored
54
docs/static/deprecated-llama-stack-spec.html
vendored
|
|
@ -1662,7 +1662,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OpenaiEmbeddingsRequest"
|
||||
"$ref": "#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -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"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -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",
|
||||
|
|
@ -2638,7 +2638,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OpenaiCreateVectorStoreFileBatchRequest"
|
||||
"$ref": "#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -8174,7 +8174,7 @@
|
|||
"title": "OpenAICompletionChoice",
|
||||
"description": "A choice from an OpenAI-compatible completion response."
|
||||
},
|
||||
"OpenaiEmbeddingsRequest": {
|
||||
"OpenAIEmbeddingsRequestWithExtraBody": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"model": {
|
||||
|
|
@ -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": {
|
||||
|
|
@ -8213,7 +8214,8 @@
|
|||
"model",
|
||||
"input"
|
||||
],
|
||||
"title": "OpenaiEmbeddingsRequest"
|
||||
"title": "OpenAIEmbeddingsRequestWithExtraBody",
|
||||
"description": "Request parameters for OpenAI-compatible embeddings endpoint."
|
||||
},
|
||||
"OpenAIEmbeddingData": {
|
||||
"type": "object",
|
||||
|
|
@ -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",
|
||||
|
|
@ -12099,7 +12101,7 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"description": "The expiration policy for a vector store."
|
||||
"description": "(Optional) Expiration policy for the vector store"
|
||||
},
|
||||
"chunking_strategy": {
|
||||
"type": "object",
|
||||
|
|
@ -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",
|
||||
|
|
@ -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",
|
||||
|
|
@ -12337,7 +12328,7 @@
|
|||
"title": "VectorStoreChunkingStrategyStaticConfig",
|
||||
"description": "Configuration for static chunking strategy."
|
||||
},
|
||||
"OpenaiCreateVectorStoreFileBatchRequest": {
|
||||
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"file_ids": {
|
||||
|
|
@ -12345,7 +12336,7 @@
|
|||
"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",
|
||||
|
|
@ -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",
|
||||
|
|
|
|||
68
docs/static/deprecated-llama-stack-spec.yaml
vendored
68
docs/static/deprecated-llama-stack-spec.yaml
vendored
|
|
@ -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:
|
||||
|
|
@ -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}:
|
||||
|
|
@ -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
|
||||
|
|
@ -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}:
|
||||
|
|
@ -6035,7 +6042,7 @@ components:
|
|||
title: OpenAICompletionChoice
|
||||
description: >-
|
||||
A choice from an OpenAI-compatible completion response.
|
||||
OpenaiEmbeddingsRequest:
|
||||
OpenAIEmbeddingsRequestWithExtraBody:
|
||||
type: object
|
||||
properties:
|
||||
model:
|
||||
|
|
@ -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".
|
||||
|
|
@ -6071,7 +6079,9 @@ components:
|
|||
required:
|
||||
- model
|
||||
- input
|
||||
title: OpenaiEmbeddingsRequest
|
||||
title: OpenAIEmbeddingsRequestWithExtraBody
|
||||
description: >-
|
||||
Request parameters for OpenAI-compatible embeddings endpoint.
|
||||
OpenAIEmbeddingData:
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -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:
|
||||
|
|
@ -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:
|
||||
|
|
@ -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:
|
||||
|
|
@ -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:
|
||||
|
|
@ -9331,7 +9330,7 @@ components:
|
|||
title: VectorStoreChunkingStrategyStaticConfig
|
||||
description: >-
|
||||
Configuration for static chunking strategy.
|
||||
OpenaiCreateVectorStoreFileBatchRequest:
|
||||
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody":
|
||||
type: object
|
||||
properties:
|
||||
file_ids:
|
||||
|
|
@ -9339,7 +9338,7 @@ components:
|
|||
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:
|
||||
|
|
@ -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:
|
||||
|
|
|
|||
54
docs/static/llama-stack-spec.html
vendored
54
docs/static/llama-stack-spec.html
vendored
|
|
@ -765,7 +765,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OpenaiEmbeddingsRequest"
|
||||
"$ref": "#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3170,13 +3170,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"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3356,7 +3356,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",
|
||||
|
|
@ -3372,7 +3372,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OpenaiCreateVectorStoreFileBatchRequest"
|
||||
"$ref": "#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -6324,7 +6324,7 @@
|
|||
"title": "ConversationItemDeletedResource",
|
||||
"description": "Response for deleted conversation item."
|
||||
},
|
||||
"OpenaiEmbeddingsRequest": {
|
||||
"OpenAIEmbeddingsRequestWithExtraBody": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"model": {
|
||||
|
|
@ -6347,6 +6347,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": {
|
||||
|
|
@ -6363,7 +6364,8 @@
|
|||
"model",
|
||||
"input"
|
||||
],
|
||||
"title": "OpenaiEmbeddingsRequest"
|
||||
"title": "OpenAIEmbeddingsRequestWithExtraBody",
|
||||
"description": "Request parameters for OpenAI-compatible embeddings endpoint."
|
||||
},
|
||||
"OpenAIEmbeddingData": {
|
||||
"type": "object",
|
||||
|
|
@ -12587,19 +12589,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",
|
||||
|
|
@ -12625,7 +12627,7 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"description": "The expiration policy for a vector store."
|
||||
"description": "(Optional) Expiration policy for the vector store"
|
||||
},
|
||||
"chunking_strategy": {
|
||||
"type": "object",
|
||||
|
|
@ -12651,7 +12653,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",
|
||||
|
|
@ -12677,23 +12679,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",
|
||||
|
|
@ -12863,7 +12854,7 @@
|
|||
"title": "VectorStoreChunkingStrategyStaticConfig",
|
||||
"description": "Configuration for static chunking strategy."
|
||||
},
|
||||
"OpenaiCreateVectorStoreFileBatchRequest": {
|
||||
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"file_ids": {
|
||||
|
|
@ -12871,7 +12862,7 @@
|
|||
"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",
|
||||
|
|
@ -12897,18 +12888,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",
|
||||
|
|
|
|||
68
docs/static/llama-stack-spec.yaml
vendored
68
docs/static/llama-stack-spec.yaml
vendored
|
|
@ -617,7 +617,7 @@ paths:
|
|||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/OpenaiEmbeddingsRequest'
|
||||
$ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1/files:
|
||||
|
|
@ -2413,13 +2413,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: false
|
||||
/v1/vector_stores/{vector_store_id}:
|
||||
|
|
@ -2545,7 +2548,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
|
||||
|
|
@ -2558,7 +2565,7 @@ paths:
|
|||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/OpenaiCreateVectorStoreFileBatchRequest'
|
||||
$ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}:
|
||||
|
|
@ -4797,7 +4804,7 @@ components:
|
|||
- deleted
|
||||
title: ConversationItemDeletedResource
|
||||
description: Response for deleted conversation item.
|
||||
OpenaiEmbeddingsRequest:
|
||||
OpenAIEmbeddingsRequestWithExtraBody:
|
||||
type: object
|
||||
properties:
|
||||
model:
|
||||
|
|
@ -4816,6 +4823,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".
|
||||
|
|
@ -4833,7 +4841,9 @@ components:
|
|||
required:
|
||||
- model
|
||||
- input
|
||||
title: OpenaiEmbeddingsRequest
|
||||
title: OpenAIEmbeddingsRequestWithExtraBody
|
||||
description: >-
|
||||
Request parameters for OpenAI-compatible embeddings endpoint.
|
||||
OpenAIEmbeddingData:
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -9612,19 +9622,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:
|
||||
|
|
@ -9636,7 +9645,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:
|
||||
|
|
@ -9648,8 +9657,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:
|
||||
|
|
@ -9661,21 +9669,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:
|
||||
|
|
@ -9796,7 +9795,7 @@ components:
|
|||
title: VectorStoreChunkingStrategyStaticConfig
|
||||
description: >-
|
||||
Configuration for static chunking strategy.
|
||||
OpenaiCreateVectorStoreFileBatchRequest:
|
||||
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody":
|
||||
type: object
|
||||
properties:
|
||||
file_ids:
|
||||
|
|
@ -9804,7 +9803,7 @@ components:
|
|||
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:
|
||||
|
|
@ -9816,16 +9815,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:
|
||||
|
|
|
|||
54
docs/static/stainless-llama-stack-spec.html
vendored
54
docs/static/stainless-llama-stack-spec.html
vendored
|
|
@ -765,7 +765,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OpenaiEmbeddingsRequest"
|
||||
"$ref": "#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3170,13 +3170,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"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3356,7 +3356,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",
|
||||
|
|
@ -3372,7 +3372,7 @@
|
|||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/OpenaiCreateVectorStoreFileBatchRequest"
|
||||
"$ref": "#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -8333,7 +8333,7 @@
|
|||
"title": "ConversationItemDeletedResource",
|
||||
"description": "Response for deleted conversation item."
|
||||
},
|
||||
"OpenaiEmbeddingsRequest": {
|
||||
"OpenAIEmbeddingsRequestWithExtraBody": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"model": {
|
||||
|
|
@ -8356,6 +8356,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": {
|
||||
|
|
@ -8372,7 +8373,8 @@
|
|||
"model",
|
||||
"input"
|
||||
],
|
||||
"title": "OpenaiEmbeddingsRequest"
|
||||
"title": "OpenAIEmbeddingsRequestWithExtraBody",
|
||||
"description": "Request parameters for OpenAI-compatible embeddings endpoint."
|
||||
},
|
||||
"OpenAIEmbeddingData": {
|
||||
"type": "object",
|
||||
|
|
@ -14596,19 +14598,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",
|
||||
|
|
@ -14634,7 +14636,7 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"description": "The expiration policy for a vector store."
|
||||
"description": "(Optional) Expiration policy for the vector store"
|
||||
},
|
||||
"chunking_strategy": {
|
||||
"type": "object",
|
||||
|
|
@ -14660,7 +14662,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",
|
||||
|
|
@ -14686,23 +14688,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",
|
||||
|
|
@ -14872,7 +14863,7 @@
|
|||
"title": "VectorStoreChunkingStrategyStaticConfig",
|
||||
"description": "Configuration for static chunking strategy."
|
||||
},
|
||||
"OpenaiCreateVectorStoreFileBatchRequest": {
|
||||
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"file_ids": {
|
||||
|
|
@ -14880,7 +14871,7 @@
|
|||
"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",
|
||||
|
|
@ -14906,18 +14897,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",
|
||||
|
|
|
|||
68
docs/static/stainless-llama-stack-spec.yaml
vendored
68
docs/static/stainless-llama-stack-spec.yaml
vendored
|
|
@ -620,7 +620,7 @@ paths:
|
|||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/OpenaiEmbeddingsRequest'
|
||||
$ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1/files:
|
||||
|
|
@ -2416,13 +2416,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: false
|
||||
/v1/vector_stores/{vector_store_id}:
|
||||
|
|
@ -2548,7 +2551,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
|
||||
|
|
@ -2561,7 +2568,7 @@ paths:
|
|||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/OpenaiCreateVectorStoreFileBatchRequest'
|
||||
$ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody'
|
||||
required: true
|
||||
deprecated: false
|
||||
/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}:
|
||||
|
|
@ -6242,7 +6249,7 @@ components:
|
|||
- deleted
|
||||
title: ConversationItemDeletedResource
|
||||
description: Response for deleted conversation item.
|
||||
OpenaiEmbeddingsRequest:
|
||||
OpenAIEmbeddingsRequestWithExtraBody:
|
||||
type: object
|
||||
properties:
|
||||
model:
|
||||
|
|
@ -6261,6 +6268,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".
|
||||
|
|
@ -6278,7 +6286,9 @@ components:
|
|||
required:
|
||||
- model
|
||||
- input
|
||||
title: OpenaiEmbeddingsRequest
|
||||
title: OpenAIEmbeddingsRequestWithExtraBody
|
||||
description: >-
|
||||
Request parameters for OpenAI-compatible embeddings endpoint.
|
||||
OpenAIEmbeddingData:
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -11057,19 +11067,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:
|
||||
|
|
@ -11081,7 +11090,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:
|
||||
|
|
@ -11093,8 +11102,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:
|
||||
|
|
@ -11106,21 +11114,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:
|
||||
|
|
@ -11241,7 +11240,7 @@ components:
|
|||
title: VectorStoreChunkingStrategyStaticConfig
|
||||
description: >-
|
||||
Configuration for static chunking strategy.
|
||||
OpenaiCreateVectorStoreFileBatchRequest:
|
||||
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody":
|
||||
type: object
|
||||
properties:
|
||||
file_ids:
|
||||
|
|
@ -11249,7 +11248,7 @@ components:
|
|||
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:
|
||||
|
|
@ -11261,16 +11260,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:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue