# ragie
<div align="left">
<a href="https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
<!-- Start Summary [summary] -->
## Summary
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [ragie](https://github.com/ragieai/ragie-python/blob/master/#ragie)
* [SDK Installation](https://github.com/ragieai/ragie-python/blob/master/#sdk-installation)
* [IDE Support](https://github.com/ragieai/ragie-python/blob/master/#ide-support)
* [SDK Example Usage](https://github.com/ragieai/ragie-python/blob/master/#sdk-example-usage)
* [Available Resources and Operations](https://github.com/ragieai/ragie-python/blob/master/#available-resources-and-operations)
* [Pagination](https://github.com/ragieai/ragie-python/blob/master/#pagination)
* [File uploads](https://github.com/ragieai/ragie-python/blob/master/#file-uploads)
* [Retries](https://github.com/ragieai/ragie-python/blob/master/#retries)
* [Error Handling](https://github.com/ragieai/ragie-python/blob/master/#error-handling)
* [Server Selection](https://github.com/ragieai/ragie-python/blob/master/#server-selection)
* [Custom HTTP Client](https://github.com/ragieai/ragie-python/blob/master/#custom-http-client)
* [Authentication](https://github.com/ragieai/ragie-python/blob/master/#authentication)
* [Debugging](https://github.com/ragieai/ragie-python/blob/master/#debugging)
* [Development](https://github.com/ragieai/ragie-python/blob/master/#development)
* [Maturity](https://github.com/ragieai/ragie-python/blob/master/#maturity)
* [Contributions](https://github.com/ragieai/ragie-python/blob/master/#contributions)
* [ragie-python](https://github.com/ragieai/ragie-python/blob/master/#ragie-python)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
## SDK Installation
The SDK can be installed with either *pip* or *poetry* package managers.
### PIP
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
```bash
pip install ragie
```
### Poetry
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
```bash
poetry add ragie
```
<!-- End SDK Installation [installation] -->
<!-- Start IDE Support [idesupport] -->
## IDE Support
### PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
# Synchronous Example
from ragie import Ragie
with Ragie(
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.documents.create(request={
"file": {
"file_name": "example.file",
"content": open("example.file", "rb"),
},
})
if res is not None:
# handle response
pass
```
</br>
The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from ragie import Ragie
async def main():
async with Ragie(
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = await s.documents.create_async(request={
"file": {
"file_name": "example.file",
"content": open("example.file", "rb"),
},
})
if res is not None:
# handle response
pass
asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
<details open>
<summary>Available methods</summary>
### [connections](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md)
* [list](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#list) - List Connections
* [create_o_auth_redirect_url](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#create_o_auth_redirect_url) - Create Oauth Redirect Url
* [set_connection_enabled](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#set_connection_enabled) - Set Connection Enabled
* [update_connection](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#update_connection) - Update Connection
* [get_connection](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#get_connection) - Get Connection
* [get_connection_stats](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#get_connection_stats) - Get Connection Stats
* [delete_connection](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#delete_connection) - Delete Connection
### [documents](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md)
* [create](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#create) - Create Document
* [list](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#list) - List Documents
* [create_raw](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#create_raw) - Create Document Raw
* [create_document_from_url](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#create_document_from_url) - Create Document From Url
* [get](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#get) - Get Document
* [delete](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#delete) - Delete Document
* [update_file](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#update_file) - Update Document File
* [update_raw](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#update_raw) - Update Document Raw
* [patch_metadata](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#patch_metadata) - Patch Document Metadata
* [get_summary](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#get_summary) - Get Document Summary
### [entities](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md)
* [list_instructions](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#list_instructions) - List Instructions
* [create_instruction](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#create_instruction) - Create Instruction
* [update_instruction](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#update_instruction) - Update Instruction
* [list_by_instruction](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#list_by_instruction) - Get Instruction Extracted Entities
* [list_by_document](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#list_by_document) - Get Document Extracted Entities
### [retrievals](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/retrievals/README.md)
* [retrieve](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/retrievals/README.md#retrieve) - Retrieve
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- Start Pagination [pagination] -->
## Pagination
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
return value of `Next` is `None`, then there are no more pages to be fetched.
Here's an example of one such pagination call:
```python
from ragie import Ragie
with Ragie(
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.documents.list(request={
"filter_": "{\"department\":{\"$in\":[\"sales\",\"marketing\"]}}",
})
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
break
```
<!-- End Pagination [pagination] -->
<!-- Start File uploads [file-upload] -->
## File uploads
Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
> [!TIP]
>
> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
>
```python
from ragie import Ragie
with Ragie(
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.documents.create(request={
"file": {
"file_name": "example.file",
"content": open("example.file", "rb"),
},
})
if res is not None:
# handle response
pass
```
<!-- End File uploads [file-upload] -->
<!-- Start Retries [retries] -->
## Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from ragie import Ragie
from ragie.utils import BackoffStrategy, RetryConfig
with Ragie(
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.documents.create(request={
"file": {
"file_name": "example.file",
"content": open("example.file", "rb"),
},
},
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
if res is not None:
# handle response
pass
```
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from ragie import Ragie
from ragie.utils import BackoffStrategy, RetryConfig
with Ragie(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.documents.create(request={
"file": {
"file_name": "example.file",
"content": open("example.file", "rb"),
},
})
if res is not None:
# handle response
pass
```
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a models.SDKError exception, which has the following properties:
| Property | Type | Description |
|-----------------|------------------|-----------------------|
| `.status_code` | *int* | The HTTP status code |
| `.message` | *str* | The error message |
| `.raw_response` | *httpx.Response* | The raw HTTP response |
| `.body` | *str* | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_async` method may raise the following exceptions:
| Error Type | Status Code | Content Type |
| -------------------------- | ----------- | ---------------- |
| models.ErrorMessage | 400, 401 | application/json |
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | \*/\* |
### Example
```python
from ragie import Ragie, models
with Ragie(
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = None
try:
res = s.documents.create(request={
"file": {
"file_name": "example.file",
"content": open("example.file", "rb"),
},
})
if res is not None:
# handle response
pass
except models.ErrorMessage as e:
# handle e.data: models.ErrorMessageData
raise(e)
except models.HTTPValidationError as e:
# handle e.data: models.HTTPValidationErrorData
raise(e)
except models.SDKError as e:
# handle exception
raise(e)
```
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
from ragie import Ragie
with Ragie(
server_url="https://api.ragie.ai",
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.documents.create(request={
"file": {
"file_name": "example.file",
"content": open("example.file", "rb"),
},
})
if res is not None:
# handle response
pass
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.
For example, you could specify a header for every request that this sdk makes as follows:
```python
from ragie import Ragie
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Ragie(client=http_client)
```
or you could wrap the client with your own custom logic:
```python
from ragie import Ragie
from ragie.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Ragie(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------ | ---- | ----------- |
| `auth` | http | HTTP Bearer |
To authenticate with the API the `auth` parameter must be set when initializing the SDK client instance. For example:
```python
from ragie import Ragie
with Ragie(
auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.documents.create(request={
"file": {
"file_name": "example.file",
"content": open("example.file", "rb"),
},
})
if res is not None:
# handle response
pass
```
<!-- End Authentication [security] -->
<!-- Start Debugging [debug] -->
## Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
```python
from ragie import Ragie
import logging
logging.basicConfig(level=logging.DEBUG)
s = Ragie(debug_logger=logging.getLogger("ragie"))
```
<!-- End Debugging [debug] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python)
# ragie-python
Raw data
{
"_id": null,
"home_page": "https://github.com/ragieai/ragie-python.git",
"name": "ragie",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c7/b5/862b2f499efeeddd7449deed3d825f6ded64379dc01392dda67c51d84790/ragie-1.3.8.tar.gz",
"platform": null,
"description": "# ragie\n\n<div align=\"left\">\n <a href=\"https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python\"><img src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454\" /></a>\n <a href=\"https://opensource.org/licenses/MIT\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n </a>\n</div>\n\n<!-- Start Summary [summary] -->\n## Summary\n\n\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [ragie](https://github.com/ragieai/ragie-python/blob/master/#ragie)\n * [SDK Installation](https://github.com/ragieai/ragie-python/blob/master/#sdk-installation)\n * [IDE Support](https://github.com/ragieai/ragie-python/blob/master/#ide-support)\n * [SDK Example Usage](https://github.com/ragieai/ragie-python/blob/master/#sdk-example-usage)\n * [Available Resources and Operations](https://github.com/ragieai/ragie-python/blob/master/#available-resources-and-operations)\n * [Pagination](https://github.com/ragieai/ragie-python/blob/master/#pagination)\n * [File uploads](https://github.com/ragieai/ragie-python/blob/master/#file-uploads)\n * [Retries](https://github.com/ragieai/ragie-python/blob/master/#retries)\n * [Error Handling](https://github.com/ragieai/ragie-python/blob/master/#error-handling)\n * [Server Selection](https://github.com/ragieai/ragie-python/blob/master/#server-selection)\n * [Custom HTTP Client](https://github.com/ragieai/ragie-python/blob/master/#custom-http-client)\n * [Authentication](https://github.com/ragieai/ragie-python/blob/master/#authentication)\n * [Debugging](https://github.com/ragieai/ragie-python/blob/master/#debugging)\n* [Development](https://github.com/ragieai/ragie-python/blob/master/#development)\n * [Maturity](https://github.com/ragieai/ragie-python/blob/master/#maturity)\n * [Contributions](https://github.com/ragieai/ragie-python/blob/master/#contributions)\n* [ragie-python](https://github.com/ragieai/ragie-python/blob/master/#ragie-python)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\nThe SDK can be installed with either *pip* or *poetry* package managers.\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install ragie\n```\n\n### Poetry\n\n*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.\n\n```bash\npoetry add ragie\n```\n<!-- End SDK Installation [installation] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom ragie import Ragie\n\nwith Ragie(\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as s:\n res = s.documents.create(request={\n \"file\": {\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n },\n })\n\n if res is not None:\n # handle response\n pass\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom ragie import Ragie\n\nasync def main():\n async with Ragie(\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n ) as s:\n res = await s.documents.create_async(request={\n \"file\": {\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n },\n })\n\n if res is not None:\n # handle response\n pass\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [connections](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md)\n\n* [list](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#list) - List Connections\n* [create_o_auth_redirect_url](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#create_o_auth_redirect_url) - Create Oauth Redirect Url\n* [set_connection_enabled](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#set_connection_enabled) - Set Connection Enabled\n* [update_connection](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#update_connection) - Update Connection\n* [get_connection](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#get_connection) - Get Connection\n* [get_connection_stats](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#get_connection_stats) - Get Connection Stats\n* [delete_connection](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/connections/README.md#delete_connection) - Delete Connection\n\n### [documents](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md)\n\n* [create](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#create) - Create Document\n* [list](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#list) - List Documents\n* [create_raw](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#create_raw) - Create Document Raw\n* [create_document_from_url](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#create_document_from_url) - Create Document From Url\n* [get](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#get) - Get Document\n* [delete](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#delete) - Delete Document\n* [update_file](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#update_file) - Update Document File\n* [update_raw](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#update_raw) - Update Document Raw\n* [patch_metadata](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#patch_metadata) - Patch Document Metadata\n* [get_summary](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/documents/README.md#get_summary) - Get Document Summary\n\n### [entities](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md)\n\n* [list_instructions](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#list_instructions) - List Instructions\n* [create_instruction](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#create_instruction) - Create Instruction\n* [update_instruction](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#update_instruction) - Update Instruction\n* [list_by_instruction](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#list_by_instruction) - Get Instruction Extracted Entities\n* [list_by_document](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/entities/README.md#list_by_document) - Get Document Extracted Entities\n\n\n### [retrievals](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/retrievals/README.md)\n\n* [retrieve](https://github.com/ragieai/ragie-python/blob/master/docs/sdks/retrievals/README.md#retrieve) - Retrieve\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Pagination [pagination] -->\n## Pagination\n\nSome of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the\nreturned response object will have a `Next` method that can be called to pull down the next group of results. If the\nreturn value of `Next` is `None`, then there are no more pages to be fetched.\n\nHere's an example of one such pagination call:\n```python\nfrom ragie import Ragie\n\nwith Ragie(\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as s:\n res = s.documents.list(request={\n \"filter_\": \"{\\\"department\\\":{\\\"$in\\\":[\\\"sales\\\",\\\"marketing\\\"]}}\",\n })\n\n if res is not None:\n while True:\n # handle items\n\n res = res.next()\n if res is None:\n break\n\n```\n<!-- End Pagination [pagination] -->\n\n<!-- Start File uploads [file-upload] -->\n## File uploads\n\nCertain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.\n\n> [!TIP]\n>\n> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.\n>\n\n```python\nfrom ragie import Ragie\n\nwith Ragie(\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as s:\n res = s.documents.create(request={\n \"file\": {\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n },\n })\n\n if res is not None:\n # handle response\n pass\n\n```\n<!-- End File uploads [file-upload] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom ragie import Ragie\nfrom ragie.utils import BackoffStrategy, RetryConfig\n\nwith Ragie(\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as s:\n res = s.documents.create(request={\n \"file\": {\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n },\n },\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n if res is not None:\n # handle response\n pass\n\n```\n\nIf you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:\n```python\nfrom ragie import Ragie\nfrom ragie.utils import BackoffStrategy, RetryConfig\n\nwith Ragie(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as s:\n res = s.documents.create(request={\n \"file\": {\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n },\n })\n\n if res is not None:\n # handle response\n pass\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.\n\nBy default, an API error will raise a models.SDKError exception, which has the following properties:\n\n| Property | Type | Description |\n|-----------------|------------------|-----------------------|\n| `.status_code` | *int* | The HTTP status code |\n| `.message` | *str* | The error message |\n| `.raw_response` | *httpx.Response* | The raw HTTP response |\n| `.body` | *str* | The response content |\n\nWhen custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_async` method may raise the following exceptions:\n\n| Error Type | Status Code | Content Type |\n| -------------------------- | ----------- | ---------------- |\n| models.ErrorMessage | 400, 401 | application/json |\n| models.HTTPValidationError | 422 | application/json |\n| models.SDKError | 4XX, 5XX | \\*/\\* |\n\n### Example\n\n```python\nfrom ragie import Ragie, models\n\nwith Ragie(\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as s:\n res = None\n try:\n res = s.documents.create(request={\n \"file\": {\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n },\n })\n\n if res is not None:\n # handle response\n pass\n\n except models.ErrorMessage as e:\n # handle e.data: models.ErrorMessageData\n raise(e)\n except models.HTTPValidationError as e:\n # handle e.data: models.HTTPValidationErrorData\n raise(e)\n except models.SDKError as e:\n # handle exception\n raise(e)\n```\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:\n```python\nfrom ragie import Ragie\n\nwith Ragie(\n server_url=\"https://api.ragie.ai\",\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as s:\n res = s.documents.create(request={\n \"file\": {\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n },\n })\n\n if res is not None:\n # handle response\n pass\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.\nDepending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.\nThis allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom ragie import Ragie\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = Ragie(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom ragie import Ragie\nfrom ragie.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n client: AsyncHttpClient\n\n def __init__(self, client: AsyncHttpClient):\n self.client = client\n\n async def send(\n self,\n request: httpx.Request,\n *,\n stream: bool = False,\n auth: Union[\n httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n ] = httpx.USE_CLIENT_DEFAULT,\n follow_redirects: Union[\n bool, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n ) -> httpx.Response:\n request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n return await self.client.send(\n request, stream=stream, auth=auth, follow_redirects=follow_redirects\n )\n\n def build_request(\n self,\n method: str,\n url: httpx._types.URLTypes,\n *,\n content: Optional[httpx._types.RequestContent] = None,\n data: Optional[httpx._types.RequestData] = None,\n files: Optional[httpx._types.RequestFiles] = None,\n json: Optional[Any] = None,\n params: Optional[httpx._types.QueryParamTypes] = None,\n headers: Optional[httpx._types.HeaderTypes] = None,\n cookies: Optional[httpx._types.CookieTypes] = None,\n timeout: Union[\n httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n extensions: Optional[httpx._types.RequestExtensions] = None,\n ) -> httpx.Request:\n return self.client.build_request(\n method,\n url,\n content=content,\n data=data,\n files=files,\n json=json,\n params=params,\n headers=headers,\n cookies=cookies,\n timeout=timeout,\n extensions=extensions,\n )\n\ns = Ragie(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| ------ | ---- | ----------- |\n| `auth` | http | HTTP Bearer |\n\nTo authenticate with the API the `auth` parameter must be set when initializing the SDK client instance. For example:\n```python\nfrom ragie import Ragie\n\nwith Ragie(\n auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n) as s:\n res = s.documents.create(request={\n \"file\": {\n \"file_name\": \"example.file\",\n \"content\": open(\"example.file\", \"rb\"),\n },\n })\n\n if res is not None:\n # handle response\n pass\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom ragie import Ragie\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = Ragie(debug_logger=logging.getLogger(\"ragie\"))\n```\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.\nWe look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.\n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python)\n\n# ragie-python\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy.",
"version": "1.3.8",
"project_urls": {
"Homepage": "https://github.com/ragieai/ragie-python.git",
"Repository": "https://github.com/ragieai/ragie-python.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31b4772b91a2a1f783e43fee959eba6cc2ee230c960fdb34e12c4d811d27aa93",
"md5": "94b0138e3203abd2850bb82400a45ac1",
"sha256": "8b6638660b1c51738091f51209f57fda0446c10698020366c88ff242fed54a3d"
},
"downloads": -1,
"filename": "ragie-1.3.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94b0138e3203abd2850bb82400a45ac1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 80860,
"upload_time": "2024-12-07T00:49:49",
"upload_time_iso_8601": "2024-12-07T00:49:49.600669Z",
"url": "https://files.pythonhosted.org/packages/31/b4/772b91a2a1f783e43fee959eba6cc2ee230c960fdb34e12c4d811d27aa93/ragie-1.3.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c7b5862b2f499efeeddd7449deed3d825f6ded64379dc01392dda67c51d84790",
"md5": "06b06eef2a5f60618fa49e1778a426a9",
"sha256": "daf60d5b10e4dabc96b1f1ea54dbf21d3077be22dfaf57941d92d9fb67ff993c"
},
"downloads": -1,
"filename": "ragie-1.3.8.tar.gz",
"has_sig": false,
"md5_digest": "06b06eef2a5f60618fa49e1778a426a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 48342,
"upload_time": "2024-12-07T00:49:51",
"upload_time_iso_8601": "2024-12-07T00:49:51.159124Z",
"url": "https://files.pythonhosted.org/packages/c7/b5/862b2f499efeeddd7449deed3d825f6ded64379dc01392dda67c51d84790/ragie-1.3.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-07 00:49:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ragieai",
"github_project": "ragie-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ragie"
}
JSON
