orq-ai-sdk 4.2.0rc28__py3-none-any.whl → 4.2.6__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. orq_ai_sdk/_hooks/globalhook.py +0 -1
  2. orq_ai_sdk/_version.py +3 -3
  3. orq_ai_sdk/audio.py +30 -0
  4. orq_ai_sdk/basesdk.py +20 -6
  5. orq_ai_sdk/chat.py +22 -0
  6. orq_ai_sdk/completions.py +332 -0
  7. orq_ai_sdk/contacts.py +43 -855
  8. orq_ai_sdk/deployments.py +61 -0
  9. orq_ai_sdk/edits.py +258 -0
  10. orq_ai_sdk/embeddings.py +238 -0
  11. orq_ai_sdk/generations.py +272 -0
  12. orq_ai_sdk/identities.py +1037 -0
  13. orq_ai_sdk/images.py +28 -0
  14. orq_ai_sdk/models/__init__.py +5341 -737
  15. orq_ai_sdk/models/actionreviewedstreamingevent.py +18 -1
  16. orq_ai_sdk/models/actionreviewrequestedstreamingevent.py +44 -1
  17. orq_ai_sdk/models/agenterroredstreamingevent.py +18 -1
  18. orq_ai_sdk/models/agentinactivestreamingevent.py +168 -70
  19. orq_ai_sdk/models/agentmessagecreatedstreamingevent.py +18 -2
  20. orq_ai_sdk/models/agentresponsemessage.py +18 -2
  21. orq_ai_sdk/models/agentstartedstreamingevent.py +127 -2
  22. orq_ai_sdk/models/agentthoughtstreamingevent.py +178 -211
  23. orq_ai_sdk/models/conversationresponse.py +31 -20
  24. orq_ai_sdk/models/conversationwithmessagesresponse.py +31 -20
  25. orq_ai_sdk/models/createagentrequestop.py +1922 -384
  26. orq_ai_sdk/models/createagentresponse.py +147 -91
  27. orq_ai_sdk/models/createagentresponserequestop.py +111 -2
  28. orq_ai_sdk/models/createchatcompletionop.py +1375 -861
  29. orq_ai_sdk/models/createchunkop.py +46 -19
  30. orq_ai_sdk/models/createcompletionop.py +1890 -0
  31. orq_ai_sdk/models/createcontactop.py +45 -56
  32. orq_ai_sdk/models/createconversationop.py +61 -39
  33. orq_ai_sdk/models/createconversationresponseop.py +68 -4
  34. orq_ai_sdk/models/createdatasetitemop.py +424 -80
  35. orq_ai_sdk/models/createdatasetop.py +19 -2
  36. orq_ai_sdk/models/createdatasourceop.py +92 -26
  37. orq_ai_sdk/models/createembeddingop.py +384 -0
  38. orq_ai_sdk/models/createevalop.py +552 -24
  39. orq_ai_sdk/models/createidentityop.py +176 -0
  40. orq_ai_sdk/models/createimageeditop.py +504 -0
  41. orq_ai_sdk/models/createimageop.py +208 -117
  42. orq_ai_sdk/models/createimagevariationop.py +486 -0
  43. orq_ai_sdk/models/createknowledgeop.py +186 -121
  44. orq_ai_sdk/models/creatememorydocumentop.py +50 -1
  45. orq_ai_sdk/models/creatememoryop.py +34 -21
  46. orq_ai_sdk/models/creatememorystoreop.py +34 -1
  47. orq_ai_sdk/models/createmoderationop.py +521 -0
  48. orq_ai_sdk/models/createpromptop.py +2748 -1252
  49. orq_ai_sdk/models/creatererankop.py +416 -0
  50. orq_ai_sdk/models/createresponseop.py +2567 -0
  51. orq_ai_sdk/models/createspeechop.py +316 -0
  52. orq_ai_sdk/models/createtoolop.py +537 -12
  53. orq_ai_sdk/models/createtranscriptionop.py +562 -0
  54. orq_ai_sdk/models/createtranslationop.py +540 -0
  55. orq_ai_sdk/models/datapart.py +18 -1
  56. orq_ai_sdk/models/deletechunksop.py +34 -1
  57. orq_ai_sdk/models/{deletecontactop.py → deleteidentityop.py} +9 -9
  58. orq_ai_sdk/models/deletepromptop.py +26 -0
  59. orq_ai_sdk/models/deploymentcreatemetricop.py +362 -76
  60. orq_ai_sdk/models/deploymentgetconfigop.py +635 -194
  61. orq_ai_sdk/models/deploymentinvokeop.py +168 -173
  62. orq_ai_sdk/models/deploymentsop.py +195 -58
  63. orq_ai_sdk/models/deploymentstreamop.py +652 -304
  64. orq_ai_sdk/models/errorpart.py +18 -1
  65. orq_ai_sdk/models/filecontentpartschema.py +18 -1
  66. orq_ai_sdk/models/filegetop.py +19 -2
  67. orq_ai_sdk/models/filelistop.py +35 -2
  68. orq_ai_sdk/models/filepart.py +50 -1
  69. orq_ai_sdk/models/fileuploadop.py +51 -2
  70. orq_ai_sdk/models/generateconversationnameop.py +31 -20
  71. orq_ai_sdk/models/get_v2_evaluators_id_versionsop.py +34 -1
  72. orq_ai_sdk/models/get_v2_tools_tool_id_versions_version_id_op.py +18 -1
  73. orq_ai_sdk/models/get_v2_tools_tool_id_versionsop.py +34 -1
  74. orq_ai_sdk/models/getallmemoriesop.py +34 -21
  75. orq_ai_sdk/models/getallmemorydocumentsop.py +42 -1
  76. orq_ai_sdk/models/getallmemorystoresop.py +34 -1
  77. orq_ai_sdk/models/getallpromptsop.py +1690 -230
  78. orq_ai_sdk/models/getalltoolsop.py +325 -8
  79. orq_ai_sdk/models/getchunkscountop.py +34 -1
  80. orq_ai_sdk/models/getevalsop.py +395 -43
  81. orq_ai_sdk/models/getonechunkop.py +14 -19
  82. orq_ai_sdk/models/getoneknowledgeop.py +116 -96
  83. orq_ai_sdk/models/getonepromptop.py +1673 -230
  84. orq_ai_sdk/models/getpromptversionop.py +1670 -216
  85. orq_ai_sdk/models/imagecontentpartschema.py +50 -1
  86. orq_ai_sdk/models/internal/globals.py +18 -1
  87. orq_ai_sdk/models/invokeagentop.py +140 -2
  88. orq_ai_sdk/models/invokedeploymentrequest.py +418 -80
  89. orq_ai_sdk/models/invokeevalop.py +160 -131
  90. orq_ai_sdk/models/listagentsop.py +793 -166
  91. orq_ai_sdk/models/listchunksop.py +32 -19
  92. orq_ai_sdk/models/listchunkspaginatedop.py +46 -19
  93. orq_ai_sdk/models/listconversationsop.py +18 -1
  94. orq_ai_sdk/models/listdatasetdatapointsop.py +252 -42
  95. orq_ai_sdk/models/listdatasetsop.py +35 -2
  96. orq_ai_sdk/models/listdatasourcesop.py +35 -26
  97. orq_ai_sdk/models/{listcontactsop.py → listidentitiesop.py} +89 -79
  98. orq_ai_sdk/models/listknowledgebasesop.py +132 -96
  99. orq_ai_sdk/models/listmodelsop.py +1 -0
  100. orq_ai_sdk/models/listpromptversionsop.py +1684 -216
  101. orq_ai_sdk/models/parseop.py +161 -17
  102. orq_ai_sdk/models/partdoneevent.py +19 -2
  103. orq_ai_sdk/models/post_v2_router_ocrop.py +408 -0
  104. orq_ai_sdk/models/publiccontact.py +27 -4
  105. orq_ai_sdk/models/publicidentity.py +62 -0
  106. orq_ai_sdk/models/reasoningpart.py +19 -2
  107. orq_ai_sdk/models/refusalpartschema.py +18 -1
  108. orq_ai_sdk/models/remoteconfigsgetconfigop.py +34 -1
  109. orq_ai_sdk/models/responsedoneevent.py +114 -84
  110. orq_ai_sdk/models/responsestartedevent.py +18 -1
  111. orq_ai_sdk/models/retrieveagentrequestop.py +787 -166
  112. orq_ai_sdk/models/retrievedatapointop.py +236 -42
  113. orq_ai_sdk/models/retrievedatasetop.py +19 -2
  114. orq_ai_sdk/models/retrievedatasourceop.py +17 -26
  115. orq_ai_sdk/models/{retrievecontactop.py → retrieveidentityop.py} +38 -41
  116. orq_ai_sdk/models/retrievememorydocumentop.py +18 -1
  117. orq_ai_sdk/models/retrievememoryop.py +18 -21
  118. orq_ai_sdk/models/retrievememorystoreop.py +18 -1
  119. orq_ai_sdk/models/retrievetoolop.py +309 -8
  120. orq_ai_sdk/models/runagentop.py +1451 -197
  121. orq_ai_sdk/models/searchknowledgeop.py +108 -1
  122. orq_ai_sdk/models/security.py +18 -1
  123. orq_ai_sdk/models/streamagentop.py +93 -2
  124. orq_ai_sdk/models/streamrunagentop.py +1428 -195
  125. orq_ai_sdk/models/textcontentpartschema.py +34 -1
  126. orq_ai_sdk/models/thinkingconfigenabledschema.py +18 -1
  127. orq_ai_sdk/models/toolcallpart.py +18 -1
  128. orq_ai_sdk/models/tooldoneevent.py +18 -1
  129. orq_ai_sdk/models/toolexecutionfailedstreamingevent.py +50 -1
  130. orq_ai_sdk/models/toolexecutionfinishedstreamingevent.py +34 -1
  131. orq_ai_sdk/models/toolexecutionstartedstreamingevent.py +34 -1
  132. orq_ai_sdk/models/toolresultpart.py +18 -1
  133. orq_ai_sdk/models/toolreviewrequestedevent.py +18 -1
  134. orq_ai_sdk/models/toolstartedevent.py +18 -1
  135. orq_ai_sdk/models/updateagentop.py +1951 -404
  136. orq_ai_sdk/models/updatechunkop.py +46 -19
  137. orq_ai_sdk/models/updateconversationop.py +61 -39
  138. orq_ai_sdk/models/updatedatapointop.py +424 -80
  139. orq_ai_sdk/models/updatedatasetop.py +51 -2
  140. orq_ai_sdk/models/updatedatasourceop.py +17 -26
  141. orq_ai_sdk/models/updateevalop.py +577 -16
  142. orq_ai_sdk/models/{updatecontactop.py → updateidentityop.py} +78 -68
  143. orq_ai_sdk/models/updateknowledgeop.py +234 -190
  144. orq_ai_sdk/models/updatememorydocumentop.py +50 -1
  145. orq_ai_sdk/models/updatememoryop.py +50 -21
  146. orq_ai_sdk/models/updatememorystoreop.py +66 -1
  147. orq_ai_sdk/models/updatepromptop.py +2844 -1450
  148. orq_ai_sdk/models/updatetoolop.py +592 -9
  149. orq_ai_sdk/models/usermessagerequest.py +18 -2
  150. orq_ai_sdk/moderations.py +218 -0
  151. orq_ai_sdk/orq_completions.py +660 -0
  152. orq_ai_sdk/orq_responses.py +398 -0
  153. orq_ai_sdk/prompts.py +28 -36
  154. orq_ai_sdk/rerank.py +232 -0
  155. orq_ai_sdk/router.py +89 -641
  156. orq_ai_sdk/sdk.py +3 -0
  157. orq_ai_sdk/speech.py +251 -0
  158. orq_ai_sdk/transcriptions.py +326 -0
  159. orq_ai_sdk/translations.py +298 -0
  160. orq_ai_sdk/utils/__init__.py +13 -1
  161. orq_ai_sdk/variations.py +254 -0
  162. orq_ai_sdk-4.2.6.dist-info/METADATA +888 -0
  163. orq_ai_sdk-4.2.6.dist-info/RECORD +263 -0
  164. {orq_ai_sdk-4.2.0rc28.dist-info → orq_ai_sdk-4.2.6.dist-info}/WHEEL +2 -1
  165. orq_ai_sdk-4.2.6.dist-info/top_level.txt +1 -0
  166. orq_ai_sdk-4.2.0rc28.dist-info/METADATA +0 -867
  167. orq_ai_sdk-4.2.0rc28.dist-info/RECORD +0 -233
