Merge pull request #252 from mixedbread-ai/release-please--branches--main--changes--next

release: 0.37.0

Author: joeldierkes

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.36.1"
+  ".": "0.37.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 62
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/mixedbread%2Fmixedbread-fd92f46929d60af07c2abfd39a9850b71e4ba2ebfd67627f6ebec99e48dee5db.yml
-openapi_spec_hash: 450000939194685c6b33fec0dee1ce30
-config_hash: 1f4b314dbc7ae3afe6d669e36217b842
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/mixedbread%2Fmixedbread-b091721a627d75feb8567f628f99405d5778b0b88e9cc09fc664dd8e97c6d720.yml
+openapi_spec_hash: a23a2aecdcff5fa1d6c8cdc0df0bdfb7
+config_hash: 22ce3b96e325037f81e7dbf22bdd8d24

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.37.0 (2025-11-03)
+
+Full Changelog: [v0.36.1...v0.37.0](https://github.com/mixedbread-ai/mixedbread-python/compare/v0.36.1...v0.37.0)
+
+### Features
+
+* **api:** api update ([4a78563](https://github.com/mixedbread-ai/mixedbread-python/commit/4a78563a989f5ad8501e99539a352c4b054510d3))
+* **api:** update via SDK Studio ([1eb35c4](https://github.com/mixedbread-ai/mixedbread-python/commit/1eb35c40f676cf43b8de275320858c953c103036))
+
 ## 0.36.1 (2025-10-31)
 
 Full Changelog: [v0.36.0...v0.36.1](https://github.com/mixedbread-ai/mixedbread-python/compare/v0.36.0...v0.36.1)

api.md

@@ -99,7 +99,7 @@ Methods:
 - <code title="put /v1/stores/{store_identifier}">client.stores.<a href="./src/mixedbread/resources/stores/stores.py">update</a>(store_identifier, \*\*<a href="src/mixedbread/types/store_update_params.py">params</a>) -> <a href="./src/mixedbread/types/store.py">Store</a></code>
 - <code title="get /v1/stores">client.stores.<a href="./src/mixedbread/resources/stores/stores.py">list</a>(\*\*<a href="src/mixedbread/types/store_list_params.py">params</a>) -> <a href="./src/mixedbread/types/store.py">SyncCursor[Store]</a></code>
 - <code title="delete /v1/stores/{store_identifier}">client.stores.<a href="./src/mixedbread/resources/stores/stores.py">delete</a>(store_identifier) -> <a href="./src/mixedbread/types/store_delete_response.py">StoreDeleteResponse</a></code>
-- <code title="post /v1/stores/{store_identifier}/metadata-facets">client.stores.<a href="./src/mixedbread/resources/stores/stores.py">metadata_facets</a>(store_identifier, \*\*<a href="src/mixedbread/types/store_metadata_facets_params.py">params</a>) -> <a href="./src/mixedbread/types/store_metadata_facets_response.py">StoreMetadataFacetsResponse</a></code>
+- <code title="post /v1/stores/metadata-facets">client.stores.<a href="./src/mixedbread/resources/stores/stores.py">metadata_facets</a>(\*\*<a href="src/mixedbread/types/store_metadata_facets_params.py">params</a>) -> <a href="./src/mixedbread/types/store_metadata_facets_response.py">StoreMetadataFacetsResponse</a></code>
 - <code title="post /v1/stores/question-answering">client.stores.<a href="./src/mixedbread/resources/stores/stores.py">question_answering</a>(\*\*<a href="src/mixedbread/types/store_question_answering_params.py">params</a>) -> <a href="./src/mixedbread/types/store_question_answering_response.py">StoreQuestionAnsweringResponse</a></code>
 - <code title="post /v1/stores/search">client.stores.<a href="./src/mixedbread/resources/stores/stores.py">search</a>(\*\*<a href="src/mixedbread/types/store_search_params.py">params</a>) -> <a href="./src/mixedbread/types/store_search_response.py">StoreSearchResponse</a></code>
 
@@ -121,7 +121,7 @@ from mixedbread.types.stores import (
 Methods:
 
 - <code title="post /v1/stores/{store_identifier}/files">client.stores.files.<a href="./src/mixedbread/resources/stores/files.py">create</a>(store_identifier, \*\*<a href="src/mixedbread/types/stores/file_create_params.py">params</a>) -> <a href="./src/mixedbread/types/stores/store_file.py">StoreFile</a></code>
-- <code title="get /v1/stores/{store_identifier}/files/{file_id}">client.stores.files.<a href="./src/mixedbread/resources/stores/files.py">retrieve</a>(file_id, \*, store_identifier, \*\*<a href="src/mixedbread/types/stores/file_retrieve_params.py">params</a>) -> <a href="./src/mixedbread/types/stores/store_file.py">StoreFile</a></code>
+- <code title="get /v1/stores/{store_identifier}/files/{file_identifier}">client.stores.files.<a href="./src/mixedbread/resources/stores/files.py">retrieve</a>(file_identifier, \*, store_identifier, \*\*<a href="src/mixedbread/types/stores/file_retrieve_params.py">params</a>) -> <a href="./src/mixedbread/types/stores/store_file.py">StoreFile</a></code>
 - <code title="post /v1/stores/{store_identifier}/files/list">client.stores.files.<a href="./src/mixedbread/resources/stores/files.py">list</a>(store_identifier, \*\*<a href="src/mixedbread/types/stores/file_list_params.py">params</a>) -> <a href="./src/mixedbread/types/stores/file_list_response.py">FileListResponse</a></code>
 - <code title="delete /v1/stores/{store_identifier}/files/{file_id}">client.stores.files.<a href="./src/mixedbread/resources/stores/files.py">delete</a>(file_id, \*, store_identifier) -> <a href="./src/mixedbread/types/stores/file_delete_response.py">FileDeleteResponse</a></code>
 - <code title="post /v1/stores/files/search">client.stores.files.<a href="./src/mixedbread/resources/stores/files.py">search</a>(\*\*<a href="src/mixedbread/types/stores/file_search_params.py">params</a>) -> <a href="./src/mixedbread/types/stores/file_search_response.py">FileSearchResponse</a></code>

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mixedbread"
-version = "0.36.1"
+version = "0.37.0"
 description = "The official Python library for the Mixedbread API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/mixedbread/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "mixedbread"
-__version__ = "0.36.1"  # x-release-please-version
+__version__ = "0.37.0"  # x-release-please-version

src/mixedbread/resources/stores/files.py

@@ -55,6 +55,8 @@ def create(
         *,
         metadata: object | Omit = omit,
         config: file_create_params.Config | Omit = omit,
+        external_id: Optional[str] | Omit = omit,
+        overwrite: bool | Omit = omit,
         file_id: str,
         experimental: Optional[file_create_params.Experimental] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -80,6 +82,10 @@ def create(
 
           config: Configuration for adding the file
 
+          external_id: External identifier for this file in the store
+
+          overwrite: If true, overwrite an existing file with the same external_id
+
           file_id: ID of the file to add
 
           experimental: Configuration for a file.
@@ -100,6 +106,8 @@ def create(
                 {
                     "metadata": metadata,
                     "config": config,
+                    "external_id": external_id,
+                    "overwrite": overwrite,
                     "file_id": file_id,
                     "experimental": experimental,
                 },
@@ -113,7 +121,7 @@ def create(
 
     def retrieve(
         self,
-        file_id: str,
+        file_identifier: str,
         *,
         store_identifier: str,
         return_chunks: bool | Omit = omit,
@@ -136,7 +144,7 @@ def retrieve(
         Args:
           store_identifier: The ID or name of the store
 
-          file_id: The ID or name of the file
+          file_identifier: The ID or name of the file
 
           return_chunks: Whether to return the chunks for the file
 
@@ -150,10 +158,10 @@ def retrieve(
         """
         if not store_identifier:
             raise ValueError(f"Expected a non-empty value for `store_identifier` but received {store_identifier!r}")
-        if not file_id:
-            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        if not file_identifier:
+            raise ValueError(f"Expected a non-empty value for `file_identifier` but received {file_identifier!r}")
         return self._get(
-            f"/v1/stores/{store_identifier}/files/{file_id}",
+            f"/v1/stores/{store_identifier}/files/{file_identifier}",
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -479,6 +487,8 @@ async def create(
         *,
         metadata: object | Omit = omit,
         config: file_create_params.Config | Omit = omit,
+        external_id: Optional[str] | Omit = omit,
+        overwrite: bool | Omit = omit,
         file_id: str,
         experimental: Optional[file_create_params.Experimental] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -504,6 +514,10 @@ async def create(
 
           config: Configuration for adding the file
 
+          external_id: External identifier for this file in the store
+
+          overwrite: If true, overwrite an existing file with the same external_id
+
           file_id: ID of the file to add
 
           experimental: Configuration for a file.
@@ -524,6 +538,8 @@ async def create(
                 {
                     "metadata": metadata,
                     "config": config,
+                    "external_id": external_id,
+                    "overwrite": overwrite,
                     "file_id": file_id,
                     "experimental": experimental,
                 },
@@ -537,7 +553,7 @@ async def create(
 
     async def retrieve(
         self,
-        file_id: str,
+        file_identifier: str,
         *,
         store_identifier: str,
         return_chunks: bool | Omit = omit,
@@ -560,7 +576,7 @@ async def retrieve(
         Args:
           store_identifier: The ID or name of the store
 
-          file_id: The ID or name of the file
+          file_identifier: The ID or name of the file
 
           return_chunks: Whether to return the chunks for the file
 
@@ -574,10 +590,10 @@ async def retrieve(
         """
         if not store_identifier:
             raise ValueError(f"Expected a non-empty value for `store_identifier` but received {store_identifier!r}")
-        if not file_id:
-            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        if not file_identifier:
+            raise ValueError(f"Expected a non-empty value for `file_identifier` but received {file_identifier!r}")
         return await self._get(
-            f"/v1/stores/{store_identifier}/files/{file_id}",
+            f"/v1/stores/{store_identifier}/files/{file_identifier}",
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,

src/mixedbread/resources/stores/stores.py

@@ -77,6 +77,7 @@ def create(
         is_public: bool | Omit = omit,
         expires_after: Optional[ExpiresAfterParam] | Omit = omit,
         metadata: object | Omit = omit,
+        config: Optional[store_create_params.Config] | Omit = omit,
         file_ids: Optional[SequenceNotStr[str]] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -104,6 +105,8 @@ def create(
 
           metadata: Optional metadata key-value pairs
 
+          config: Configuration for a store.
+
           file_ids: Optional list of file IDs
 
           extra_headers: Send extra headers
@@ -123,6 +126,7 @@ def create(
                     "is_public": is_public,
                     "expires_after": expires_after,
                     "metadata": metadata,
+                    "config": config,
                     "file_ids": file_ids,
                 },
                 store_create_params.StoreCreateParams,
@@ -345,9 +349,13 @@ def delete(
 
     def metadata_facets(
         self,
-        store_identifier: str,
         *,
+        query: Optional[str] | Omit = omit,
+        store_identifiers: SequenceNotStr[str],
+        top_k: int | Omit = omit,
         filters: Optional[store_metadata_facets_params.Filters] | Omit = omit,
+        file_ids: Union[Iterable[object], SequenceNotStr[str], None] | Omit = omit,
+        search_options: StoreChunkSearchOptionsParam | Omit = omit,
         facets: Optional[SequenceNotStr[str]] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -360,10 +368,18 @@ def metadata_facets(
         Get metadata facets
 
         Args:
-          store_identifier: The ID or name of the store
+          query: Search query text
+
+          store_identifiers: IDs or names of stores to search
+
+          top_k: Number of results to return
 
           filters: Optional filter conditions
 
+          file_ids: Optional list of file IDs to filter chunks by (inclusion filter)
+
+          search_options: Search configuration options
+
           facets: Optional list of facets to return. Use dot for nested fields.
 
           extra_headers: Send extra headers
@@ -374,13 +390,16 @@ def metadata_facets(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not store_identifier:
-            raise ValueError(f"Expected a non-empty value for `store_identifier` but received {store_identifier!r}")
         return self._post(
-            f"/v1/stores/{store_identifier}/metadata-facets",
+            "/v1/stores/metadata-facets",
             body=maybe_transform(
                 {
+                    "query": query,
+                    "store_identifiers": store_identifiers,
+                    "top_k": top_k,
                     "filters": filters,
+                    "file_ids": file_ids,
+                    "search_options": search_options,
                     "facets": facets,
                 },
                 store_metadata_facets_params.StoreMetadataFacetsParams,
@@ -568,6 +587,7 @@ async def create(
         is_public: bool | Omit = omit,
         expires_after: Optional[ExpiresAfterParam] | Omit = omit,
         metadata: object | Omit = omit,
+        config: Optional[store_create_params.Config] | Omit = omit,
         file_ids: Optional[SequenceNotStr[str]] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -595,6 +615,8 @@ async def create(
 
           metadata: Optional metadata key-value pairs
 
+          config: Configuration for a store.
+
           file_ids: Optional list of file IDs
 
           extra_headers: Send extra headers
@@ -614,6 +636,7 @@ async def create(
                     "is_public": is_public,
                     "expires_after": expires_after,
                     "metadata": metadata,
+                    "config": config,
                     "file_ids": file_ids,
                 },
                 store_create_params.StoreCreateParams,
@@ -836,9 +859,13 @@ async def delete(
 
     async def metadata_facets(
         self,
-        store_identifier: str,
         *,
+        query: Optional[str] | Omit = omit,
+        store_identifiers: SequenceNotStr[str],
+        top_k: int | Omit = omit,
         filters: Optional[store_metadata_facets_params.Filters] | Omit = omit,
+        file_ids: Union[Iterable[object], SequenceNotStr[str], None] | Omit = omit,
+        search_options: StoreChunkSearchOptionsParam | Omit = omit,
         facets: Optional[SequenceNotStr[str]] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -851,10 +878,18 @@ async def metadata_facets(
         Get metadata facets
 
         Args:
-          store_identifier: The ID or name of the store
+          query: Search query text
+
+          store_identifiers: IDs or names of stores to search
+
+          top_k: Number of results to return
 
           filters: Optional filter conditions
 
+          file_ids: Optional list of file IDs to filter chunks by (inclusion filter)
+
+          search_options: Search configuration options
+
           facets: Optional list of facets to return. Use dot for nested fields.
 
           extra_headers: Send extra headers
@@ -865,13 +900,16 @@ async def metadata_facets(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not store_identifier:
-            raise ValueError(f"Expected a non-empty value for `store_identifier` but received {store_identifier!r}")
         return await self._post(
-            f"/v1/stores/{store_identifier}/metadata-facets",
+            "/v1/stores/metadata-facets",
             body=await async_maybe_transform(
                 {
+                    "query": query,
+                    "store_identifiers": store_identifiers,
+                    "top_k": top_k,
                     "filters": filters,
+                    "file_ids": file_ids,
+                    "search_options": search_options,
                     "facets": facets,
                 },
                 store_metadata_facets_params.StoreMetadataFacetsParams,