Download OpenAPI specification:
Gen3 AI API.
+Read a single embedding from a specific collection.
+Args: + collection_name: Name of the collection. + embedding_uuid: UUID of the embedding. + dal: Data access layer dependency.
+Returns: + SingleEmbeddingResult
+Raises: + HTTPException: 404 if the collection or embedding is not found.
+| collection_name required | string (Collection Name) |
| embedding_uuid required | string <uuid> (Embedding Uuid) |
{- "vector": [
- 0
], - "input_index": 0,
- "embedding_id": "18e0b745-2b45-46cb-a826-bc9049d1152c",
- "info": {
- "collection_id": 0,
- "authz": [
- "string"
], - "authz_version": 0,
- "metadata": { },
- "self": "string"
}
}Update the embedding vector for a given collection and embedding ID.
+Args: + request: The request object + collection_name: Name of the collections. + embedding_uuid: UUID of the embedding. + body: Request body containing the new embedding vector. + dal: Data access layer dependency.
+Returns: + SingleEmbeddingResult containing the updated embedding.
+Raises: + HTTPException: 404 if the collection is not found; 400 if update fails.
+| collection_name required | string (Collection Name) |
| embedding_uuid required | string <uuid> (Embedding Uuid) |
Array of Embedding (numbers) or Embedding (null) (Embedding) | |
Metadata (object) or Metadata (null) (Metadata) |
{- "embedding": [
- 0
], - "metadata": { }
}{- "vector": [
- 0
], - "input_index": 0,
- "embedding_id": "18e0b745-2b45-46cb-a826-bc9049d1152c",
- "info": {
- "collection_id": 0,
- "authz": [
- "string"
], - "authz_version": 0,
- "metadata": { },
- "self": "string"
}
}Delete an embedding from a specific collection.
+Args: + request: The request object + collection_name: Name of the collections. + embedding_uuid: UUID of the embedding to delete. + dal: Data access layer dependency.
+Returns: + None on success.
+Raises: + HTTPException: 404 if the collection or embedding is not found.
+| collection_name required | string (Collection Name) |
| embedding_uuid required | string <uuid> (Embedding Uuid) |
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string",
- "input": null,
- "ctx": { }
}
]
}List all embeddings within a specific collection.
+Args: + request: The request object + collection_name: Name of the collections. + no_embeddings_info: If True, omit the 'info' block in each embedding result. + dal: Data access layer dependency.
+Returns: + EmbeddingResponseNoCollection containing all embeddings in the collection.
+Raises: + HTTPException: 404 if the collection is not found.
+| collection_name required | string (Collection Name) |
| no_embeddings_info | boolean (No Embeddings Info) Default: false |
| page | integer (Page) >= 1 Default: 1 |
| page_size | integer (Page Size) [ 100 .. 1000 ] Default: 100 |
{- "embeddings": [
- {
- "vector": [
- 0
], - "input_index": 0,
- "embedding_id": "18e0b745-2b45-46cb-a826-bc9049d1152c",
- "info": {
- "collection_id": 0,
- "authz": [
- "string"
], - "authz_version": 0,
- "metadata": { },
- "self": "string"
}
}
], - "page": 0,
- "page_size": 0,
- "next_page": 0,
- "prev_page": 0
}TODO: implementaion for StringArrayInput and ai_model +TODO: auth related +TODO: work for authz_version
+Create one or more embeddings in a specific collection.
+This minimal implementation only accepts raw numeric vectors.
+Args: + request: The request object + collection_name: Name of the collection. + body: Request body containing a list of embedding vectors. + ai_model: Optional model name; not used in this minimal version. + no_embeddings_info: If True, omit the 'info' block in each embedding result. + dal: Data access layer dependency.
+Returns: + EmbeddingResponseNoCollection containing the created embeddings.
+Raises: + HTTPException: 404 if collection is not found; 400 if dimensions mismatch.
+| collection_name required | string (Collection Name) |
Ai Model (string) or Ai Model (null) (Ai Model) | |
| no_embeddings_info | boolean (No Embeddings Info) Default: false |
required | Array of objects (Embeddings) |
{- "embeddings": [
- {
- "embedding": [
- 0.1,
- 0.2,
- 0.3
], - "metadata": {
- "chunk_size": "1000",
- "source": "some_file.md"
}
}
]
}{- "embeddings": [
- {
- "vector": [
- 0
], - "input_index": 0,
- "embedding_id": "18e0b745-2b45-46cb-a826-bc9049d1152c",
- "info": {
- "collection_id": 0,
- "authz": [
- "string"
], - "authz_version": 0,
- "metadata": { },
- "self": "string"
}
}
]
}TODO: collections list is needed as return? +TODO: update dal.get_collection_by_id_bulk. remove duplicates?
+Read a selection of embeddings by UUID across any collection.
+Args: + request: The request object + embedding_uuids: List of embedding UUIDs to fetch. + no_embeddings_info: If True, omit the 'info' block for each embedding. + dal: Data access layer dependency.
+Returns: + EmbeddingResponse including collection metadata for each embedding.
+| no_embeddings_info | boolean (No Embeddings Info) Default: false |
"embedding_uuid_0"{- "embeddings": [
- {
- "vector": [
- 0
], - "input_index": 0,
- "embedding_id": "18e0b745-2b45-46cb-a826-bc9049d1152c",
- "info": {
- "collection_id": 0,
- "authz": [
- "string"
], - "authz_version": 0,
- "metadata": { },
- "self": "string"
}
}
], - "collections": [
- {
- "id": 0,
- "collection_name": "string",
- "description": "string",
- "dimensions": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "self": "string"
}
]
}Read a selection of embeddings by UUID from a specific collection.
+Args: + request: The request object + collection_name: Name of the collections. + embedding_uuids: List of embedding UUIDs to fetch. + no_embeddings_info: If True, omit the 'info' block for each embedding. + dal: Data access layer dependency.
+Returns: + EmbeddingResponse containing the embeddings found in the specified collection.
+Raises: + HTTPException: 404 if the collection is not found.
+| collection_name required | string (Collection Name) |
| no_embeddings_info | boolean (No Embeddings Info) Default: false |
"embedding_uuid_0"{- "embeddings": [
- {
- "vector": [
- 0
], - "input_index": 0,
- "embedding_id": "18e0b745-2b45-46cb-a826-bc9049d1152c",
- "info": {
- "collection_id": 0,
- "authz": [
- "string"
], - "authz_version": 0,
- "metadata": { },
- "self": "string"
}
}
]
}List all existing collections.
+Args: + request: The request object + dal: Data access layer dependency.
+Returns: + PaginatedCollectionsResponse containing all collections.
+| page | integer (Page) >= 1 Default: 1 |
| page_size | integer (Page Size) [ 1 .. 1000 ] Default: 100 |
| collection_name required | string (Collection Name) |
{- "collections": [
- {
- "id": 0,
- "collection_name": "string",
- "description": "string",
- "dimensions": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "self": "string"
}
], - "page": 0,
- "page_size": 0,
- "next_page": 0,
- "prev_page": 0
}Create a new collection.
+Args: + request: The request object + body: Request body containing collection_name, description, and dimensions. + dal: Data access layer dependency.
+Returns: + CollectionModel for the created collection.
+| collection_name required | string (Collection Name) |
Description (string) or Description (null) (Description) | |
| dimensions required | integer (Dimensions) |
{- "collection_name": "string",
- "description": "string",
- "dimensions": 0
}{- "id": 0,
- "collection_name": "string",
- "description": "string",
- "dimensions": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "self": "string"
}Read information about a specific collection.
+Args: + collection_name: Name of the collection. + dal: Data access layer dependency.
+Returns: + CollectionModel representing the collection.
+Raises: + HTTPException: 404 if collection is not found.
+| collection_name required | string (Collection Name) |
{- "id": 0,
- "collection_name": "string",
- "description": "string",
- "dimensions": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "self": "string"
}Update mutable metadata fields for a collection.
+Args: + collection_name: Name of the collection to update. + body: Request body containing fields to update (e.g., description). + dal: Data access layer dependency.
+Returns: + A simple success status dict.
+Raises: + HTTPException: 404 if collection is not found.
+| collection_name required | string (Collection Name) |
Description (string) or Description (null) (Description) |
{- "description": "string"
}nullDelete a collection by name.
+Args: + collection_name: Name of the collection to delete. + dal: Data access layer dependency.
+Returns: + None on success.
+Raises: + HTTPException: 404 if collection is not found.
+| collection_name required | string (Collection Name) |
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string",
- "input": null,
- "ctx": { }
}
]
}TODO: support for ai_model +TODO: raw text search
+Perform a vector search within a specific collection.
+Args: + request: The request object + body: SearchRequestBody containing the query vector and parameters. + collection_name: Name of the collection to search. + ai_model: Optional model name; not used in this minimal implementation. + no_embeddings_info: If True, omit the 'info' block in each embedding result. + dal: Data access layer dependency.
+Returns: + SearchResponseNocollection containing search hits for this collection.
+Raises: + HTTPException: 404 if collection is not found; 400 if input is invalid.
+| collection_name required | string (Collection Name) |
Ai Model (string) or Ai Model (null) (Ai Model) | |
| no_embeddings_info | boolean (No Embeddings Info) Default: false |
required | Input (string) or Array of Input (numbers) (Input) |
| top_k | integer (Top K) Default: 10 |
Range (number) or Range (null) (Range) | |
Filters (object) or Filters (null) (Filters) |
{- "input": "string",
- "top_k": 10,
- "range": 0,
- "filters": {
- "property1": "string",
- "property2": "string"
}
}{- "embeddings": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "similarity_score": 0,
- "embedding": {
- "vector": [
- 0
], - "input_index": 0,
- "embedding_id": "18e0b745-2b45-46cb-a826-bc9049d1152c",
- "info": {
- "collection_id": 0,
- "authz": [
- "string"
], - "authz_version": 0,
- "metadata": { },
- "self": "string"
}
}
}
], - "collections": [
- {
- "id": 0,
- "collection_name": "string",
- "description": "string",
- "dimensions": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "self": "string"
}
]
}TODO: support for ai_model +TODO: how to handle diffs in dimensions? current logic is not sufficient.
+Perform a vector search across multiple collections.
+Args: + request: The request object + body: SearchRequestBody containing the query vector and parameters. + collections: Optional comma-separated list of collection names to restrict the search. + ai_model: Optional model name; not used in this minimal implementation. + no_embeddings_info: If True, omit the 'info' block in each embedding result. + dal: Data access layer dependency.
+Returns: + SearchResponse containing search hits across collections.
+Raises: + HTTPException: 400 if invalid collections are specified or input is invalid.
+Collections (string) or Collections (null) (Collections) | |
Ai Model (string) or Ai Model (null) (Ai Model) | |
| no_embeddings_info | boolean (No Embeddings Info) Default: false |
required | Input (string) or Array of Input (numbers) (Input) |
| top_k | integer (Top K) Default: 10 |
Range (number) or Range (null) (Range) | |
Filters (object) or Filters (null) (Filters) |
{- "input": "string",
- "top_k": 10,
- "range": 0,
- "filters": {
- "property1": "string",
- "property2": "string"
}
}{- "embeddings": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "similarity_score": 0,
- "embedding": {
- "vector": [
- 0
], - "input_index": 0,
- "embedding_id": "18e0b745-2b45-46cb-a826-bc9049d1152c",
- "info": {
- "collection_id": 0,
- "authz": [
- "string"
], - "authz_version": 0,
- "metadata": { },
- "self": "string"
}
}
}
], - "collections": [
- {
- "id": 0,
- "collection_name": "string",
- "description": "string",
- "dimensions": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "self": "string"
}
]
}See official spec for details (https://openresponses.org). This OpenAPI spec here is auto-generated.
+Model (string) or Model (null) (Model) | |
Input (string) or (Array of Input (ItemReferenceParam (object) or ReasoningItemParam (object) or UserMessageItemParam (object) or SystemMessageItemParam (object) or DeveloperMessageItemParam (object) or AssistantMessageItemParam (object) or FunctionCallItemParam (object) or FunctionCallOutputItemParam (object))) or Input (null) (Input) | |
Previous Response Id (string) or Previous Response Id (null) (Previous Response Id) | |
Array of Include (strings) or Include (null) (Include) | |
Array of Tools (objects) or Tools (null) (Tools) | |
ToolChoice2 (object) or ToolChoice3 (string) or ToolChoice4 (object) or Tool Choice (null) (Tool Choice) | |
MetadataParam (object) or null | |
TextParam (object) or null | |
Temperature (number) or Temperature (null) (Temperature) | |
Top P (number) or Top P (null) (Top P) | |
Presence Penalty (number) or Presence Penalty (null) (Presence Penalty) | |
Frequency Penalty (number) or Frequency Penalty (null) (Frequency Penalty) | |
Parallel Tool Calls (boolean) or Parallel Tool Calls (null) (Parallel Tool Calls) | |
Stream (boolean) or Stream (null) (Stream) Whether to stream response events as server-sent events. + | |
StreamOptionsParam (object) or null | |
Background (boolean) or Background (null) (Background) Whether to run the request in the background and return immediately. + | |
MaxOutputTokens (integer) or null | |
MaxToolCalls (integer) or null | |
ReasoningParam (object) or null | |
SafetyIdentifier (string) or null | |
PromptCacheKey (string) or null | |
TruncationEnum (string) or null | |
Instructions (string) or Instructions (null) (Instructions) | |
Store (boolean) or Store (null) (Store) Whether to store the response so it can be retrieved later. + | |
ServiceTierEnum (string) or null | |
TopLogprobs (integer) or null |
{- "model": "string",
- "input": "string",
- "previous_response_id": "string",
- "include": [
- "reasoning.encrypted_content"
], - "tools": [
- {
- "name": "string",
- "description": "string",
- "parameters": { },
- "strict": true,
- "type": "function"
}
], - "tool_choice": { },
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "format": {
- "type": "text"
}, - "verbosity": "low"
}, - "temperature": 0,
- "top_p": 0,
- "presence_penalty": 0,
- "frequency_penalty": 0,
- "parallel_tool_calls": true,
- "stream": true,
- "stream_options": {
- "include_obfuscation": true
}, - "background": true,
- "max_output_tokens": 16,
- "max_tool_calls": 1,
- "reasoning": {
- "effort": "none",
- "summary": "concise"
}, - "safety_identifier": "string",
- "prompt_cache_key": "string",
- "truncation": "auto",
- "instructions": "string",
- "store": true,
- "service_tier": "auto",
- "top_logprobs": 20
}{- "id": "string",
- "object": "response",
- "created_at": 0,
- "completed_at": 0,
- "status": "string",
- "incomplete_details": {
- "reason": "string"
}, - "model": "string",
- "previous_response_id": "string",
- "instructions": "string",
- "output": [
- {
- "type": "message",
- "id": "string",
- "status": "in_progress",
- "role": "user",
- "content": [
- {
- "type": "input_text",
- "text": "string"
}
]
}
], - "error": {
- "code": "string",
- "message": "string"
}, - "tools": [
- {
- "type": "function",
- "name": "string",
- "description": "string",
- "parameters": { },
- "strict": true
}
], - "tool_choice": {
- "type": "function",
- "name": "string"
}, - "truncation": "auto",
- "parallel_tool_calls": true,
- "text": {
- "format": {
- "type": "text"
}, - "verbosity": "low"
}, - "top_p": 0,
- "presence_penalty": 0,
- "frequency_penalty": 0,
- "top_logprobs": 0,
- "temperature": 0,
- "reasoning": {
- "effort": "none",
- "summary": "concise"
}, - "usage": {
- "input_tokens": 0,
- "output_tokens": 0,
- "total_tokens": 0,
- "input_tokens_details": {
- "cached_tokens": 0
}, - "output_tokens_details": {
- "reasoning_tokens": 0
}
}, - "max_output_tokens": 0,
- "max_tool_calls": 0,
- "store": true,
- "background": true,
- "service_tier": "string",
- "metadata": null,
- "safety_identifier": "string",
- "prompt_cache_key": "string"
}