orq-ai-sdk 4.2.16__py3-none-any.whl → 4.3.0rc0__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.
- orq_ai_sdk/_hooks/globalhook.py +1 -0
- orq_ai_sdk/_version.py +3 -3
- orq_ai_sdk/agents.py +186 -186
- orq_ai_sdk/completions.py +1 -107
- orq_ai_sdk/edits.py +1 -107
- orq_ai_sdk/embeddings.py +1 -107
- orq_ai_sdk/generations.py +1 -99
- orq_ai_sdk/models/__init__.py +0 -405
- orq_ai_sdk/models/conversationresponse.py +1 -1
- orq_ai_sdk/models/conversationwithmessagesresponse.py +1 -1
- orq_ai_sdk/models/createagentrequestop.py +0 -24
- orq_ai_sdk/models/createchatcompletionop.py +0 -6
- orq_ai_sdk/models/createcompletionop.py +30 -218
- orq_ai_sdk/models/createcontactop.py +1 -1
- orq_ai_sdk/models/createconversationop.py +1 -1
- orq_ai_sdk/models/createconversationresponseop.py +2 -2
- orq_ai_sdk/models/createdatasetitemop.py +4 -4
- orq_ai_sdk/models/createdatasetop.py +1 -1
- orq_ai_sdk/models/createdatasourceop.py +1 -1
- orq_ai_sdk/models/createembeddingop.py +26 -221
- orq_ai_sdk/models/createevalop.py +14 -14
- orq_ai_sdk/models/createidentityop.py +1 -1
- orq_ai_sdk/models/createimageeditop.py +31 -242
- orq_ai_sdk/models/createimageop.py +22 -210
- orq_ai_sdk/models/createimagevariationop.py +31 -251
- orq_ai_sdk/models/createpromptop.py +0 -12
- orq_ai_sdk/models/creatererankop.py +26 -218
- orq_ai_sdk/models/createspeechop.py +24 -174
- orq_ai_sdk/models/createtoolop.py +6 -6
- orq_ai_sdk/models/createtranscriptionop.py +10 -180
- orq_ai_sdk/models/createtranslationop.py +10 -172
- orq_ai_sdk/models/filegetop.py +1 -1
- orq_ai_sdk/models/filelistop.py +1 -1
- orq_ai_sdk/models/fileuploadop.py +1 -1
- orq_ai_sdk/models/generateconversationnameop.py +1 -1
- orq_ai_sdk/models/getallpromptsop.py +0 -6
- orq_ai_sdk/models/getalltoolsop.py +6 -6
- orq_ai_sdk/models/getevalsop.py +14 -14
- orq_ai_sdk/models/getonepromptop.py +0 -6
- orq_ai_sdk/models/getpromptversionop.py +0 -6
- orq_ai_sdk/models/listagentsop.py +0 -12
- orq_ai_sdk/models/listdatasetdatapointsop.py +4 -4
- orq_ai_sdk/models/listdatasetsop.py +1 -1
- orq_ai_sdk/models/listdatasourcesop.py +1 -1
- orq_ai_sdk/models/listidentitiesop.py +1 -1
- orq_ai_sdk/models/listpromptversionsop.py +0 -6
- orq_ai_sdk/models/partdoneevent.py +1 -1
- orq_ai_sdk/models/reasoningpart.py +1 -1
- orq_ai_sdk/models/retrieveagentrequestop.py +0 -12
- orq_ai_sdk/models/retrievedatapointop.py +4 -4
- orq_ai_sdk/models/retrievedatasetop.py +1 -1
- orq_ai_sdk/models/retrievedatasourceop.py +1 -1
- orq_ai_sdk/models/retrieveidentityop.py +1 -1
- orq_ai_sdk/models/retrievetoolop.py +6 -6
- orq_ai_sdk/models/runagentop.py +1 -13
- orq_ai_sdk/models/streamrunagentop.py +1 -13
- orq_ai_sdk/models/updateagentop.py +0 -24
- orq_ai_sdk/models/updateconversationop.py +1 -1
- orq_ai_sdk/models/updatedatapointop.py +4 -4
- orq_ai_sdk/models/updatedatasetop.py +1 -1
- orq_ai_sdk/models/updatedatasourceop.py +1 -1
- orq_ai_sdk/models/updateevalop.py +14 -14
- orq_ai_sdk/models/updateidentityop.py +1 -1
- orq_ai_sdk/models/updatepromptop.py +0 -12
- orq_ai_sdk/models/updatetoolop.py +7 -7
- orq_ai_sdk/orq_completions.py +0 -6
- orq_ai_sdk/rerank.py +0 -98
- orq_ai_sdk/speech.py +1 -83
- orq_ai_sdk/transcriptions.py +0 -90
- orq_ai_sdk/translations.py +1 -87
- orq_ai_sdk/variations.py +1 -111
- {orq_ai_sdk-4.2.16.dist-info → orq_ai_sdk-4.3.0rc0.dist-info}/METADATA +202 -202
- {orq_ai_sdk-4.2.16.dist-info → orq_ai_sdk-4.3.0rc0.dist-info}/RECORD +75 -75
- {orq_ai_sdk-4.2.16.dist-info → orq_ai_sdk-4.3.0rc0.dist-info}/WHEEL +1 -1
- {orq_ai_sdk-4.2.16.dist-info → orq_ai_sdk-4.3.0rc0.dist-info}/top_level.txt +0 -0
|
@@ -533,8 +533,6 @@ class ModelConfigurationTimeout(BaseModel):
|
|
|
533
533
|
class ModelConfigurationParametersTypedDict(TypedDict):
|
|
534
534
|
r"""Model behavior parameters that control how the model generates responses. Common parameters: `temperature` (0-1, randomness), `max_completion_tokens` (max output length), `top_p` (sampling diversity). Advanced: `frequency_penalty`, `presence_penalty`, `response_format` (JSON/structured), `reasoning_effort`, `seed` (reproducibility). Support varies by model - consult AI Gateway documentation."""
|
|
535
535
|
|
|
536
|
-
name: NotRequired[str]
|
|
537
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
538
536
|
audio: NotRequired[Nullable[UpdateAgentModelConfigurationAudioTypedDict]]
|
|
539
537
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
540
538
|
frequency_penalty: NotRequired[Nullable[float]]
|
|
@@ -604,9 +602,6 @@ class ModelConfigurationParametersTypedDict(TypedDict):
|
|
|
604
602
|
class ModelConfigurationParameters(BaseModel):
|
|
605
603
|
r"""Model behavior parameters that control how the model generates responses. Common parameters: `temperature` (0-1, randomness), `max_completion_tokens` (max output length), `top_p` (sampling diversity). Advanced: `frequency_penalty`, `presence_penalty`, `response_format` (JSON/structured), `reasoning_effort`, `seed` (reproducibility). Support varies by model - consult AI Gateway documentation."""
|
|
606
604
|
|
|
607
|
-
name: Optional[str] = None
|
|
608
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
609
|
-
|
|
610
605
|
audio: OptionalNullable[UpdateAgentModelConfigurationAudio] = UNSET
|
|
611
606
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
612
607
|
|
|
@@ -702,7 +697,6 @@ class ModelConfigurationParameters(BaseModel):
|
|
|
702
697
|
def serialize_model(self, handler):
|
|
703
698
|
optional_fields = set(
|
|
704
699
|
[
|
|
705
|
-
"name",
|
|
706
700
|
"audio",
|
|
707
701
|
"frequency_penalty",
|
|
708
702
|
"max_tokens",
|
|
@@ -1379,8 +1373,6 @@ class UpdateAgentFallbackModelConfigurationTimeout(BaseModel):
|
|
|
1379
1373
|
class UpdateAgentFallbackModelConfigurationParametersTypedDict(TypedDict):
|
|
1380
1374
|
r"""Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used."""
|
|
1381
1375
|
|
|
1382
|
-
name: NotRequired[str]
|
|
1383
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
1384
1376
|
audio: NotRequired[Nullable[UpdateAgentFallbackModelConfigurationAudioTypedDict]]
|
|
1385
1377
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
1386
1378
|
frequency_penalty: NotRequired[Nullable[float]]
|
|
@@ -1462,9 +1454,6 @@ class UpdateAgentFallbackModelConfigurationParametersTypedDict(TypedDict):
|
|
|
1462
1454
|
class UpdateAgentFallbackModelConfigurationParameters(BaseModel):
|
|
1463
1455
|
r"""Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used."""
|
|
1464
1456
|
|
|
1465
|
-
name: Optional[str] = None
|
|
1466
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
1467
|
-
|
|
1468
1457
|
audio: OptionalNullable[UpdateAgentFallbackModelConfigurationAudio] = UNSET
|
|
1469
1458
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
1470
1459
|
|
|
@@ -1568,7 +1557,6 @@ class UpdateAgentFallbackModelConfigurationParameters(BaseModel):
|
|
|
1568
1557
|
def serialize_model(self, handler):
|
|
1569
1558
|
optional_fields = set(
|
|
1570
1559
|
[
|
|
1571
|
-
"name",
|
|
1572
1560
|
"audio",
|
|
1573
1561
|
"frequency_penalty",
|
|
1574
1562
|
"max_tokens",
|
|
@@ -3573,8 +3561,6 @@ class UpdateAgentTimeout(BaseModel):
|
|
|
3573
3561
|
class UpdateAgentParametersTypedDict(TypedDict):
|
|
3574
3562
|
r"""Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults."""
|
|
3575
3563
|
|
|
3576
|
-
name: NotRequired[str]
|
|
3577
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
3578
3564
|
audio: NotRequired[Nullable[UpdateAgentAudioTypedDict]]
|
|
3579
3565
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
3580
3566
|
frequency_penalty: NotRequired[Nullable[float]]
|
|
@@ -3644,9 +3630,6 @@ class UpdateAgentParametersTypedDict(TypedDict):
|
|
|
3644
3630
|
class UpdateAgentParameters(BaseModel):
|
|
3645
3631
|
r"""Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults."""
|
|
3646
3632
|
|
|
3647
|
-
name: Optional[str] = None
|
|
3648
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
3649
|
-
|
|
3650
3633
|
audio: OptionalNullable[UpdateAgentAudio] = UNSET
|
|
3651
3634
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
3652
3635
|
|
|
@@ -3742,7 +3725,6 @@ class UpdateAgentParameters(BaseModel):
|
|
|
3742
3725
|
def serialize_model(self, handler):
|
|
3743
3726
|
optional_fields = set(
|
|
3744
3727
|
[
|
|
3745
|
-
"name",
|
|
3746
3728
|
"audio",
|
|
3747
3729
|
"frequency_penalty",
|
|
3748
3730
|
"max_tokens",
|
|
@@ -4385,8 +4367,6 @@ class UpdateAgentFallbackModelConfigurationAgentsTimeout(BaseModel):
|
|
|
4385
4367
|
class UpdateAgentFallbackModelConfigurationAgentsParametersTypedDict(TypedDict):
|
|
4386
4368
|
r"""Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used."""
|
|
4387
4369
|
|
|
4388
|
-
name: NotRequired[str]
|
|
4389
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
4390
4370
|
audio: NotRequired[
|
|
4391
4371
|
Nullable[UpdateAgentFallbackModelConfigurationAgentsAudioTypedDict]
|
|
4392
4372
|
]
|
|
@@ -4478,9 +4458,6 @@ class UpdateAgentFallbackModelConfigurationAgentsParametersTypedDict(TypedDict):
|
|
|
4478
4458
|
class UpdateAgentFallbackModelConfigurationAgentsParameters(BaseModel):
|
|
4479
4459
|
r"""Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used."""
|
|
4480
4460
|
|
|
4481
|
-
name: Optional[str] = None
|
|
4482
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
4483
|
-
|
|
4484
4461
|
audio: OptionalNullable[UpdateAgentFallbackModelConfigurationAgentsAudio] = UNSET
|
|
4485
4462
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
4486
4463
|
|
|
@@ -4590,7 +4567,6 @@ class UpdateAgentFallbackModelConfigurationAgentsParameters(BaseModel):
|
|
|
4590
4567
|
def serialize_model(self, handler):
|
|
4591
4568
|
optional_fields = set(
|
|
4592
4569
|
[
|
|
4593
|
-
"name",
|
|
4594
4570
|
"audio",
|
|
4595
4571
|
"frequency_penalty",
|
|
4596
4572
|
"max_tokens",
|
|
@@ -231,7 +231,7 @@ class UpdateConversationResponseBody(BaseModel):
|
|
|
231
231
|
r"""Unix timestamp in milliseconds when the conversation was last modified."""
|
|
232
232
|
|
|
233
233
|
id: Annotated[Optional[str], pydantic.Field(alias="_id")] = (
|
|
234
|
-
"
|
|
234
|
+
"conv_01kfs437n7tnjy1h5rgqd3yhvy"
|
|
235
235
|
)
|
|
236
236
|
r"""Unique conversation identifier with `conv_` prefix."""
|
|
237
237
|
|
|
@@ -1445,7 +1445,7 @@ class UpdateDatapointEvaluations3(BaseModel):
|
|
|
1445
1445
|
|
|
1446
1446
|
source: Optional[UpdateDatapointEvaluationsDatasetsResponseSource] = "orq"
|
|
1447
1447
|
|
|
1448
|
-
reviewed_at: Optional[datetime] = parse_datetime("2026-01-
|
|
1448
|
+
reviewed_at: Optional[datetime] = parse_datetime("2026-01-24T23:05:46.077Z")
|
|
1449
1449
|
r"""The date and time the item was reviewed"""
|
|
1450
1450
|
|
|
1451
1451
|
@model_serializer(mode="wrap")
|
|
@@ -1513,7 +1513,7 @@ class UpdateDatapointEvaluations2(BaseModel):
|
|
|
1513
1513
|
|
|
1514
1514
|
source: Optional[UpdateDatapointEvaluationsDatasetsSource] = "orq"
|
|
1515
1515
|
|
|
1516
|
-
reviewed_at: Optional[datetime] = parse_datetime("2026-01-
|
|
1516
|
+
reviewed_at: Optional[datetime] = parse_datetime("2026-01-24T23:05:46.076Z")
|
|
1517
1517
|
r"""The date and time the item was reviewed"""
|
|
1518
1518
|
|
|
1519
1519
|
@model_serializer(mode="wrap")
|
|
@@ -1581,7 +1581,7 @@ class UpdateDatapointEvaluations1(BaseModel):
|
|
|
1581
1581
|
|
|
1582
1582
|
source: Optional[UpdateDatapointEvaluationsSource] = "orq"
|
|
1583
1583
|
|
|
1584
|
-
reviewed_at: Optional[datetime] = parse_datetime("2026-01-
|
|
1584
|
+
reviewed_at: Optional[datetime] = parse_datetime("2026-01-24T23:05:46.075Z")
|
|
1585
1585
|
r"""The date and time the item was reviewed"""
|
|
1586
1586
|
|
|
1587
1587
|
@model_serializer(mode="wrap")
|
|
@@ -1684,7 +1684,7 @@ class UpdateDatapointResponseBody(BaseModel):
|
|
|
1684
1684
|
created: Optional[datetime] = None
|
|
1685
1685
|
r"""The date and time the resource was created"""
|
|
1686
1686
|
|
|
1687
|
-
updated: Optional[datetime] = parse_datetime("2026-01-
|
|
1687
|
+
updated: Optional[datetime] = parse_datetime("2026-01-24T23:05:31.950Z")
|
|
1688
1688
|
r"""The date and time the resource was last updated"""
|
|
1689
1689
|
|
|
1690
1690
|
@model_serializer(mode="wrap")
|
|
@@ -154,7 +154,7 @@ class UpdateDatasetResponseBody(BaseModel):
|
|
|
154
154
|
created: Optional[datetime] = None
|
|
155
155
|
r"""The date and time the resource was created"""
|
|
156
156
|
|
|
157
|
-
updated: Optional[datetime] = parse_datetime("2026-01-
|
|
157
|
+
updated: Optional[datetime] = parse_datetime("2026-01-24T23:05:31.950Z")
|
|
158
158
|
r"""The date and time the resource was last updated"""
|
|
159
159
|
|
|
160
160
|
@model_serializer(mode="wrap")
|
|
@@ -104,7 +104,7 @@ class UpdateDatasourceResponseBody(BaseModel):
|
|
|
104
104
|
r"""The number of chunks in the datasource"""
|
|
105
105
|
|
|
106
106
|
id: Annotated[Optional[str], pydantic.Field(alias="_id")] = (
|
|
107
|
-
"
|
|
107
|
+
"01KFS4386A1MM34M8SWVH3PP7T"
|
|
108
108
|
)
|
|
109
109
|
r"""The unique identifier of the data source"""
|
|
110
110
|
|
|
@@ -959,9 +959,9 @@ class ResponseBodyTypescript(BaseModel):
|
|
|
959
959
|
|
|
960
960
|
key: str
|
|
961
961
|
|
|
962
|
-
created: Optional[str] = "2026-01-
|
|
962
|
+
created: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
963
963
|
|
|
964
|
-
updated: Optional[str] = "2026-01-
|
|
964
|
+
updated: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
965
965
|
|
|
966
966
|
guardrail_config: Optional[
|
|
967
967
|
UpdateEvalResponseBodyEvalsResponse200ApplicationJSON7GuardrailConfig
|
|
@@ -1155,9 +1155,9 @@ class ResponseBodyRagas(BaseModel):
|
|
|
1155
1155
|
|
|
1156
1156
|
model: str
|
|
1157
1157
|
|
|
1158
|
-
created: Optional[str] = "2026-01-
|
|
1158
|
+
created: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
1159
1159
|
|
|
1160
|
-
updated: Optional[str] = "2026-01-
|
|
1160
|
+
updated: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
1161
1161
|
|
|
1162
1162
|
guardrail_config: Optional[
|
|
1163
1163
|
UpdateEvalResponseBodyEvalsResponse200ApplicationJSON6GuardrailConfig
|
|
@@ -1852,9 +1852,9 @@ class ResponseBodyFunction(BaseModel):
|
|
|
1852
1852
|
|
|
1853
1853
|
key: str
|
|
1854
1854
|
|
|
1855
|
-
created: Optional[str] = "2026-01-
|
|
1855
|
+
created: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
1856
1856
|
|
|
1857
|
-
updated: Optional[str] = "2026-01-
|
|
1857
|
+
updated: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
1858
1858
|
|
|
1859
1859
|
guardrail_config: Optional[
|
|
1860
1860
|
UpdateEvalResponseBodyEvalsResponse200ApplicationJSONGuardrailConfig
|
|
@@ -2029,9 +2029,9 @@ class UpdateEvalResponseBodyPython(BaseModel):
|
|
|
2029
2029
|
|
|
2030
2030
|
key: str
|
|
2031
2031
|
|
|
2032
|
-
created: Optional[str] = "2026-01-
|
|
2032
|
+
created: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
2033
2033
|
|
|
2034
|
-
updated: Optional[str] = "2026-01-
|
|
2034
|
+
updated: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
2035
2035
|
|
|
2036
2036
|
guardrail_config: Optional[
|
|
2037
2037
|
UpdateEvalResponseBodyEvalsResponse200GuardrailConfig
|
|
@@ -2213,9 +2213,9 @@ class UpdateEvalResponseBodyHTTP(BaseModel):
|
|
|
2213
2213
|
|
|
2214
2214
|
key: str
|
|
2215
2215
|
|
|
2216
|
-
created: Optional[str] = "2026-01-
|
|
2216
|
+
created: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
2217
2217
|
|
|
2218
|
-
updated: Optional[str] = "2026-01-
|
|
2218
|
+
updated: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
2219
2219
|
|
|
2220
2220
|
guardrail_config: Optional[UpdateEvalResponseBodyEvalsResponseGuardrailConfig] = (
|
|
2221
2221
|
None
|
|
@@ -2368,9 +2368,9 @@ class UpdateEvalResponseBodyJSON(BaseModel):
|
|
|
2368
2368
|
|
|
2369
2369
|
key: str
|
|
2370
2370
|
|
|
2371
|
-
created: Optional[str] = "2026-01-
|
|
2371
|
+
created: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
2372
2372
|
|
|
2373
|
-
updated: Optional[str] = "2026-01-
|
|
2373
|
+
updated: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
2374
2374
|
|
|
2375
2375
|
guardrail_config: Optional[UpdateEvalResponseBodyEvalsGuardrailConfig] = None
|
|
2376
2376
|
|
|
@@ -2522,9 +2522,9 @@ class UpdateEvalResponseBodyLLM(BaseModel):
|
|
|
2522
2522
|
|
|
2523
2523
|
model: str
|
|
2524
2524
|
|
|
2525
|
-
created: Optional[str] = "2026-01-
|
|
2525
|
+
created: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
2526
2526
|
|
|
2527
|
-
updated: Optional[str] = "2026-01-
|
|
2527
|
+
updated: Optional[str] = "2026-01-24T23:05:33.746Z"
|
|
2528
2528
|
|
|
2529
2529
|
guardrail_config: Optional[UpdateEvalResponseBodyGuardrailConfig] = None
|
|
2530
2530
|
|
|
@@ -194,7 +194,7 @@ class UpdateIdentityResponseBody(BaseModel):
|
|
|
194
194
|
created: Optional[datetime] = None
|
|
195
195
|
r"""The date and time the resource was created"""
|
|
196
196
|
|
|
197
|
-
updated: Optional[datetime] = parse_datetime("2026-01-
|
|
197
|
+
updated: Optional[datetime] = parse_datetime("2026-01-24T23:05:31.950Z")
|
|
198
198
|
r"""The date and time the resource was last updated"""
|
|
199
199
|
|
|
200
200
|
@model_serializer(mode="wrap")
|
|
@@ -1128,8 +1128,6 @@ class UpdatePromptPromptInputTypedDict(TypedDict):
|
|
|
1128
1128
|
r"""Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content."""
|
|
1129
1129
|
model: NotRequired[Nullable[str]]
|
|
1130
1130
|
r"""Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway-supported-models. Only chat models are supported."""
|
|
1131
|
-
name: NotRequired[str]
|
|
1132
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
1133
1131
|
audio: NotRequired[Nullable[UpdatePromptAudioTypedDict]]
|
|
1134
1132
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
1135
1133
|
frequency_penalty: NotRequired[Nullable[float]]
|
|
@@ -1205,9 +1203,6 @@ class UpdatePromptPromptInput(BaseModel):
|
|
|
1205
1203
|
model: OptionalNullable[str] = UNSET
|
|
1206
1204
|
r"""Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway-supported-models. Only chat models are supported."""
|
|
1207
1205
|
|
|
1208
|
-
name: Optional[str] = None
|
|
1209
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
1210
|
-
|
|
1211
1206
|
audio: OptionalNullable[UpdatePromptAudio] = UNSET
|
|
1212
1207
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
1213
1208
|
|
|
@@ -1305,7 +1300,6 @@ class UpdatePromptPromptInput(BaseModel):
|
|
|
1305
1300
|
[
|
|
1306
1301
|
"messages",
|
|
1307
1302
|
"model",
|
|
1308
|
-
"name",
|
|
1309
1303
|
"audio",
|
|
1310
1304
|
"frequency_penalty",
|
|
1311
1305
|
"max_tokens",
|
|
@@ -3509,8 +3503,6 @@ UpdatePromptPromptsResponseMessages = Annotated[
|
|
|
3509
3503
|
class UpdatePromptPromptFieldTypedDict(TypedDict):
|
|
3510
3504
|
r"""Prompt configuration with model and messages. Use this instead of prompt_config."""
|
|
3511
3505
|
|
|
3512
|
-
name: NotRequired[str]
|
|
3513
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
3514
3506
|
audio: NotRequired[Nullable[UpdatePromptPromptsAudioTypedDict]]
|
|
3515
3507
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
3516
3508
|
frequency_penalty: NotRequired[Nullable[float]]
|
|
@@ -3585,9 +3577,6 @@ class UpdatePromptPromptFieldTypedDict(TypedDict):
|
|
|
3585
3577
|
class UpdatePromptPromptField(BaseModel):
|
|
3586
3578
|
r"""Prompt configuration with model and messages. Use this instead of prompt_config."""
|
|
3587
3579
|
|
|
3588
|
-
name: Optional[str] = None
|
|
3589
|
-
r"""The name to display on the trace. If not specified, the default system name will be used."""
|
|
3590
|
-
|
|
3591
3580
|
audio: OptionalNullable[UpdatePromptPromptsAudio] = UNSET
|
|
3592
3581
|
r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
|
|
3593
3582
|
|
|
@@ -3691,7 +3680,6 @@ class UpdatePromptPromptField(BaseModel):
|
|
|
3691
3680
|
def serialize_model(self, handler):
|
|
3692
3681
|
optional_fields = set(
|
|
3693
3682
|
[
|
|
3694
|
-
"name",
|
|
3695
3683
|
"audio",
|
|
3696
3684
|
"frequency_penalty",
|
|
3697
3685
|
"max_tokens",
|
|
@@ -259,7 +259,7 @@ class RequestBodyTools(BaseModel):
|
|
|
259
259
|
|
|
260
260
|
schema_: Annotated[UpdateToolRequestBodyToolsSchema, pydantic.Field(alias="schema")]
|
|
261
261
|
|
|
262
|
-
id: Optional[str] = "
|
|
262
|
+
id: Optional[str] = "01KFS4381JRNQYTT0SDHCKPBGB"
|
|
263
263
|
|
|
264
264
|
description: Optional[str] = None
|
|
265
265
|
|
|
@@ -1214,7 +1214,7 @@ class UpdateToolResponseBodyCodeExecutionTool(BaseModel):
|
|
|
1214
1214
|
code_tool: UpdateToolResponseBodyCodeTool
|
|
1215
1215
|
|
|
1216
1216
|
id: Annotated[Optional[str], pydantic.Field(alias="_id")] = (
|
|
1217
|
-
"
|
|
1217
|
+
"tool_01KFS4381CMJT8KMSXZGEM7V7M"
|
|
1218
1218
|
)
|
|
1219
1219
|
|
|
1220
1220
|
display_name: Optional[str] = None
|
|
@@ -1345,7 +1345,7 @@ class UpdateToolResponseBodyTools(BaseModel):
|
|
|
1345
1345
|
UpdateToolResponseBodyToolsSchema, pydantic.Field(alias="schema")
|
|
1346
1346
|
]
|
|
1347
1347
|
|
|
1348
|
-
id: Optional[str] = "
|
|
1348
|
+
id: Optional[str] = "01KFS4381CFZY0JMZPTMQQS7XF"
|
|
1349
1349
|
|
|
1350
1350
|
description: Optional[str] = None
|
|
1351
1351
|
|
|
@@ -1476,7 +1476,7 @@ class UpdateToolResponseBodyMCPTool(BaseModel):
|
|
|
1476
1476
|
mcp: UpdateToolResponseBodyMcp
|
|
1477
1477
|
|
|
1478
1478
|
id: Annotated[Optional[str], pydantic.Field(alias="_id")] = (
|
|
1479
|
-
"
|
|
1479
|
+
"tool_01KFS4381B9BHWJV9CC8QEBC44"
|
|
1480
1480
|
)
|
|
1481
1481
|
|
|
1482
1482
|
display_name: Optional[str] = None
|
|
@@ -1777,7 +1777,7 @@ class UpdateToolResponseBodyHTTPTool(BaseModel):
|
|
|
1777
1777
|
http: UpdateToolResponseBodyHTTP
|
|
1778
1778
|
|
|
1779
1779
|
id: Annotated[Optional[str], pydantic.Field(alias="_id")] = (
|
|
1780
|
-
"
|
|
1780
|
+
"tool_01KFS43819HG947S2E59P5SQ8J"
|
|
1781
1781
|
)
|
|
1782
1782
|
|
|
1783
1783
|
display_name: Optional[str] = None
|
|
@@ -1972,7 +1972,7 @@ class UpdateToolResponseBodyJSONSchemaTool(BaseModel):
|
|
|
1972
1972
|
json_schema: UpdateToolResponseBodyJSONSchema
|
|
1973
1973
|
|
|
1974
1974
|
id: Annotated[Optional[str], pydantic.Field(alias="_id")] = (
|
|
1975
|
-
"
|
|
1975
|
+
"tool_01KFS43818RK6TX293SPCNF4AQ"
|
|
1976
1976
|
)
|
|
1977
1977
|
|
|
1978
1978
|
display_name: Optional[str] = None
|
|
@@ -2171,7 +2171,7 @@ class UpdateToolResponseBodyFunctionTool(BaseModel):
|
|
|
2171
2171
|
function: UpdateToolResponseBodyFunction
|
|
2172
2172
|
|
|
2173
2173
|
id: Annotated[Optional[str], pydantic.Field(alias="_id")] = (
|
|
2174
|
-
"
|
|
2174
|
+
"tool_01KFS43816M8PMV47S5WBV0JAX"
|
|
2175
2175
|
)
|
|
2176
2176
|
|
|
2177
2177
|
display_name: Optional[str] = None
|
orq_ai_sdk/orq_completions.py
CHANGED
|
@@ -26,7 +26,6 @@ class OrqCompletions(BaseSDK):
|
|
|
26
26
|
],
|
|
27
27
|
model: str,
|
|
28
28
|
metadata: Optional[Dict[str, str]] = None,
|
|
29
|
-
name: Optional[str] = None,
|
|
30
29
|
audio: OptionalNullable[
|
|
31
30
|
Union[
|
|
32
31
|
models_createchatcompletionop.CreateChatCompletionAudio,
|
|
@@ -148,7 +147,6 @@ class OrqCompletions(BaseSDK):
|
|
|
148
147
|
:param messages: A list of messages comprising the conversation so far.
|
|
149
148
|
:param model: Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models.
|
|
150
149
|
:param metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can have a maximum length of 64 characters and values can have a maximum length of 512 characters.
|
|
151
|
-
:param name: The name to display on the trace. If not specified, the default system name will be used.
|
|
152
150
|
:param audio: Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more.
|
|
153
151
|
:param frequency_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
|
|
154
152
|
:param max_tokens: `[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API.
|
|
@@ -213,7 +211,6 @@ class OrqCompletions(BaseSDK):
|
|
|
213
211
|
),
|
|
214
212
|
model=model,
|
|
215
213
|
metadata=metadata,
|
|
216
|
-
name=name,
|
|
217
214
|
audio=utils.get_pydantic_model(
|
|
218
215
|
audio, OptionalNullable[models.CreateChatCompletionAudio]
|
|
219
216
|
),
|
|
@@ -350,7 +347,6 @@ class OrqCompletions(BaseSDK):
|
|
|
350
347
|
],
|
|
351
348
|
model: str,
|
|
352
349
|
metadata: Optional[Dict[str, str]] = None,
|
|
353
|
-
name: Optional[str] = None,
|
|
354
350
|
audio: OptionalNullable[
|
|
355
351
|
Union[
|
|
356
352
|
models_createchatcompletionop.CreateChatCompletionAudio,
|
|
@@ -472,7 +468,6 @@ class OrqCompletions(BaseSDK):
|
|
|
472
468
|
:param messages: A list of messages comprising the conversation so far.
|
|
473
469
|
:param model: Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models.
|
|
474
470
|
:param metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can have a maximum length of 64 characters and values can have a maximum length of 512 characters.
|
|
475
|
-
:param name: The name to display on the trace. If not specified, the default system name will be used.
|
|
476
471
|
:param audio: Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more.
|
|
477
472
|
:param frequency_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
|
|
478
473
|
:param max_tokens: `[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API.
|
|
@@ -537,7 +532,6 @@ class OrqCompletions(BaseSDK):
|
|
|
537
532
|
),
|
|
538
533
|
model=model,
|
|
539
534
|
metadata=metadata,
|
|
540
|
-
name=name,
|
|
541
535
|
audio=utils.get_pydantic_model(
|
|
542
536
|
audio, OptionalNullable[models.CreateChatCompletionAudio]
|
|
543
537
|
),
|
orq_ai_sdk/rerank.py
CHANGED
|
@@ -19,37 +19,6 @@ class Rerank(BaseSDK):
|
|
|
19
19
|
model: str,
|
|
20
20
|
top_n: Optional[float] = None,
|
|
21
21
|
filename: OptionalNullable[str] = UNSET,
|
|
22
|
-
name: Optional[str] = None,
|
|
23
|
-
fallbacks: Optional[
|
|
24
|
-
Union[
|
|
25
|
-
List[models_creatererankop.CreateRerankFallbacks],
|
|
26
|
-
List[models_creatererankop.CreateRerankFallbacksTypedDict],
|
|
27
|
-
]
|
|
28
|
-
] = None,
|
|
29
|
-
retry: Optional[
|
|
30
|
-
Union[
|
|
31
|
-
models_creatererankop.CreateRerankRetry,
|
|
32
|
-
models_creatererankop.CreateRerankRetryTypedDict,
|
|
33
|
-
]
|
|
34
|
-
] = None,
|
|
35
|
-
cache: Optional[
|
|
36
|
-
Union[
|
|
37
|
-
models_creatererankop.CreateRerankCache,
|
|
38
|
-
models_creatererankop.CreateRerankCacheTypedDict,
|
|
39
|
-
]
|
|
40
|
-
] = None,
|
|
41
|
-
load_balancer: Optional[
|
|
42
|
-
Union[
|
|
43
|
-
models_creatererankop.CreateRerankLoadBalancer,
|
|
44
|
-
models_creatererankop.CreateRerankLoadBalancerTypedDict,
|
|
45
|
-
]
|
|
46
|
-
] = None,
|
|
47
|
-
timeout: Optional[
|
|
48
|
-
Union[
|
|
49
|
-
models_creatererankop.CreateRerankTimeout,
|
|
50
|
-
models_creatererankop.CreateRerankTimeoutTypedDict,
|
|
51
|
-
]
|
|
52
|
-
] = None,
|
|
53
22
|
orq: Optional[
|
|
54
23
|
Union[
|
|
55
24
|
models_creatererankop.CreateRerankOrq,
|
|
@@ -70,12 +39,6 @@ class Rerank(BaseSDK):
|
|
|
70
39
|
:param model: The identifier of the model to use
|
|
71
40
|
:param top_n: The number of most relevant documents or indices to return, defaults to the length of the documents
|
|
72
41
|
:param filename: The filename of the document to rerank
|
|
73
|
-
:param name: The name to display on the trace. If not specified, the default system name will be used.
|
|
74
|
-
:param fallbacks: Array of fallback models to use if primary model fails
|
|
75
|
-
:param retry: Retry configuration for the request
|
|
76
|
-
:param cache: Cache configuration for the request.
|
|
77
|
-
:param load_balancer: Load balancer configuration for the request.
|
|
78
|
-
:param timeout: Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.
|
|
79
42
|
:param orq:
|
|
80
43
|
:param retries: Override the default retry configuration for this method
|
|
81
44
|
:param server_url: Override the default server URL for this method
|
|
@@ -101,18 +64,6 @@ class Rerank(BaseSDK):
|
|
|
101
64
|
model=model,
|
|
102
65
|
top_n=top_n,
|
|
103
66
|
filename=filename,
|
|
104
|
-
name=name,
|
|
105
|
-
fallbacks=utils.get_pydantic_model(
|
|
106
|
-
fallbacks, Optional[List[models.CreateRerankFallbacks]]
|
|
107
|
-
),
|
|
108
|
-
retry=utils.get_pydantic_model(retry, Optional[models.CreateRerankRetry]),
|
|
109
|
-
cache=utils.get_pydantic_model(cache, Optional[models.CreateRerankCache]),
|
|
110
|
-
load_balancer=utils.get_pydantic_model(
|
|
111
|
-
load_balancer, Optional[models.CreateRerankLoadBalancer]
|
|
112
|
-
),
|
|
113
|
-
timeout=utils.get_pydantic_model(
|
|
114
|
-
timeout, Optional[models.CreateRerankTimeout]
|
|
115
|
-
),
|
|
116
67
|
orq=utils.get_pydantic_model(orq, Optional[models.CreateRerankOrq]),
|
|
117
68
|
)
|
|
118
69
|
|
|
@@ -178,37 +129,6 @@ class Rerank(BaseSDK):
|
|
|
178
129
|
model: str,
|
|
179
130
|
top_n: Optional[float] = None,
|
|
180
131
|
filename: OptionalNullable[str] = UNSET,
|
|
181
|
-
name: Optional[str] = None,
|
|
182
|
-
fallbacks: Optional[
|
|
183
|
-
Union[
|
|
184
|
-
List[models_creatererankop.CreateRerankFallbacks],
|
|
185
|
-
List[models_creatererankop.CreateRerankFallbacksTypedDict],
|
|
186
|
-
]
|
|
187
|
-
] = None,
|
|
188
|
-
retry: Optional[
|
|
189
|
-
Union[
|
|
190
|
-
models_creatererankop.CreateRerankRetry,
|
|
191
|
-
models_creatererankop.CreateRerankRetryTypedDict,
|
|
192
|
-
]
|
|
193
|
-
] = None,
|
|
194
|
-
cache: Optional[
|
|
195
|
-
Union[
|
|
196
|
-
models_creatererankop.CreateRerankCache,
|
|
197
|
-
models_creatererankop.CreateRerankCacheTypedDict,
|
|
198
|
-
]
|
|
199
|
-
] = None,
|
|
200
|
-
load_balancer: Optional[
|
|
201
|
-
Union[
|
|
202
|
-
models_creatererankop.CreateRerankLoadBalancer,
|
|
203
|
-
models_creatererankop.CreateRerankLoadBalancerTypedDict,
|
|
204
|
-
]
|
|
205
|
-
] = None,
|
|
206
|
-
timeout: Optional[
|
|
207
|
-
Union[
|
|
208
|
-
models_creatererankop.CreateRerankTimeout,
|
|
209
|
-
models_creatererankop.CreateRerankTimeoutTypedDict,
|
|
210
|
-
]
|
|
211
|
-
] = None,
|
|
212
132
|
orq: Optional[
|
|
213
133
|
Union[
|
|
214
134
|
models_creatererankop.CreateRerankOrq,
|
|
@@ -229,12 +149,6 @@ class Rerank(BaseSDK):
|
|
|
229
149
|
:param model: The identifier of the model to use
|
|
230
150
|
:param top_n: The number of most relevant documents or indices to return, defaults to the length of the documents
|
|
231
151
|
:param filename: The filename of the document to rerank
|
|
232
|
-
:param name: The name to display on the trace. If not specified, the default system name will be used.
|
|
233
|
-
:param fallbacks: Array of fallback models to use if primary model fails
|
|
234
|
-
:param retry: Retry configuration for the request
|
|
235
|
-
:param cache: Cache configuration for the request.
|
|
236
|
-
:param load_balancer: Load balancer configuration for the request.
|
|
237
|
-
:param timeout: Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.
|
|
238
152
|
:param orq:
|
|
239
153
|
:param retries: Override the default retry configuration for this method
|
|
240
154
|
:param server_url: Override the default server URL for this method
|
|
@@ -260,18 +174,6 @@ class Rerank(BaseSDK):
|
|
|
260
174
|
model=model,
|
|
261
175
|
top_n=top_n,
|
|
262
176
|
filename=filename,
|
|
263
|
-
name=name,
|
|
264
|
-
fallbacks=utils.get_pydantic_model(
|
|
265
|
-
fallbacks, Optional[List[models.CreateRerankFallbacks]]
|
|
266
|
-
),
|
|
267
|
-
retry=utils.get_pydantic_model(retry, Optional[models.CreateRerankRetry]),
|
|
268
|
-
cache=utils.get_pydantic_model(cache, Optional[models.CreateRerankCache]),
|
|
269
|
-
load_balancer=utils.get_pydantic_model(
|
|
270
|
-
load_balancer, Optional[models.CreateRerankLoadBalancer]
|
|
271
|
-
),
|
|
272
|
-
timeout=utils.get_pydantic_model(
|
|
273
|
-
timeout, Optional[models.CreateRerankTimeout]
|
|
274
|
-
),
|
|
275
177
|
orq=utils.get_pydantic_model(orq, Optional[models.CreateRerankOrq]),
|
|
276
178
|
)
|
|
277
179
|
|