-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy path_client.py
More file actions
1141 lines (903 loc) · 41.6 KB
/
_client.py
File metadata and controls
1141 lines (903 loc) · 41.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
import os
from typing import TYPE_CHECKING, Any, Dict, List, Union, Mapping, Iterable, Optional, cast
from typing_extensions import Self, Literal, override
import httpx
from . import _exceptions
from ._qs import Querystring
from .types import client_embed_params, client_rerank_params
from ._types import (
Body,
Omit,
Query,
Headers,
Timeout,
NotGiven,
Transport,
ProxiesTypes,
RequestOptions,
SequenceNotStr,
omit,
not_given,
)
from ._utils import (
is_given,
maybe_transform,
get_async_library,
async_maybe_transform,
)
from ._compat import cached_property
from ._version import __version__
from ._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ._streaming import Stream as Stream, AsyncStream as AsyncStream
from ._exceptions import APIStatusError, MixedbreadError
from ._base_client import (
DEFAULT_MAX_RETRIES,
SyncAPIClient,
AsyncAPIClient,
make_request_options,
)
from .types.info_response import InfoResponse
from .types.encoding_format import EncodingFormat
from .types.rerank_response import RerankResponse
from .types.embedding_create_response import EmbeddingCreateResponse
if TYPE_CHECKING:
from .resources import chat, files, stores, parsing, api_keys, embeddings, extractions, data_sources
from .resources.chat import ChatResource, AsyncChatResource
from .resources.api_keys import APIKeysResource, AsyncAPIKeysResource
from .resources.embeddings import EmbeddingsResource, AsyncEmbeddingsResource
from .resources.files.files import FilesResource, AsyncFilesResource
from .resources.stores.stores import StoresResource, AsyncStoresResource
from .resources.parsing.parsing import ParsingResource, AsyncParsingResource
from .resources.extractions.extractions import ExtractionsResource, AsyncExtractionsResource
from .resources.data_sources.data_sources import DataSourcesResource, AsyncDataSourcesResource
__all__ = [
"ENVIRONMENTS",
"Timeout",
"Transport",
"ProxiesTypes",
"RequestOptions",
"Mixedbread",
"AsyncMixedbread",
"Client",
"AsyncClient",
]
ENVIRONMENTS: Dict[str, str] = {
"production": "https://api.mixedbread.com",
"development": "https://api.dev.mixedbread.com",
"local": "http://127.0.0.1:8000",
}
class Mixedbread(SyncAPIClient):
# client options
api_key: str
_environment: Literal["production", "development", "local"] | NotGiven
def __init__(
self,
*,
api_key: str | None = None,
environment: Literal["production", "development", "local"] | NotGiven = not_given,
base_url: str | httpx.URL | None | NotGiven = not_given,
timeout: float | Timeout | None | NotGiven = not_given,
max_retries: int = DEFAULT_MAX_RETRIES,
default_headers: Mapping[str, str] | None = None,
default_query: Mapping[str, object] | None = None,
# Configure a custom httpx client.
# We provide a `DefaultHttpxClient` class that you can pass to retain the default values we use for `limits`, `timeout` & `follow_redirects`.
# See the [httpx documentation](https://www.python-httpx.org/api/#client) for more details.
http_client: httpx.Client | None = None,
# Enable or disable schema validation for data returned by the API.
# When enabled an error APIResponseValidationError is raised
# if the API responds with invalid data for the expected schema.
#
# This parameter may be removed or changed in the future.
# If you rely on this feature, please open a GitHub issue
# outlining your use-case to help us decide if it should be
# part of our public interface in the future.
_strict_response_validation: bool = False,
) -> None:
"""Construct a new synchronous Mixedbread client instance.
This automatically infers the `api_key` argument from the `MXBAI_API_KEY` environment variable if it is not provided.
"""
if api_key is None:
api_key = os.environ.get("MXBAI_API_KEY")
if api_key is None:
raise MixedbreadError(
"The api_key client option must be set either by passing api_key to the client or by setting the MXBAI_API_KEY environment variable"
)
self.api_key = api_key
self._environment = environment
base_url_env = os.environ.get("MIXEDBREAD_BASE_URL")
if is_given(base_url) and base_url is not None:
# cast required because mypy doesn't understand the type narrowing
base_url = cast("str | httpx.URL", base_url) # pyright: ignore[reportUnnecessaryCast]
elif is_given(environment):
if base_url_env and base_url is not None:
raise ValueError(
"Ambiguous URL; The `MIXEDBREAD_BASE_URL` env var and the `environment` argument are given. If you want to use the environment, you must pass base_url=None",
)
try:
base_url = ENVIRONMENTS[environment]
except KeyError as exc:
raise ValueError(f"Unknown environment: {environment}") from exc
elif base_url_env is not None:
base_url = base_url_env
else:
self._environment = environment = "production"
try:
base_url = ENVIRONMENTS[environment]
except KeyError as exc:
raise ValueError(f"Unknown environment: {environment}") from exc
super().__init__(
version=__version__,
base_url=base_url,
max_retries=max_retries,
timeout=timeout,
http_client=http_client,
custom_headers=default_headers,
custom_query=default_query,
_strict_response_validation=_strict_response_validation,
)
@cached_property
def stores(self) -> StoresResource:
from .resources.stores import StoresResource
return StoresResource(self)
@cached_property
def parsing(self) -> ParsingResource:
from .resources.parsing import ParsingResource
return ParsingResource(self)
@cached_property
def files(self) -> FilesResource:
from .resources.files import FilesResource
return FilesResource(self)
@cached_property
def extractions(self) -> ExtractionsResource:
from .resources.extractions import ExtractionsResource
return ExtractionsResource(self)
@cached_property
def embeddings(self) -> EmbeddingsResource:
from .resources.embeddings import EmbeddingsResource
return EmbeddingsResource(self)
@cached_property
def data_sources(self) -> DataSourcesResource:
from .resources.data_sources import DataSourcesResource
return DataSourcesResource(self)
@cached_property
def api_keys(self) -> APIKeysResource:
from .resources.api_keys import APIKeysResource
return APIKeysResource(self)
@cached_property
def chat(self) -> ChatResource:
from .resources.chat import ChatResource
return ChatResource(self)
@cached_property
def with_raw_response(self) -> MixedbreadWithRawResponse:
return MixedbreadWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> MixedbreadWithStreamedResponse:
return MixedbreadWithStreamedResponse(self)
@property
@override
def qs(self) -> Querystring:
return Querystring(array_format="repeat")
@property
@override
def auth_headers(self) -> dict[str, str]:
api_key = self.api_key
return {"Authorization": f"Bearer {api_key}"}
@property
@override
def default_headers(self) -> dict[str, str | Omit]:
return {
**super().default_headers,
"X-Stainless-Async": "false",
**self._custom_headers,
}
def copy(
self,
*,
api_key: str | None = None,
environment: Literal["production", "development", "local"] | None = None,
base_url: str | httpx.URL | None = None,
timeout: float | Timeout | None | NotGiven = not_given,
http_client: httpx.Client | None = None,
max_retries: int | NotGiven = not_given,
default_headers: Mapping[str, str] | None = None,
set_default_headers: Mapping[str, str] | None = None,
default_query: Mapping[str, object] | None = None,
set_default_query: Mapping[str, object] | None = None,
_extra_kwargs: Mapping[str, Any] = {},
) -> Self:
"""
Create a new client instance re-using the same options given to the current client with optional overriding.
"""
if default_headers is not None and set_default_headers is not None:
raise ValueError("The `default_headers` and `set_default_headers` arguments are mutually exclusive")
if default_query is not None and set_default_query is not None:
raise ValueError("The `default_query` and `set_default_query` arguments are mutually exclusive")
headers = self._custom_headers
if default_headers is not None:
headers = {**headers, **default_headers}
elif set_default_headers is not None:
headers = set_default_headers
params = self._custom_query
if default_query is not None:
params = {**params, **default_query}
elif set_default_query is not None:
params = set_default_query
http_client = http_client or self._client
return self.__class__(
api_key=api_key or self.api_key,
base_url=base_url or self.base_url,
environment=environment or self._environment,
timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
http_client=http_client,
max_retries=max_retries if is_given(max_retries) else self.max_retries,
default_headers=headers,
default_query=params,
**_extra_kwargs,
)
# Alias for `copy` for nicer inline usage, e.g.
# client.with_options(timeout=10).foo.create(...)
with_options = copy
def embed(
self,
*,
model: str,
input: Union[str, SequenceNotStr[str]],
dimensions: Optional[int] | Omit = omit,
prompt: Optional[str] | Omit = omit,
normalized: bool | Omit = omit,
encoding_format: Union[EncodingFormat, List[EncodingFormat]] | 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,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> EmbeddingCreateResponse:
"""
Create embeddings for text or images using the specified model, encoding format,
and normalization.
Args: params: The parameters for creating embeddings.
Returns: EmbeddingCreateResponse: The response containing the embeddings.
Args:
model: The model to use for creating embeddings.
input: The input to create embeddings for.
dimensions: The number of dimensions to use for the embeddings.
prompt: The prompt to use for the embedding creation.
normalized: Whether to normalize the embeddings.
encoding_format: The encoding format(s) of the embeddings. Can be a single format or a list of
formats.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self.post(
"/v1/embeddings",
body=maybe_transform(
{
"model": model,
"input": input,
"dimensions": dimensions,
"prompt": prompt,
"normalized": normalized,
"encoding_format": encoding_format,
},
client_embed_params.ClientEmbedParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=EmbeddingCreateResponse,
)
def info(
self,
*,
# 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,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> InfoResponse:
"""
Returns service information, including name and version.
Returns: InfoResponse: A response containing the service name and version.
"""
return self.get(
"/",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=InfoResponse,
)
def rerank(
self,
*,
model: str | Omit = omit,
query: str,
input: SequenceNotStr[Union[str, Iterable[object], object]],
rank_fields: Optional[SequenceNotStr[str]] | Omit = omit,
top_k: int | Omit = omit,
return_input: bool | Omit = omit,
rewrite_query: bool | 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,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RerankResponse:
"""
Rerank different kind of documents for a given query.
Args: params: RerankParams: The parameters for reranking.
Returns: RerankResponse: The reranked documents for the input query.
Args:
model: The model to use for reranking documents.
query: The query to rerank the documents.
input: The input documents to rerank.
rank_fields: The fields of the documents to rank.
top_k: The number of documents to return.
return_input: Whether to return the documents.
rewrite_query: Wether or not to rewrite the query before passing it to the reranking model
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self.post(
"/v1/reranking",
body=maybe_transform(
{
"model": model,
"query": query,
"input": input,
"rank_fields": rank_fields,
"top_k": top_k,
"return_input": return_input,
"rewrite_query": rewrite_query,
},
client_rerank_params.ClientRerankParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RerankResponse,
)
@override
def _make_status_error(
self,
err_msg: str,
*,
body: object,
response: httpx.Response,
) -> APIStatusError:
if response.status_code == 400:
return _exceptions.BadRequestError(err_msg, response=response, body=body)
if response.status_code == 401:
return _exceptions.AuthenticationError(err_msg, response=response, body=body)
if response.status_code == 403:
return _exceptions.PermissionDeniedError(err_msg, response=response, body=body)
if response.status_code == 404:
return _exceptions.NotFoundError(err_msg, response=response, body=body)
if response.status_code == 409:
return _exceptions.ConflictError(err_msg, response=response, body=body)
if response.status_code == 422:
return _exceptions.UnprocessableEntityError(err_msg, response=response, body=body)
if response.status_code == 429:
return _exceptions.RateLimitError(err_msg, response=response, body=body)
if response.status_code >= 500:
return _exceptions.InternalServerError(err_msg, response=response, body=body)
return APIStatusError(err_msg, response=response, body=body)
class AsyncMixedbread(AsyncAPIClient):
# client options
api_key: str
_environment: Literal["production", "development", "local"] | NotGiven
def __init__(
self,
*,
api_key: str | None = None,
environment: Literal["production", "development", "local"] | NotGiven = not_given,
base_url: str | httpx.URL | None | NotGiven = not_given,
timeout: float | Timeout | None | NotGiven = not_given,
max_retries: int = DEFAULT_MAX_RETRIES,
default_headers: Mapping[str, str] | None = None,
default_query: Mapping[str, object] | None = None,
# Configure a custom httpx client.
# We provide a `DefaultAsyncHttpxClient` class that you can pass to retain the default values we use for `limits`, `timeout` & `follow_redirects`.
# See the [httpx documentation](https://www.python-httpx.org/api/#asyncclient) for more details.
http_client: httpx.AsyncClient | None = None,
# Enable or disable schema validation for data returned by the API.
# When enabled an error APIResponseValidationError is raised
# if the API responds with invalid data for the expected schema.
#
# This parameter may be removed or changed in the future.
# If you rely on this feature, please open a GitHub issue
# outlining your use-case to help us decide if it should be
# part of our public interface in the future.
_strict_response_validation: bool = False,
) -> None:
"""Construct a new async AsyncMixedbread client instance.
This automatically infers the `api_key` argument from the `MXBAI_API_KEY` environment variable if it is not provided.
"""
if api_key is None:
api_key = os.environ.get("MXBAI_API_KEY")
if api_key is None:
raise MixedbreadError(
"The api_key client option must be set either by passing api_key to the client or by setting the MXBAI_API_KEY environment variable"
)
self.api_key = api_key
self._environment = environment
base_url_env = os.environ.get("MIXEDBREAD_BASE_URL")
if is_given(base_url) and base_url is not None:
# cast required because mypy doesn't understand the type narrowing
base_url = cast("str | httpx.URL", base_url) # pyright: ignore[reportUnnecessaryCast]
elif is_given(environment):
if base_url_env and base_url is not None:
raise ValueError(
"Ambiguous URL; The `MIXEDBREAD_BASE_URL` env var and the `environment` argument are given. If you want to use the environment, you must pass base_url=None",
)
try:
base_url = ENVIRONMENTS[environment]
except KeyError as exc:
raise ValueError(f"Unknown environment: {environment}") from exc
elif base_url_env is not None:
base_url = base_url_env
else:
self._environment = environment = "production"
try:
base_url = ENVIRONMENTS[environment]
except KeyError as exc:
raise ValueError(f"Unknown environment: {environment}") from exc
super().__init__(
version=__version__,
base_url=base_url,
max_retries=max_retries,
timeout=timeout,
http_client=http_client,
custom_headers=default_headers,
custom_query=default_query,
_strict_response_validation=_strict_response_validation,
)
@cached_property
def stores(self) -> AsyncStoresResource:
from .resources.stores import AsyncStoresResource
return AsyncStoresResource(self)
@cached_property
def parsing(self) -> AsyncParsingResource:
from .resources.parsing import AsyncParsingResource
return AsyncParsingResource(self)
@cached_property
def files(self) -> AsyncFilesResource:
from .resources.files import AsyncFilesResource
return AsyncFilesResource(self)
@cached_property
def extractions(self) -> AsyncExtractionsResource:
from .resources.extractions import AsyncExtractionsResource
return AsyncExtractionsResource(self)
@cached_property
def embeddings(self) -> AsyncEmbeddingsResource:
from .resources.embeddings import AsyncEmbeddingsResource
return AsyncEmbeddingsResource(self)
@cached_property
def data_sources(self) -> AsyncDataSourcesResource:
from .resources.data_sources import AsyncDataSourcesResource
return AsyncDataSourcesResource(self)
@cached_property
def api_keys(self) -> AsyncAPIKeysResource:
from .resources.api_keys import AsyncAPIKeysResource
return AsyncAPIKeysResource(self)
@cached_property
def chat(self) -> AsyncChatResource:
from .resources.chat import AsyncChatResource
return AsyncChatResource(self)
@cached_property
def with_raw_response(self) -> AsyncMixedbreadWithRawResponse:
return AsyncMixedbreadWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncMixedbreadWithStreamedResponse:
return AsyncMixedbreadWithStreamedResponse(self)
@property
@override
def qs(self) -> Querystring:
return Querystring(array_format="repeat")
@property
@override
def auth_headers(self) -> dict[str, str]:
api_key = self.api_key
return {"Authorization": f"Bearer {api_key}"}
@property
@override
def default_headers(self) -> dict[str, str | Omit]:
return {
**super().default_headers,
"X-Stainless-Async": f"async:{get_async_library()}",
**self._custom_headers,
}
def copy(
self,
*,
api_key: str | None = None,
environment: Literal["production", "development", "local"] | None = None,
base_url: str | httpx.URL | None = None,
timeout: float | Timeout | None | NotGiven = not_given,
http_client: httpx.AsyncClient | None = None,
max_retries: int | NotGiven = not_given,
default_headers: Mapping[str, str] | None = None,
set_default_headers: Mapping[str, str] | None = None,
default_query: Mapping[str, object] | None = None,
set_default_query: Mapping[str, object] | None = None,
_extra_kwargs: Mapping[str, Any] = {},
) -> Self:
"""
Create a new client instance re-using the same options given to the current client with optional overriding.
"""
if default_headers is not None and set_default_headers is not None:
raise ValueError("The `default_headers` and `set_default_headers` arguments are mutually exclusive")
if default_query is not None and set_default_query is not None:
raise ValueError("The `default_query` and `set_default_query` arguments are mutually exclusive")
headers = self._custom_headers
if default_headers is not None:
headers = {**headers, **default_headers}
elif set_default_headers is not None:
headers = set_default_headers
params = self._custom_query
if default_query is not None:
params = {**params, **default_query}
elif set_default_query is not None:
params = set_default_query
http_client = http_client or self._client
return self.__class__(
api_key=api_key or self.api_key,
base_url=base_url or self.base_url,
environment=environment or self._environment,
timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
http_client=http_client,
max_retries=max_retries if is_given(max_retries) else self.max_retries,
default_headers=headers,
default_query=params,
**_extra_kwargs,
)
# Alias for `copy` for nicer inline usage, e.g.
# client.with_options(timeout=10).foo.create(...)
with_options = copy
async def embed(
self,
*,
model: str,
input: Union[str, SequenceNotStr[str]],
dimensions: Optional[int] | Omit = omit,
prompt: Optional[str] | Omit = omit,
normalized: bool | Omit = omit,
encoding_format: Union[EncodingFormat, List[EncodingFormat]] | 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,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> EmbeddingCreateResponse:
"""
Create embeddings for text or images using the specified model, encoding format,
and normalization.
Args: params: The parameters for creating embeddings.
Returns: EmbeddingCreateResponse: The response containing the embeddings.
Args:
model: The model to use for creating embeddings.
input: The input to create embeddings for.
dimensions: The number of dimensions to use for the embeddings.
prompt: The prompt to use for the embedding creation.
normalized: Whether to normalize the embeddings.
encoding_format: The encoding format(s) of the embeddings. Can be a single format or a list of
formats.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self.post(
"/v1/embeddings",
body=await async_maybe_transform(
{
"model": model,
"input": input,
"dimensions": dimensions,
"prompt": prompt,
"normalized": normalized,
"encoding_format": encoding_format,
},
client_embed_params.ClientEmbedParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=EmbeddingCreateResponse,
)
async def info(
self,
*,
# 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,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> InfoResponse:
"""
Returns service information, including name and version.
Returns: InfoResponse: A response containing the service name and version.
"""
return await self.get(
"/",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=InfoResponse,
)
async def rerank(
self,
*,
model: str | Omit = omit,
query: str,
input: SequenceNotStr[Union[str, Iterable[object], object]],
rank_fields: Optional[SequenceNotStr[str]] | Omit = omit,
top_k: int | Omit = omit,
return_input: bool | Omit = omit,
rewrite_query: bool | 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,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RerankResponse:
"""
Rerank different kind of documents for a given query.
Args: params: RerankParams: The parameters for reranking.
Returns: RerankResponse: The reranked documents for the input query.
Args:
model: The model to use for reranking documents.
query: The query to rerank the documents.
input: The input documents to rerank.
rank_fields: The fields of the documents to rank.
top_k: The number of documents to return.
return_input: Whether to return the documents.
rewrite_query: Wether or not to rewrite the query before passing it to the reranking model
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self.post(
"/v1/reranking",
body=await async_maybe_transform(
{
"model": model,
"query": query,
"input": input,
"rank_fields": rank_fields,
"top_k": top_k,
"return_input": return_input,
"rewrite_query": rewrite_query,
},
client_rerank_params.ClientRerankParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RerankResponse,
)
@override
def _make_status_error(
self,
err_msg: str,
*,
body: object,
response: httpx.Response,
) -> APIStatusError:
if response.status_code == 400:
return _exceptions.BadRequestError(err_msg, response=response, body=body)
if response.status_code == 401:
return _exceptions.AuthenticationError(err_msg, response=response, body=body)
if response.status_code == 403:
return _exceptions.PermissionDeniedError(err_msg, response=response, body=body)
if response.status_code == 404:
return _exceptions.NotFoundError(err_msg, response=response, body=body)
if response.status_code == 409:
return _exceptions.ConflictError(err_msg, response=response, body=body)
if response.status_code == 422:
return _exceptions.UnprocessableEntityError(err_msg, response=response, body=body)
if response.status_code == 429:
return _exceptions.RateLimitError(err_msg, response=response, body=body)
if response.status_code >= 500:
return _exceptions.InternalServerError(err_msg, response=response, body=body)
return APIStatusError(err_msg, response=response, body=body)
class MixedbreadWithRawResponse:
_client: Mixedbread
def __init__(self, client: Mixedbread) -> None:
self._client = client
self.embed = to_raw_response_wrapper(
client.embed,
)
self.info = to_raw_response_wrapper(
client.info,
)
self.rerank = to_raw_response_wrapper(
client.rerank,
)
@cached_property
def stores(self) -> stores.StoresResourceWithRawResponse:
from .resources.stores import StoresResourceWithRawResponse
return StoresResourceWithRawResponse(self._client.stores)
@cached_property
def parsing(self) -> parsing.ParsingResourceWithRawResponse:
from .resources.parsing import ParsingResourceWithRawResponse
return ParsingResourceWithRawResponse(self._client.parsing)
@cached_property
def files(self) -> files.FilesResourceWithRawResponse:
from .resources.files import FilesResourceWithRawResponse
return FilesResourceWithRawResponse(self._client.files)
@cached_property
def extractions(self) -> extractions.ExtractionsResourceWithRawResponse:
from .resources.extractions import ExtractionsResourceWithRawResponse
return ExtractionsResourceWithRawResponse(self._client.extractions)
@cached_property
def embeddings(self) -> embeddings.EmbeddingsResourceWithRawResponse:
from .resources.embeddings import EmbeddingsResourceWithRawResponse
return EmbeddingsResourceWithRawResponse(self._client.embeddings)
@cached_property
def data_sources(self) -> data_sources.DataSourcesResourceWithRawResponse:
from .resources.data_sources import DataSourcesResourceWithRawResponse
return DataSourcesResourceWithRawResponse(self._client.data_sources)
@cached_property
def api_keys(self) -> api_keys.APIKeysResourceWithRawResponse:
from .resources.api_keys import APIKeysResourceWithRawResponse
return APIKeysResourceWithRawResponse(self._client.api_keys)
@cached_property
def chat(self) -> chat.ChatResourceWithRawResponse:
from .resources.chat import ChatResourceWithRawResponse
return ChatResourceWithRawResponse(self._client.chat)
class AsyncMixedbreadWithRawResponse:
_client: AsyncMixedbread
def __init__(self, client: AsyncMixedbread) -> None:
self._client = client
self.embed = async_to_raw_response_wrapper(
client.embed,
)
self.info = async_to_raw_response_wrapper(
client.info,
)
self.rerank = async_to_raw_response_wrapper(
client.rerank,
)
@cached_property
def stores(self) -> stores.AsyncStoresResourceWithRawResponse:
from .resources.stores import AsyncStoresResourceWithRawResponse
return AsyncStoresResourceWithRawResponse(self._client.stores)
@cached_property
def parsing(self) -> parsing.AsyncParsingResourceWithRawResponse:
from .resources.parsing import AsyncParsingResourceWithRawResponse
return AsyncParsingResourceWithRawResponse(self._client.parsing)
@cached_property
def files(self) -> files.AsyncFilesResourceWithRawResponse:
from .resources.files import AsyncFilesResourceWithRawResponse
return AsyncFilesResourceWithRawResponse(self._client.files)
@cached_property
def extractions(self) -> extractions.AsyncExtractionsResourceWithRawResponse:
from .resources.extractions import AsyncExtractionsResourceWithRawResponse
return AsyncExtractionsResourceWithRawResponse(self._client.extractions)
@cached_property
def embeddings(self) -> embeddings.AsyncEmbeddingsResourceWithRawResponse:
from .resources.embeddings import AsyncEmbeddingsResourceWithRawResponse
return AsyncEmbeddingsResourceWithRawResponse(self._client.embeddings)
@cached_property
def data_sources(self) -> data_sources.AsyncDataSourcesResourceWithRawResponse:
from .resources.data_sources import AsyncDataSourcesResourceWithRawResponse
return AsyncDataSourcesResourceWithRawResponse(self._client.data_sources)
@cached_property
def api_keys(self) -> api_keys.AsyncAPIKeysResourceWithRawResponse:
from .resources.api_keys import AsyncAPIKeysResourceWithRawResponse
return AsyncAPIKeysResourceWithRawResponse(self._client.api_keys)