-
Notifications
You must be signed in to change notification settings - Fork 102
Expand file tree
/
Copy path_client.py
More file actions
1472 lines (1120 loc) · 57.2 KB
/
_client.py
File metadata and controls
1472 lines (1120 loc) · 57.2 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
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under the terms described in the LICENSE file in
# the root directory of this source tree.
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
import os
import json
from typing import TYPE_CHECKING, Any, Mapping
from typing_extensions import Self, override
import httpx
from . import _exceptions
from ._qs import Querystring
from ._types import (
Omit,
Timeout,
NotGiven,
Transport,
ProxiesTypes,
RequestOptions,
not_given,
)
from ._utils import is_given, get_async_library
from ._compat import cached_property
from ._version import __version__
from ._streaming import Stream as Stream, AsyncStream as AsyncStream
from ._exceptions import APIStatusError
from ._base_client import (
DEFAULT_MAX_RETRIES,
SyncAPIClient,
AsyncAPIClient,
)
if TYPE_CHECKING:
from .resources import (
beta,
chat,
alpha,
files,
models,
routes,
safety,
batches,
inspect,
prompts,
scoring,
shields,
providers,
responses,
vector_io,
embeddings,
completions,
moderations,
conversations,
vector_stores,
scoring_functions,
)
from .resources.files import FilesResource, AsyncFilesResource
from .resources.routes import RoutesResource, AsyncRoutesResource
from .resources.safety import SafetyResource, AsyncSafetyResource
from .resources.batches import BatchesResource, AsyncBatchesResource
from .resources.inspect import InspectResource, AsyncInspectResource
from .resources.scoring import ScoringResource, AsyncScoringResource
from .resources.shields import ShieldsResource, AsyncShieldsResource
from .resources.beta.beta import BetaResource, AsyncBetaResource
from .resources.chat.chat import ChatResource, AsyncChatResource
from .resources.providers import ProvidersResource, AsyncProvidersResource
from .resources.vector_io import VectorIoResource, AsyncVectorIoResource
from .resources.embeddings import EmbeddingsResource, AsyncEmbeddingsResource
from .resources.alpha.alpha import AlphaResource, AsyncAlphaResource
from .resources.completions import CompletionsResource, AsyncCompletionsResource
from .resources.moderations import ModerationsResource, AsyncModerationsResource
from .resources.models.models import ModelsResource, AsyncModelsResource
from .resources.prompts.prompts import PromptsResource, AsyncPromptsResource
from .resources.scoring_functions import ScoringFunctionsResource, AsyncScoringFunctionsResource
from .resources.responses.responses import ResponsesResource, AsyncResponsesResource
from .resources.conversations.conversations import ConversationsResource, AsyncConversationsResource
from .resources.vector_stores.vector_stores import VectorStoresResource, AsyncVectorStoresResource
__all__ = [
"Timeout",
"Transport",
"ProxiesTypes",
"RequestOptions",
"LlamaStackClient",
"AsyncLlamaStackClient",
"Client",
"AsyncClient",
]
class LlamaStackClient(SyncAPIClient):
# client options
api_key: str | None
def __init__(
self,
*,
api_key: str | None = None,
base_url: str | httpx.URL | None = None,
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,
provider_data: Mapping[str, Any] | None = None,
) -> None:
"""Construct a new synchronous LlamaStackClient client instance.
This automatically infers the `api_key` argument from the `LLAMA_STACK_CLIENT_API_KEY` environment variable if it is not provided.
"""
if api_key is None:
api_key = os.environ.get("LLAMA_STACK_CLIENT_API_KEY")
self.api_key = api_key
if base_url is None:
base_url = os.environ.get("LLAMA_STACK_CLIENT_BASE_URL")
if base_url is None:
base_url = f"http://any-hosted-llama-stack.com"
custom_headers = default_headers or {}
custom_headers["X-LlamaStack-Client-Version"] = __version__
if provider_data is not None:
custom_headers["X-LlamaStack-Provider-Data"] = json.dumps(provider_data)
super().__init__(
version=__version__,
base_url=base_url,
max_retries=max_retries,
timeout=timeout,
http_client=http_client,
custom_headers=custom_headers,
custom_query=default_query,
_strict_response_validation=_strict_response_validation,
)
self._default_stream_cls = Stream
@cached_property
def responses(self) -> ResponsesResource:
from .resources.responses import ResponsesResource
return ResponsesResource(self)
@cached_property
def prompts(self) -> PromptsResource:
"""Protocol for prompt management operations."""
from .resources.prompts import PromptsResource
return PromptsResource(self)
@cached_property
def conversations(self) -> ConversationsResource:
"""Protocol for conversation management operations."""
from .resources.conversations import ConversationsResource
return ConversationsResource(self)
@cached_property
def inspect(self) -> InspectResource:
"""
APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
"""
from .resources.inspect import InspectResource
return InspectResource(self)
@cached_property
def embeddings(self) -> EmbeddingsResource:
"""
Llama Stack Inference API for generating completions, chat completions, and embeddings.
This API provides the raw interface to the underlying models. Three kinds of models are supported:
- LLM models: these models generate "raw" and "chat" (conversational) completions.
- Embedding models: these models generate embeddings to be used for semantic search.
- Rerank models: these models reorder the documents based on their relevance to a query.
"""
from .resources.embeddings import EmbeddingsResource
return EmbeddingsResource(self)
@cached_property
def chat(self) -> ChatResource:
from .resources.chat import ChatResource
return ChatResource(self)
@cached_property
def completions(self) -> CompletionsResource:
"""
Llama Stack Inference API for generating completions, chat completions, and embeddings.
This API provides the raw interface to the underlying models. Three kinds of models are supported:
- LLM models: these models generate "raw" and "chat" (conversational) completions.
- Embedding models: these models generate embeddings to be used for semantic search.
- Rerank models: these models reorder the documents based on their relevance to a query.
"""
from .resources.completions import CompletionsResource
return CompletionsResource(self)
@cached_property
def vector_io(self) -> VectorIoResource:
from .resources.vector_io import VectorIoResource
return VectorIoResource(self)
@cached_property
def vector_stores(self) -> VectorStoresResource:
from .resources.vector_stores import VectorStoresResource
return VectorStoresResource(self)
@cached_property
def models(self) -> ModelsResource:
from .resources.models import ModelsResource
return ModelsResource(self)
@cached_property
def providers(self) -> ProvidersResource:
"""
Providers API for inspecting, listing, and modifying providers and their configurations.
"""
from .resources.providers import ProvidersResource
return ProvidersResource(self)
@cached_property
def routes(self) -> RoutesResource:
"""
APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
"""
from .resources.routes import RoutesResource
return RoutesResource(self)
@cached_property
def moderations(self) -> ModerationsResource:
"""OpenAI-compatible Moderations API."""
from .resources.moderations import ModerationsResource
return ModerationsResource(self)
@cached_property
def safety(self) -> SafetyResource:
"""OpenAI-compatible Moderations API."""
from .resources.safety import SafetyResource
return SafetyResource(self)
@cached_property
def shields(self) -> ShieldsResource:
from .resources.shields import ShieldsResource
return ShieldsResource(self)
@cached_property
def scoring(self) -> ScoringResource:
from .resources.scoring import ScoringResource
return ScoringResource(self)
@cached_property
def scoring_functions(self) -> ScoringFunctionsResource:
from .resources.scoring_functions import ScoringFunctionsResource
return ScoringFunctionsResource(self)
@cached_property
def files(self) -> FilesResource:
"""
This API is used to upload documents that can be used with other Llama Stack APIs.
"""
from .resources.files import FilesResource
return FilesResource(self)
@cached_property
def batches(self) -> BatchesResource:
"""
The API is designed to allow use of openai client libraries for seamless integration.
This API provides the following extensions:
- idempotent batch creation
Note: This API is currently under active development and may undergo changes.
"""
from .resources.batches import BatchesResource
return BatchesResource(self)
@cached_property
def alpha(self) -> AlphaResource:
from .resources.alpha import AlphaResource
return AlphaResource(self)
@cached_property
def beta(self) -> BetaResource:
from .resources.beta import BetaResource
return BetaResource(self)
@cached_property
def with_raw_response(self) -> LlamaStackClientWithRawResponse:
return LlamaStackClientWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> LlamaStackClientWithStreamedResponse:
return LlamaStackClientWithStreamedResponse(self)
@property
@override
def qs(self) -> Querystring:
return Querystring(array_format="comma")
@property
@override
def auth_headers(self) -> dict[str, str]:
api_key = self.api_key
if api_key is None:
return {}
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,
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,
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
@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 AsyncLlamaStackClient(AsyncAPIClient):
# client options
api_key: str | None
def __init__(
self,
*,
api_key: str | None = None,
base_url: str | httpx.URL | None = None,
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,
provider_data: Mapping[str, Any] | None = None,
) -> None:
"""Construct a new async AsyncLlamaStackClient client instance.
This automatically infers the `api_key` argument from the `LLAMA_STACK_CLIENT_API_KEY` environment variable if it is not provided.
"""
if api_key is None:
api_key = os.environ.get("LLAMA_STACK_CLIENT_API_KEY")
self.api_key = api_key
if base_url is None:
base_url = os.environ.get("LLAMA_STACK_CLIENT_BASE_URL")
if base_url is None:
base_url = f"http://any-hosted-llama-stack.com"
custom_headers = default_headers or {}
custom_headers["X-LlamaStack-Client-Version"] = __version__
if provider_data is not None:
custom_headers["X-LlamaStack-Provider-Data"] = json.dumps(provider_data)
super().__init__(
version=__version__,
base_url=base_url,
max_retries=max_retries,
timeout=timeout,
http_client=http_client,
custom_headers=custom_headers,
custom_query=default_query,
_strict_response_validation=_strict_response_validation,
)
self._default_stream_cls = AsyncStream
@cached_property
def responses(self) -> AsyncResponsesResource:
from .resources.responses import AsyncResponsesResource
return AsyncResponsesResource(self)
@cached_property
def prompts(self) -> AsyncPromptsResource:
"""Protocol for prompt management operations."""
from .resources.prompts import AsyncPromptsResource
return AsyncPromptsResource(self)
@cached_property
def conversations(self) -> AsyncConversationsResource:
"""Protocol for conversation management operations."""
from .resources.conversations import AsyncConversationsResource
return AsyncConversationsResource(self)
@cached_property
def inspect(self) -> AsyncInspectResource:
"""
APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
"""
from .resources.inspect import AsyncInspectResource
return AsyncInspectResource(self)
@cached_property
def embeddings(self) -> AsyncEmbeddingsResource:
"""
Llama Stack Inference API for generating completions, chat completions, and embeddings.
This API provides the raw interface to the underlying models. Three kinds of models are supported:
- LLM models: these models generate "raw" and "chat" (conversational) completions.
- Embedding models: these models generate embeddings to be used for semantic search.
- Rerank models: these models reorder the documents based on their relevance to a query.
"""
from .resources.embeddings import AsyncEmbeddingsResource
return AsyncEmbeddingsResource(self)
@cached_property
def chat(self) -> AsyncChatResource:
from .resources.chat import AsyncChatResource
return AsyncChatResource(self)
@cached_property
def completions(self) -> AsyncCompletionsResource:
"""
Llama Stack Inference API for generating completions, chat completions, and embeddings.
This API provides the raw interface to the underlying models. Three kinds of models are supported:
- LLM models: these models generate "raw" and "chat" (conversational) completions.
- Embedding models: these models generate embeddings to be used for semantic search.
- Rerank models: these models reorder the documents based on their relevance to a query.
"""
from .resources.completions import AsyncCompletionsResource
return AsyncCompletionsResource(self)
@cached_property
def vector_io(self) -> AsyncVectorIoResource:
from .resources.vector_io import AsyncVectorIoResource
return AsyncVectorIoResource(self)
@cached_property
def vector_stores(self) -> AsyncVectorStoresResource:
from .resources.vector_stores import AsyncVectorStoresResource
return AsyncVectorStoresResource(self)
@cached_property
def models(self) -> AsyncModelsResource:
from .resources.models import AsyncModelsResource
return AsyncModelsResource(self)
@cached_property
def providers(self) -> AsyncProvidersResource:
"""
Providers API for inspecting, listing, and modifying providers and their configurations.
"""
from .resources.providers import AsyncProvidersResource
return AsyncProvidersResource(self)
@cached_property
def routes(self) -> AsyncRoutesResource:
"""
APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
"""
from .resources.routes import AsyncRoutesResource
return AsyncRoutesResource(self)
@cached_property
def moderations(self) -> AsyncModerationsResource:
"""OpenAI-compatible Moderations API."""
from .resources.moderations import AsyncModerationsResource
return AsyncModerationsResource(self)
@cached_property
def safety(self) -> AsyncSafetyResource:
"""OpenAI-compatible Moderations API."""
from .resources.safety import AsyncSafetyResource
return AsyncSafetyResource(self)
@cached_property
def shields(self) -> AsyncShieldsResource:
from .resources.shields import AsyncShieldsResource
return AsyncShieldsResource(self)
@cached_property
def scoring(self) -> AsyncScoringResource:
from .resources.scoring import AsyncScoringResource
return AsyncScoringResource(self)
@cached_property
def scoring_functions(self) -> AsyncScoringFunctionsResource:
from .resources.scoring_functions import AsyncScoringFunctionsResource
return AsyncScoringFunctionsResource(self)
@cached_property
def files(self) -> AsyncFilesResource:
"""
This API is used to upload documents that can be used with other Llama Stack APIs.
"""
from .resources.files import AsyncFilesResource
return AsyncFilesResource(self)
@cached_property
def batches(self) -> AsyncBatchesResource:
"""
The API is designed to allow use of openai client libraries for seamless integration.
This API provides the following extensions:
- idempotent batch creation
Note: This API is currently under active development and may undergo changes.
"""
from .resources.batches import AsyncBatchesResource
return AsyncBatchesResource(self)
@cached_property
def alpha(self) -> AsyncAlphaResource:
from .resources.alpha import AsyncAlphaResource
return AsyncAlphaResource(self)
@cached_property
def beta(self) -> AsyncBetaResource:
from .resources.beta import AsyncBetaResource
return AsyncBetaResource(self)
@cached_property
def with_raw_response(self) -> AsyncLlamaStackClientWithRawResponse:
return AsyncLlamaStackClientWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncLlamaStackClientWithStreamedResponse:
return AsyncLlamaStackClientWithStreamedResponse(self)
@property
@override
def qs(self) -> Querystring:
return Querystring(array_format="comma")
@property
@override
def auth_headers(self) -> dict[str, str]:
api_key = self.api_key
if api_key is None:
return {}
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,
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,
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
@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 LlamaStackClientWithRawResponse:
_client: LlamaStackClient
def __init__(self, client: LlamaStackClient) -> None:
self._client = client
@cached_property
def responses(self) -> responses.ResponsesResourceWithRawResponse:
from .resources.responses import ResponsesResourceWithRawResponse
return ResponsesResourceWithRawResponse(self._client.responses)
@cached_property
def prompts(self) -> prompts.PromptsResourceWithRawResponse:
"""Protocol for prompt management operations."""
from .resources.prompts import PromptsResourceWithRawResponse
return PromptsResourceWithRawResponse(self._client.prompts)
@cached_property
def conversations(self) -> conversations.ConversationsResourceWithRawResponse:
"""Protocol for conversation management operations."""
from .resources.conversations import ConversationsResourceWithRawResponse
return ConversationsResourceWithRawResponse(self._client.conversations)
@cached_property
def inspect(self) -> inspect.InspectResourceWithRawResponse:
"""
APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
"""
from .resources.inspect import InspectResourceWithRawResponse
return InspectResourceWithRawResponse(self._client.inspect)
@cached_property
def embeddings(self) -> embeddings.EmbeddingsResourceWithRawResponse:
"""
Llama Stack Inference API for generating completions, chat completions, and embeddings.
This API provides the raw interface to the underlying models. Three kinds of models are supported:
- LLM models: these models generate "raw" and "chat" (conversational) completions.
- Embedding models: these models generate embeddings to be used for semantic search.
- Rerank models: these models reorder the documents based on their relevance to a query.
"""
from .resources.embeddings import EmbeddingsResourceWithRawResponse
return EmbeddingsResourceWithRawResponse(self._client.embeddings)
@cached_property
def chat(self) -> chat.ChatResourceWithRawResponse:
from .resources.chat import ChatResourceWithRawResponse
return ChatResourceWithRawResponse(self._client.chat)
@cached_property
def completions(self) -> completions.CompletionsResourceWithRawResponse:
"""
Llama Stack Inference API for generating completions, chat completions, and embeddings.
This API provides the raw interface to the underlying models. Three kinds of models are supported:
- LLM models: these models generate "raw" and "chat" (conversational) completions.
- Embedding models: these models generate embeddings to be used for semantic search.
- Rerank models: these models reorder the documents based on their relevance to a query.
"""
from .resources.completions import CompletionsResourceWithRawResponse
return CompletionsResourceWithRawResponse(self._client.completions)
@cached_property
def vector_io(self) -> vector_io.VectorIoResourceWithRawResponse:
from .resources.vector_io import VectorIoResourceWithRawResponse
return VectorIoResourceWithRawResponse(self._client.vector_io)
@cached_property
def vector_stores(self) -> vector_stores.VectorStoresResourceWithRawResponse:
from .resources.vector_stores import VectorStoresResourceWithRawResponse
return VectorStoresResourceWithRawResponse(self._client.vector_stores)
@cached_property
def models(self) -> models.ModelsResourceWithRawResponse:
from .resources.models import ModelsResourceWithRawResponse
return ModelsResourceWithRawResponse(self._client.models)
@cached_property
def providers(self) -> providers.ProvidersResourceWithRawResponse:
"""
Providers API for inspecting, listing, and modifying providers and their configurations.
"""
from .resources.providers import ProvidersResourceWithRawResponse
return ProvidersResourceWithRawResponse(self._client.providers)
@cached_property
def routes(self) -> routes.RoutesResourceWithRawResponse:
"""
APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
"""
from .resources.routes import RoutesResourceWithRawResponse
return RoutesResourceWithRawResponse(self._client.routes)
@cached_property
def moderations(self) -> moderations.ModerationsResourceWithRawResponse:
"""OpenAI-compatible Moderations API."""
from .resources.moderations import ModerationsResourceWithRawResponse
return ModerationsResourceWithRawResponse(self._client.moderations)
@cached_property
def safety(self) -> safety.SafetyResourceWithRawResponse:
"""OpenAI-compatible Moderations API."""
from .resources.safety import SafetyResourceWithRawResponse
return SafetyResourceWithRawResponse(self._client.safety)
@cached_property
def shields(self) -> shields.ShieldsResourceWithRawResponse:
from .resources.shields import ShieldsResourceWithRawResponse
return ShieldsResourceWithRawResponse(self._client.shields)
@cached_property
def scoring(self) -> scoring.ScoringResourceWithRawResponse:
from .resources.scoring import ScoringResourceWithRawResponse
return ScoringResourceWithRawResponse(self._client.scoring)
@cached_property
def scoring_functions(self) -> scoring_functions.ScoringFunctionsResourceWithRawResponse:
from .resources.scoring_functions import ScoringFunctionsResourceWithRawResponse
return ScoringFunctionsResourceWithRawResponse(self._client.scoring_functions)
@cached_property
def files(self) -> files.FilesResourceWithRawResponse:
"""
This API is used to upload documents that can be used with other Llama Stack APIs.
"""
from .resources.files import FilesResourceWithRawResponse
return FilesResourceWithRawResponse(self._client.files)
@cached_property
def batches(self) -> batches.BatchesResourceWithRawResponse:
"""
The API is designed to allow use of openai client libraries for seamless integration.
This API provides the following extensions:
- idempotent batch creation
Note: This API is currently under active development and may undergo changes.
"""
from .resources.batches import BatchesResourceWithRawResponse
return BatchesResourceWithRawResponse(self._client.batches)
@cached_property
def alpha(self) -> alpha.AlphaResourceWithRawResponse:
from .resources.alpha import AlphaResourceWithRawResponse
return AlphaResourceWithRawResponse(self._client.alpha)
@cached_property
def beta(self) -> beta.BetaResourceWithRawResponse:
from .resources.beta import BetaResourceWithRawResponse
return BetaResourceWithRawResponse(self._client.beta)
class AsyncLlamaStackClientWithRawResponse:
_client: AsyncLlamaStackClient
def __init__(self, client: AsyncLlamaStackClient) -> None:
self._client = client
@cached_property
def responses(self) -> responses.AsyncResponsesResourceWithRawResponse:
from .resources.responses import AsyncResponsesResourceWithRawResponse
return AsyncResponsesResourceWithRawResponse(self._client.responses)
@cached_property
def prompts(self) -> prompts.AsyncPromptsResourceWithRawResponse:
"""Protocol for prompt management operations."""
from .resources.prompts import AsyncPromptsResourceWithRawResponse
return AsyncPromptsResourceWithRawResponse(self._client.prompts)
@cached_property
def conversations(self) -> conversations.AsyncConversationsResourceWithRawResponse:
"""Protocol for conversation management operations."""
from .resources.conversations import AsyncConversationsResourceWithRawResponse
return AsyncConversationsResourceWithRawResponse(self._client.conversations)
@cached_property
def inspect(self) -> inspect.AsyncInspectResourceWithRawResponse:
"""
APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
"""
from .resources.inspect import AsyncInspectResourceWithRawResponse
return AsyncInspectResourceWithRawResponse(self._client.inspect)
@cached_property
def embeddings(self) -> embeddings.AsyncEmbeddingsResourceWithRawResponse:
"""
Llama Stack Inference API for generating completions, chat completions, and embeddings.
This API provides the raw interface to the underlying models. Three kinds of models are supported:
- LLM models: these models generate "raw" and "chat" (conversational) completions.
- Embedding models: these models generate embeddings to be used for semantic search.
- Rerank models: these models reorder the documents based on their relevance to a query.
"""
from .resources.embeddings import AsyncEmbeddingsResourceWithRawResponse
return AsyncEmbeddingsResourceWithRawResponse(self._client.embeddings)
@cached_property