feat: include results in store search events response

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 55
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/mixedbread%2Fmixedbread-ebd391dad1252eb00dd69ac50455b93bcdcd2cf0177d678e160e47f1d017287f.yml
 openapi_spec_hash: 3bfd5f9eb34711238caef851aa81f5c0
-config_hash: c32ffa6858a02d7f23f6f3dda0b461ed
+config_hash: 594a43c9cb8089f079bb9c5442646791

api.md

@@ -30,13 +30,29 @@ Types:
 
 ```python
 from mixedbread.types import (
+    AgenticSearchConfig,
+    AudioChunkGeneratedMetadata,
+    AudioURL,
+    CodeChunkGeneratedMetadata,
+    ContextualizationConfig,
     ExpiresAfter,
+    FileCounts,
+    ImageChunkGeneratedMetadata,
+    ImageURLOutput,
+    MarkdownChunkGeneratedMetadata,
+    MarkdownHeading,
+    PdfChunkGeneratedMetadata,
+    RerankConfig,
     ScoredAudioURLInputChunk,
     ScoredImageURLInputChunk,
     ScoredTextInputChunk,
     ScoredVideoURLInputChunk,
     Store,
     StoreChunkSearchOptions,
+    StoreConfig,
+    TextChunkGeneratedMetadata,
+    VideoChunkGeneratedMetadata,
+    VideoURL,
     StoreDeleteResponse,
     StoreMetadataFacetsResponse,
     StoreQuestionAnsweringResponse,
@@ -60,7 +76,17 @@ Methods:
 Types:
 
 ```python