@@ -53,6 +53,22 @@ class GetOneKnowledgeResponseBodyKnowledgeRerankConfig(BaseModel):
53
53
  rerank_threshold: Optional[float] = 0.5
54
54
  r"""The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned"""
55
55
 
56
+ @model_serializer(mode="wrap")
57
+ def serialize_model(self, handler):
58
+ optional_fields = set(["top_k", "rerank_threshold"])
59
+ serialized = handler(self)
60
+ m = {}
61
+
62
+ for n, f in type(self).model_fields.items():
63
+ k = f.alias or n
64
+ val = serialized.get(k)
65
+
66
+ if val != UNSET_SENTINEL:
67
+ if val is not None or k not in optional_fields:
68
+ m[k] = val
69
+
70
+ return m
71
+
56
72
 
57
73
  class GetOneKnowledgeResponseBodyKnowledgeAgenticRagConfigTypedDict(TypedDict):
58
74
  r"""The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled."""
@@ -106,31 +122,28 @@ class GetOneKnowledgeResponseBodyKnowledgeRetrievalSettings(BaseModel):
106
122
 
107
123
  @model_serializer(mode="wrap")
108
124
  def serialize_model(self, handler):
109
- optional_fields = ["top_k", "threshold", "rerank_config", "agentic_rag_config"]
110
- nullable_fields = ["rerank_config", "agentic_rag_config"]
111
- null_default_fields = []
112
-
125
+ optional_fields = set(
126
+ ["top_k", "threshold", "rerank_config", "agentic_rag_config"]
127
+ )
128
+ nullable_fields = set(["rerank_config", "agentic_rag_config"])
113
129
  serialized = handler(self)
