Skip to content

Commit ed961a2

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.480.1
1 parent 16d024c commit ed961a2

File tree

1,420 files changed

+18824
-33820
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,420 files changed

+18824
-33820
lines changed

‎.speakeasy/workflow.lock

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
speakeasyVersion: 1.472.0
1+
speakeasyVersion: 1.480.1
22
sources:
33
orq-ai-sdk-prerelease-python:
44
sourceNamespace: orq-ai-sdk-prerelease-python
5-
sourceRevisionDigest: sha256:c4b704fe0757864d4018fa56fac0a0ec85ca6ca55dccb9ab86f4b6eaee5857c9
6-
sourceBlobDigest: sha256:a30d3d59df339ac2d970a8c5d1bb8fb1275015ee9d4a9059ac00dfe48afe9a5d
5+
sourceRevisionDigest: sha256:4890dd148cd414d1e1ca61ad3c1ee2fdd1aef3deeed372e547e5cb725de8f470
6+
sourceBlobDigest: sha256:dccbc22675ab2b4a634fb7374e5ff34ebd126d0608815594ca078e171ba07e6e
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1737626692
9+
- speakeasy-sdk-regen-1738310856
1010
- "2.0"
1111
orq-ai-sdk-python:
1212
sourceNamespace: orq-ai-sdk-python
@@ -20,10 +20,10 @@ targets:
2020
orq-ai-sdk-prerelease-python:
2121
source: orq-ai-sdk-prerelease-python
2222
sourceNamespace: orq-ai-sdk-prerelease-python
23-
sourceRevisionDigest: sha256:c4b704fe0757864d4018fa56fac0a0ec85ca6ca55dccb9ab86f4b6eaee5857c9
24-
sourceBlobDigest: sha256:a30d3d59df339ac2d970a8c5d1bb8fb1275015ee9d4a9059ac00dfe48afe9a5d
23+
sourceRevisionDigest: sha256:4890dd148cd414d1e1ca61ad3c1ee2fdd1aef3deeed372e547e5cb725de8f470
24+
sourceBlobDigest: sha256:dccbc22675ab2b4a634fb7374e5ff34ebd126d0608815594ca078e171ba07e6e
2525
codeSamplesNamespace: orq-ai-sdk-prerelease-python-code-samples
26-
codeSamplesRevisionDigest: sha256:a9456d743dc828eaf9b2fa1f0c7d63b5d0676464f4dbc181f0e379c38c77d6cc
26+
codeSamplesRevisionDigest: sha256:106ef35be1857c10ddecbe15f267e233e4282dffcfdfcaa93d59e696a0e5592e
2727
orq-ai-sdk-python:
2828
source: orq-ai-sdk-python
2929
sourceNamespace: orq-ai-sdk-python

‎packages/orq-rc/.speakeasy/gen.lock

Lines changed: 549 additions & 888 deletions
Large diffs are not rendered by default.

‎packages/orq-rc/README.md

Lines changed: 46 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Developer-friendly & type-safe Python SDK specifically catered to leverage *orq-
1212
<!-- Start Summary [summary] -->
1313
## Summary
1414

15-
[Dev] orq.ai API: The Orquesta API
15+
[Dev] orq.ai API: orq.ai API documentation
1616