-from mixedbread.types.stores import StoreFileStatus, StoreFile, FileListResponse, FileDeleteResponse
+from mixedbread.types.stores import (
+    AudioURLInputChunk,
+    ImageURLInputChunk,
+    StoreFile,
+    StoreFileConfig,
+    StoreFileStatus,
+    TextInputChunk,
+    VideoURLInputChunk,
+    FileListResponse,
+    FileDeleteResponse,
+)
 ```
 
 Methods:
@@ -79,10 +105,13 @@ Types:
 
 ```python
 from mixedbread.types.parsing import (
+    Chunk,
+    ChunkElement,
     ChunkingStrategy,
+    DocumentParserResult,
     ElementType,
-    ParsingJobStatus,
     ParsingJob,
+    ParsingJobStatus,
     ReturnFormat,
     JobListResponse,
     JobDeleteResponse,
@@ -196,7 +225,9 @@ Types:
 
 ```python
 from mixedbread.types import (
+    APIKeyCreateOrUpdateParams,
     DataSource,
+    DataSourceAPIKeyParams,
     DataSourceOauth2Params,
     DataSourceType,
     LinearDataSource,
@@ -235,7 +266,7 @@ Methods:
 Types:
 
 ```python
-from mixedbread.types import APIKey, APIKeyCreated, APIKeyDeleteResponse
+from mixedbread.types import APIKey, APIKeyCreated, Scope, APIKeyDeleteResponse
 ```
 
 Methods:

src/mixedbread/resources/api_keys.py

@@ -21,6 +21,7 @@
 from ..pagination import SyncLimitOffset, AsyncLimitOffset
 from .._base_client import AsyncPaginator, make_request_options
 from ..types.api_key import APIKey
+from ..types.scope_param import ScopeParam
 from ..types.api_key_created import APIKeyCreated
 from ..types.api_key_delete_response import APIKeyDeleteResponse
 
@@ -51,7 +52,7 @@ def create(
         self,
         *,
         name: str | Omit = omit,
-        scope: Optional[Iterable[api_key_create_params.Scope]] | Omit = omit,
+        scope: Optional[Iterable[ScopeParam]] | Omit = omit,
         expires_at: Union[str, datetime, None] | 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.
@@ -335,7 +336,7 @@ async def create(
         self,
         *,
         name: str | Omit = omit,
-        scope: Optional[Iterable[api_key_create_params.Scope]] | Omit = omit,
+        scope: Optional[Iterable[ScopeParam]] | Omit = omit,
         expires_at: Union[str, datetime, None] | 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.

src/mixedbread/resources/stores/files.py

@@ -20,11 +20,17 @@
     async_to_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
-from ...types.stores import file_list_params, file_create_params, file_update_params, file_retrieve_params
+from ...types.stores import (
+    file_list_params,
+    file_create_params,
+    file_update_params,
+    file_retrieve_params,
+)
 from ...types.stores.store_file import StoreFile
 from ...types.stores.store_file_status import StoreFileStatus
 from ...types.stores.file_list_response import FileListResponse
 from ...types.stores.file_delete_response import FileDeleteResponse
+from ...types.stores.store_file_config_param import StoreFileConfigParam
 
 __all__ = ["FilesResource", "AsyncFilesResource"]
 
@@ -54,11 +60,11 @@ def create(
         store_identifier: str,
         *,
         metadata: object | Omit = omit,
-        config: file_create_params.Config | Omit = omit,
+        config: StoreFileConfigParam | Omit = omit,
         external_id: Optional[str] | Omit = omit,
         overwrite: bool | Omit = omit,
         file_id: str,
-        experimental: Optional[file_create_params.Experimental] | Omit = omit,
+        experimental: Optional[StoreFileConfigParam] | 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.
         extra_headers: Headers | None = None,
@@ -550,11 +556,11 @@ async def create(
         store_identifier: str,
         *,
         metadata: object | Omit = omit,
-        config: file_create_params.Config | Omit = omit,
+        config: StoreFileConfigParam | Omit = omit,
         external_id: Optional[str] | Omit = omit,
         overwrite: bool | Omit = omit,
         file_id: str,
-        experimental: Optional[file_create_params.Experimental] | Omit = omit,
+        experimental: Optional[StoreFileConfigParam] | 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.
         extra_headers: Headers | None = None,

src/mixedbread/resources/stores/stores.py

@@ -35,6 +35,7 @@
 from ...pagination import SyncCursor, AsyncCursor
 from ...types.store import Store
 from ..._base_client import AsyncPaginator, make_request_options
+from ...types.store_config_param import StoreConfigParam
 from ...types.expires_after_param import ExpiresAfterParam
 from ...types.store_delete_response import StoreDeleteResponse
 from ...types.store_search_response import StoreSearchResponse
@@ -78,7 +79,7 @@ def create(
         license: Optional[str] | Omit = omit,
         expires_after: Optional[ExpiresAfterParam] | Omit = omit,
         metadata: object | Omit = omit,
-        config: Optional[store_create_params.Config] | Omit = omit,
+        config: Optional[StoreConfigParam] | 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.
@@ -607,7 +608,7 @@ async def create(
         license: Optional[str] | Omit = omit,
         expires_after: Optional[ExpiresAfterParam] | Omit = omit,
         metadata: object | Omit = omit,
-        config: Optional[store_create_params.Config] | Omit = omit,
+        config: Optional[StoreConfigParam] | 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.

src/mixedbread/types/__init__.py

@@ -4,12 +4,18 @@
 
 from . import shared
 from .. import _compat
+from .scope import Scope as Scope
 from .store import Store as Store
 from .shared import Usage as Usage, SearchFilter as SearchFilter, SearchFilterCondition as SearchFilterCondition
 from .api_key import APIKey as APIKey
+from .audio_url import AudioURL as AudioURL
 from .embedding import Embedding as Embedding
+from .video_url import VideoURL as VideoURL
 from .data_source import DataSource as DataSource
+from .file_counts import FileCounts as FileCounts
 from .file_object import FileObject as FileObject
+from .scope_param import ScopeParam as ScopeParam
+from .store_config import StoreConfig as StoreConfig
 from .expires_after import ExpiresAfter as ExpiresAfter
 from .info_response import InfoResponse as InfoResponse
 from .oauth2_params import Oauth2Params as Oauth2Params
@@ -18,12 +24,16 @@
 from .rerank_response import RerankResponse as RerankResponse
 from .data_source_type import DataSourceType as DataSourceType
 from .file_list_params import FileListParams as FileListParams
+from .image_url_output import ImageURLOutput as ImageURLOutput
+from .markdown_heading import MarkdownHeading as MarkdownHeading
 from .store_list_params import StoreListParams as StoreListParams
 from .file_create_params import FileCreateParams as FileCreateParams
 from .file_update_params import FileUpdateParams as FileUpdateParams
+from .store_config_param import StoreConfigParam as StoreConfigParam
 from .api_key_list_params import APIKeyListParams as APIKeyListParams
 from .client_embed_params import ClientEmbedParams as ClientEmbedParams
 from .expires_after_param import ExpiresAfterParam as ExpiresAfterParam
+from .rerank_config_param import RerankConfigParam as RerankConfigParam
 from .store_create_params import StoreCreateParams as StoreCreateParams
 from .store_search_params import StoreSearchParams as StoreSearchParams
 from .store_update_params import StoreUpdateParams as StoreUpdateParams
@@ -37,21 +47,33 @@
 from .data_source_list_params import DataSourceListParams as DataSourceListParams
 from .embedding_create_params import EmbeddingCreateParams as EmbeddingCreateParams
 from .scored_text_input_chunk import ScoredTextInputChunk as ScoredTextInputChunk
+from .contextualization_config import ContextualizationConfig as ContextualizationConfig
 from .linear_data_source_param import LinearDataSourceParam as LinearDataSourceParam
 from .multi_encoding_embedding import MultiEncodingEmbedding as MultiEncodingEmbedding
 from .notion_data_source_param import NotionDataSourceParam as NotionDataSourceParam
 from .data_source_create_params import DataSourceCreateParams as DataSourceCreateParams
 from .data_source_oauth2_params import DataSourceOauth2Params as DataSourceOauth2Params
 from .data_source_update_params import DataSourceUpdateParams as DataSourceUpdateParams
 from .embedding_create_response import EmbeddingCreateResponse as EmbeddingCreateResponse
+from .data_source_api_key_params import DataSourceAPIKeyParams as DataSourceAPIKeyParams
+from .agentic_search_config_param import AgenticSearchConfigParam as AgenticSearchConfigParam
 from .data_source_delete_response import DataSourceDeleteResponse as DataSourceDeleteResponse
+from .pdf_chunk_generated_metadata import PdfChunkGeneratedMetadata as PdfChunkGeneratedMetadata
 from .scored_audio_url_input_chunk import ScoredAudioURLInputChunk as ScoredAudioURLInputChunk
 from .scored_image_url_input_chunk import ScoredImageURLInputChunk as ScoredImageURLInputChunk
 from .scored_video_url_input_chunk import ScoredVideoURLInputChunk as ScoredVideoURLInputChunk
 from .store_metadata_facets_params import StoreMetadataFacetsParams as StoreMetadataFacetsParams
+from .code_chunk_generated_metadata import CodeChunkGeneratedMetadata as CodeChunkGeneratedMetadata
+from .text_chunk_generated_metadata import TextChunkGeneratedMetadata as TextChunkGeneratedMetadata
+from .audio_chunk_generated_metadata import AudioChunkGeneratedMetadata as AudioChunkGeneratedMetadata
+from .contextualization_config_param import ContextualizationConfigParam as ContextualizationConfigParam
+from .image_chunk_generated_metadata import ImageChunkGeneratedMetadata as ImageChunkGeneratedMetadata
 from .store_metadata_facets_response import StoreMetadataFacetsResponse as StoreMetadataFacetsResponse
+from .video_chunk_generated_metadata import VideoChunkGeneratedMetadata as VideoChunkGeneratedMetadata
+from .api_key_create_or_update_params import APIKeyCreateOrUpdateParams as APIKeyCreateOrUpdateParams
 from .store_question_answering_params import StoreQuestionAnsweringParams as StoreQuestionAnsweringParams
 from .store_chunk_search_options_param import StoreChunkSearchOptionsParam as StoreChunkSearchOptionsParam
+from .markdown_chunk_generated_metadata import MarkdownChunkGeneratedMetadata as MarkdownChunkGeneratedMetadata
 from .store_question_answering_response import StoreQuestionAnsweringResponse as StoreQuestionAnsweringResponse
 
 # Rebuild cyclical models only after all modules are imported.

src/mixedbread/types/agentic_search_config_param.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["AgenticSearchConfigParam"]
+
+
+class AgenticSearchConfigParam(TypedDict, total=False):
+    """Configuration for agentic multi-query search."""
+
+    max_rounds: int
+    """Maximum number of search rounds"""
+
+    queries_per_round: int
+    """Maximum queries per round"""
+
+    instructions: Optional[str]
+    """
+    Additional custom instructions (followed only when not in conflict with existing
+    rules)
+    """

src/mixedbread/types/api_key.py

@@ -4,17 +4,10 @@
 from datetime import datetime
 from typing_extensions import Literal
 
+from .scope import Scope
 from .._models import BaseModel
 
-__all__ = ["APIKey", "Scope"]
-
-
-class Scope(BaseModel):
-    method: Literal["read", "write", "delete", "list", "create", "search"]
-
-    resource_type: Optional[Literal["store"]] = None
-
-    resource_id: Optional[str] = None
+__all__ = ["APIKey"]
 
 
 class APIKey(BaseModel):

src/mixedbread/types/api_key_create_or_update_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["APIKeyCreateOrUpdateParams"]
+
+
+class APIKeyCreateOrUpdateParams(TypedDict, total=False):
+    """Base class for API key create or update parameters."""
+
+    type: Literal["api_key"]
+
+    api_key: Required[str]
+    """The API key"""

src/mixedbread/types/api_key_create_params.py

@@ -4,27 +4,20 @@
 
 from typing import Union, Iterable, Optional
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 from .._utils import PropertyInfo
+from .scope_param import ScopeParam
 
-__all__ = ["APIKeyCreateParams", "Scope"]
+__all__ = ["APIKeyCreateParams"]
 
 
 class APIKeyCreateParams(TypedDict, total=False):
     name: str
     """A name/description for the API key"""
 
-    scope: Optional[Iterable[Scope]]
+    scope: Optional[Iterable[ScopeParam]]
     """The scope of the API key"""
 
     expires_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Optional expiration datetime"""
-
-
-class Scope(TypedDict, total=False):
-    method: Required[Literal["read", "write", "delete", "list", "create", "search"]]
-
-    resource_type: Optional[Literal["store"]]
-
-    resource_id: Optional[str]