114
-
115
130
  m = {}
116
131
 
117
132
  for n, f in type(self).model_fields.items():
118
133
  k = f.alias or n
119
134
  val = serialized.get(k)
120
- serialized.pop(k, None)
121
-
122
- optional_nullable = k in optional_fields and k in nullable_fields
123
- is_set = (
124
- self.__pydantic_fields_set__.intersection({n})
125
- or k in null_default_fields
126
- ) # pylint: disable=no-member
127
-
128
- if val is not None and val != UNSET_SENTINEL:
129
- m[k] = val
130
- elif val != UNSET_SENTINEL and (
131
- not k in optional_fields or (optional_nullable and is_set)
132
- ):
133
- m[k] = val
135
+ is_nullable_and_explicitly_set = (
136
+ k in nullable_fields
137
+ and (self.__pydantic_fields_set__.intersection({n})) # pylint: disable=no-member
138
+ )
139
+
140
+ if val != UNSET_SENTINEL:
141
+ if (
142
+ val is not None
143
+ or k not in optional_fields
144
+ or is_nullable_and_explicitly_set
145
+ ):
146
+ m[k] = val
134
147
 
135
148
  return m
136
149
 
@@ -222,38 +235,35 @@ class GetOneKnowledgeResponseBody2(BaseModel):
222
235
 