1717
For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
1818
<!-- End Summary [summary] -->
@@ -32,6 +32,7 @@ For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
3232
* [Error Handling](#error-handling)
3333
* [Server Selection](#server-selection)
3434
* [Custom HTTP Client](#custom-http-client)
35+
* [Resource Management](#resource-management)
3536
* [Debugging](#debugging)
3637
* [Development](#development)
3738
* [Maturity](#maturity)
@@ -42,6 +43,11 @@ For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
4243
<!-- Start SDK Installation [installation] -->
4344
## SDK Installation
4445

46+
> [!NOTE]
47+
> **Python version upgrade policy**
48+
>
49+
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
50+
4551
The SDK can be installed with either *pip* or *poetry* package managers.
4652

4753
### PIP
@@ -161,9 +167,9 @@ with Orq(
161167
### [deployments](docs/sdks/deploymentssdk/README.md)
162168

163169
* [list](docs/sdks/deploymentssdk/README.md#list) - List all deployments
164-
* [invalidate](docs/sdks/deploymentssdk/README.md#invalidate) - Invalidates cache
165170
* [get_config](docs/sdks/deploymentssdk/README.md#get_config) - Get config
166171
* [invoke](docs/sdks/deploymentssdk/README.md#invoke) - Invoke
172+
* [stream](docs/sdks/deploymentssdk/README.md#stream) - Stream
167173

168174
#### [deployments.metrics](docs/sdks/metrics/README.md)
169175

@@ -178,31 +184,24 @@ with Orq(
178184
* [upload](docs/sdks/files/README.md#upload) - Upload file
179185
* [list](docs/sdks/files/README.md#list) - List all files
180186
* [get](docs/sdks/files/README.md#get) - Get file by ID
181-
* [update](docs/sdks/files/README.md#update) - Update file name
182187
* [delete](docs/sdks/files/README.md#delete) - Delete file
183-
* [bulk_upload](docs/sdks/files/README.md#bulk_upload) - Bulk upload file
184-
185-
186-
### [prompt](docs/sdks/prompt/README.md)
187-
188-
189-
#### [prompt.snippets](docs/sdks/snippets/README.md)
190188

191-
* [find_one](docs/sdks/snippets/README.md#find_one) - Get one prompt snippet
192189

193-
#### [prompt.templates](docs/sdks/templates/README.md)
190+
### [prompt_snippets](docs/sdks/promptsnippets/README.md)
194191

195-
* [get_all](docs/sdks/templates/README.md#get_all) - Get all prompt templates
192+
* [create](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
193+
* [update](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
194+
* [delete](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
195+
* [get](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
196+
* [get_by_key](docs/sdks/promptsnippets/README.md#get_by_key) - Retrieve a prompt snippet by key
196197

197198
### [prompts](docs/sdks/prompts/README.md)
198199

199-
* [create](docs/sdks/prompts/README.md#create) - Create a new prompt
200-
* [create_version](docs/sdks/prompts/README.md#create_version) - Create a new prompt version
201-
* [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
202-
* [get_one](docs/sdks/prompts/README.md#get_one) - Get one prompt
200+
* [create](docs/sdks/prompts/README.md#create) - Create a prompt
203201
* [update](docs/sdks/prompts/README.md#update) - Update a prompt
204-
* [duplicate](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
205-
* [get_all](docs/sdks/prompts/README.md#get_all) - Get all prompts
202+
* [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
203+
* [get](docs/sdks/prompts/README.md#get) - Retrieve a prompt
204+
* [list](docs/sdks/prompts/README.md#list) - List all prompts
206205

207206
### [remoteconfig](docs/sdks/remoteconfig/README.md)
208207

@@ -231,7 +230,7 @@ with Orq(
231230
api_key=os.getenv("ORQ_API_KEY", ""),
232231
) as orq:
233232

234-
res = orq.deployments.invoke(key="<key>", stream=False)
233+
res = orq.deployments.stream(key="<key>")
235234

236235
assert res is not None
237236

@@ -354,7 +353,7 @@ with Orq(
354353
res = None
355354
try:
356355

357-
res = orq.deployments.list(limit=10)
356+
res = orq.deployments.list()
358357

359358
assert res is not None
360359

@@ -476,6 +475,32 @@ s = Orq(async_client=CustomClient(httpx.AsyncClient()))
476475
```
477476
<!-- End Custom HTTP Client [http-client] -->
478477

478+
<!-- Start Resource Management [resource-management] -->
479+
## Resource Management
480+
481+
The `Orq` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
482+
483+
[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
484+
485+
```python
486+
from orq_ai_sdk import Orq
487+
import os
488+
def main():
489+
with Orq(
490+
api_key=os.getenv("ORQ_API_KEY", ""),
491+
) as orq:
492+
# Rest of application here...
493+
494+
495+
# Or when using async:
496+
async def amain():
497+
async with Orq(
498+
api_key=os.getenv("ORQ_API_KEY", ""),
499+
) as orq:
500+
# Rest of application here...
501+
```
502+
<!-- End Resource Management [resource-management] -->
503+
479504
<!-- Start Debugging [debug] -->
480505
## Debugging
481506

‎packages/orq-rc/RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,14 @@ Based on:
6868
### Generated
6969
- [python v3.1.0-rc.10] packages/orq-rc
7070
### Releases
71-
- [PyPI v3.1.0-rc.10] https://pypi.org/project/orq-ai-sdk/3.1.0-rc.10 - packages/orq-rc
71+
- [PyPI v3.1.0-rc.10] https://pypi.org/project/orq-ai-sdk/3.1.0-rc.10 - packages/orq-rc
72+
73+
## 2025-01-31 08:07:19
74+
### Changes
75+
Based on:
76+
- OpenAPI Doc
77+
- Speakeasy CLI 1.480.1 (2.499.1) https://github.com/speakeasy-api/speakeasy
78+
### Generated
79+
- [python v3.1.0-rc.26] packages/orq-rc
80+
### Releases
81+
- [PyPI v3.1.0-rc.26] https://pypi.org/project/orq-ai-sdk/3.1.0-rc.26 - packages/orq-rc

‎packages/orq-rc/docs/models/bulkfileuploadfiles.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎packages/orq-rc/docs/models/bulkfileuploadfilespurpose.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎packages/orq-rc/docs/models/bulkfileuploadpurpose.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎packages/orq-rc/docs/models/bulkfileuploadrequestbody.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎packages/orq-rc/docs/models/createcontactglobals.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreateContactGlobals
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `contact_id` | *Optional[str]* | :heavy_minus_sign: | N/A |

‎packages/orq-rc/docs/models/createfeedbackglobals.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreateFeedbackGlobals
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `contact_id` | *Optional[str]* | :heavy_minus_sign: | N/A |

‎packages/orq-rc/docs/models/createprompt2promptsresponse1.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CreatePrompt2PromptsResponse1
2+
3+
Text content part of a prompt message
4+
5+
6+
## Fields
7+
8+
| Field | Type | Required | Description |
9+
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
10+
| `type` | [models.CreatePrompt2PromptsResponse200ApplicationJSONType](../models/createprompt2promptsresponse200applicationjsontype.md) | :heavy_check_mark: | N/A |
11+
| `text` | *str* | :heavy_check_mark: | N/A |

‎packages/orq-rc/docs/models/createprompt2promptsresponse2.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CreatePrompt2PromptsResponse2
2+
3+
The image part of the prompt message. Only supported with vision models.
4+
5+
6+
## Fields
7+
8+
| Field | Type | Required | Description |
9+
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
10+
| `type` | [models.CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyType](../models/createprompt2promptsresponse200applicationjsonresponsebodytype.md) | :heavy_check_mark: | N/A |
11+
| `image_url` | [models.CreatePrompt2PromptsResponseImageURL](../models/createprompt2promptsresponseimageurl.md) | :heavy_check_mark: | N/A |

‎packages/orq-rc/docs/models/createprompt2promptsresponse200applicationjsonresponsebodytype.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyType
2+
3+
4+
## Values
5+
6+
| Name | Value |
7+
| ----------- | ----------- |
8+
| `IMAGE_URL` | image_url |

‎packages/orq-rc/docs/models/createprompt2promptsresponse200applicationjsontype.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreatePrompt2PromptsResponse200ApplicationJSONType
2+
3+
4+
## Values
5+
6+
| Name | Value |
7+
| ------ | ------ |
8+
| `TEXT` | text |

‎packages/orq-rc/docs/models/createprompt2promptsresponseimageurl.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CreatePrompt2PromptsResponseImageURL
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
8+
| `url` | *str* | :heavy_check_mark: | Either a URL of the image or the base64 encoded data URI. |
9+
| `id` | *Optional[str]* | :heavy_minus_sign: | The orq.ai id of the image |
10+
| `detail` | *Optional[str]* | :heavy_minus_sign: | Specifies the detail level of the image. Currently only supported with OpenAI models |

‎packages/orq-rc/docs/models/createpromptcontentpromptsresponse2.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# CreatePromptContentPromptsResponse2
2+
3+
4+
## Supported Types
5+
6+
### `models.CreatePrompt2PromptsResponse1`
7+
8+
```python
9+
value: models.CreatePrompt2PromptsResponse1 = /* values here */
10+
```
11+
12+
### `models.CreatePrompt2PromptsResponse2`
13+
14+
```python
15+
value: models.CreatePrompt2PromptsResponse2 = /* values here */
16+
```
17+

‎packages/orq-rc/docs/models/createpromptglobals.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreatePromptGlobals
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `contact_id` | *Optional[str]* | :heavy_minus_sign: | N/A |

‎packages/orq-rc/docs/models/createpromptlanguage.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CreatePromptLanguage
2+
3+
The language that the prompt is written in. Use this field to categorize the prompt for your own purpose
4+
5+
6+
## Values
7+
8+
| Name | Value |
9+
| --------- | --------- |
10+
| `CHINESE` | Chinese |
11+
| `DUTCH` | Dutch |
12+
| `ENGLISH` | English |
13+
| `FRENCH` | French |
14+
| `GERMAN` | German |
15+
| `RUSSIAN` | Russian |
16+
| `SPANISH` | Spanish |

0 commit comments

Comments
 (0)