223
236
  @model_serializer(mode="wrap")
224
237
  def serialize_model(self, handler):
225
- optional_fields = [
226
- "description",
227
- "path",
228
- "created_by_id",
229
- "updated_by_id",
230
- "type",
231
- "retrieval_settings",
232
- ]
233
- nullable_fields = ["created_by_id", "updated_by_id"]
234
- null_default_fields = []
235
-
238
+ optional_fields = set(
239
+ [
240
+ "description",
241
+ "path",
242
+ "created_by_id",
243
+ "updated_by_id",
244
+ "type",
245
+ "retrieval_settings",
246
+ ]
247
+ )
248
+ nullable_fields = set(["created_by_id", "updated_by_id"])
236
249
  serialized = handler(self)
237
-
238
250
  m = {}
239
251
 
240
252
  for n, f in type(self).model_fields.items():
241
253
  k = f.alias or n
242
254
  val = serialized.get(k)
243
- serialized.pop(k, None)
244
-
245
- optional_nullable = k in optional_fields and k in nullable_fields
246
- is_set = (
247
- self.__pydantic_fields_set__.intersection({n})
248
- or k in null_default_fields
249
- ) # pylint: disable=no-member
250
-
251
- if val is not None and val != UNSET_SENTINEL:
252
- m[k] = val
253
- elif val != UNSET_SENTINEL and (
254
- not k in optional_fields or (optional_nullable and is_set)
255
- ):
256
- m[k] = val
255
+ is_nullable_and_explicitly_set = (
256
+ k in nullable_fields
257
+ and (self.__pydantic_fields_set__.intersection({n})) # pylint: disable=no-member
258
+ )
259
+
260
+ if val != UNSET_SENTINEL:
261
+ if (
262
+ val is not None
263
+ or k not in optional_fields
264
+ or is_nullable_and_explicitly_set
265
+ ):
266
+ m[k] = val
257
267
 
258
268
  return m
259
269
 
@@ -292,6 +302,22 @@ class GetOneKnowledgeResponseBodyRerankConfig(BaseModel):
292
302
  rerank_threshold: Optional[float] = 0.5
293
303
  r"""The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned"""
294
304
 
305
+ @model_serializer(mode="wrap")
306
+ def serialize_model(self, handler):
307
+ optional_fields = set(["top_k", "rerank_threshold"])
308
+ serialized = handler(self)
309
+ m = {}
310
+
311
+ for n, f in type(self).model_fields.items():
312
+ k = f.alias or n
313
+ val = serialized.get(k)
314
+
315
+ if val != UNSET_SENTINEL:
316
+ if val is not None or k not in optional_fields:
317
+ m[k] = val
318
+
319
+ return m
320
+
295
321
 
296
322
  class GetOneKnowledgeResponseBodyAgenticRagConfigTypedDict(TypedDict):
297
323
  r"""The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled."""
@@ -348,37 +374,34 @@ class GetOneKnowledgeResponseBodyRetrievalSettings(BaseModel):
348
374
 
349
375
  @model_serializer(mode="wrap")
350
376
  def serialize_model(self, handler):
351
- optional_fields = [
352
- "retrieval_type",
353
- "top_k",
354
- "threshold",
355
- "rerank_config",
356
- "agentic_rag_config",
357
- ]
358
- nullable_fields = ["rerank_config", "agentic_rag_config"]
359
- null_default_fields = []
360
-
377
+ optional_fields = set(
378
+ [
379
+ "retrieval_type",
380
+ "top_k",
381
+ "threshold",
382
+ "rerank_config",
383
+ "agentic_rag_config",
384
+ ]
385
+ )
386
+ nullable_fields = set(["rerank_config", "agentic_rag_config"])
361
387
  serialized = handler(self)
362
-
363
388
  m = {}
364
389
 
365
390
  for n, f in type(self).model_fields.items():
366
391
  k = f.alias or n
367
392
  val = serialized.get(k)
368
- serialized.pop(k, None)
369
-
370
- optional_nullable = k in optional_fields and k in nullable_fields
371
- is_set = (
372
- self.__pydantic_fields_set__.intersection({n})
373
- or k in null_default_fields
374
- ) # pylint: disable=no-member
375
-
376
- if val is not None and val != UNSET_SENTINEL:
377
- m[k] = val
378
- elif val != UNSET_SENTINEL and (
379
- not k in optional_fields or (optional_nullable and is_set)
380
- ):
381
- m[k] = val
393
+ is_nullable_and_explicitly_set = (
394
+ k in nullable_fields
395
+ and (self.__pydantic_fields_set__.intersection({n})) # pylint: disable=no-member
396
+ )
397
+
398
+ if val != UNSET_SENTINEL:
399
+ if (
400
+ val is not None
401
+ or k not in optional_fields
402
+ or is_nullable_and_explicitly_set
403
+ ):
404
+ m[k] = val
382
405
 
383
406
  return m
384
407
 
@@ -455,38 +478,35 @@ class GetOneKnowledgeResponseBody1(BaseModel):
455
478
 
456
479
  @model_serializer(mode="wrap")
457
480
  def serialize_model(self, handler):
458
- optional_fields = [
459
- "description",
460
- "path",
461
- "created_by_id",
462
- "updated_by_id",
463
- "type",
464
- "retrieval_settings",
465
- ]
466
- nullable_fields = ["created_by_id", "updated_by_id"]
467
- null_default_fields = []
468
-
481
+ optional_fields = set(
482
+ [
483
+ "description",
484
+ "path",
485
+ "created_by_id",
486
+ "updated_by_id",
487
+ "type",
488
+ "retrieval_settings",
489
+ ]
490
+ )
491
+ nullable_fields = set(["created_by_id", "updated_by_id"])
469
492
  serialized = handler(self)
470
-
471
493
  m = {}
472
494
 
473
495
  for n, f in type(self).model_fields.items():
474
496
  k = f.alias or n
475
497
  val = serialized.get(k)
476
- serialized.pop(k, None)
477
-
478
- optional_nullable = k in optional_fields and k in nullable_fields
479
- is_set = (
480
- self.__pydantic_fields_set__.intersection({n})
481
- or k in null_default_fields
482
- ) # pylint: disable=no-member
483
-
484
- if val is not None and val != UNSET_SENTINEL:
485
- m[k] = val
486
- elif val != UNSET_SENTINEL and (
487
- not k in optional_fields or (optional_nullable and is_set)
488
- ):
489
- m[k] = val
498
+ is_nullable_and_explicitly_set = (
499
+ k in nullable_fields
500
+ and (self.__pydantic_fields_set__.intersection({n})) # pylint: disable=no-member
501
+ )
502
+
503
+ if val != UNSET_SENTINEL:
504
+ if (
505
+ val is not None
506
+ or k not in optional_fields
507
+ or is_nullable_and_explicitly_set
508
+ ):
509
+ m[k] = val
490
510
 
491
511
  return m
492
512