Files SDK Reference - Orq.ai Documentation

Files

List Files

Returns a list of the files that your account has access to. orq.ai sorts and returns the files by their creation dates, placing the most recently created files at the top.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.files.list(limit=10)

    # Handle response
    print(res)

Show Parameters

{
    "limit": Optional[int],
    "starting_after": Optional[str],
    "ending_before": Optional[str],
    "project_id": Optional[str],
}

Show Response

{
    "object": str,
    "data": {
        "file_id": str,
        "purpose": Literal["FILE_PURPOSE_UNSPECIFIED", "FILE_PURPOSE_RETRIEVAL", "FILE_PURPOSE_KNOWLEDGE_DATASOURCE", "FILE_PURPOSE_BATCH"],
        "file_name": str,
        "bytes_": str,
        "created_at": date,
        "project_id": str,
    },
    "has_more": bool,
}

Create a File

Files are used to upload documents that can be used with features like Deployments.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.files.create(filename="example.file", content="<value>")

    # Handle response
    print(res)

Show Parameters

{
    "filename": str,  # required
    "content": str,  # required
    "purpose": Optional[Literal["FILE_PURPOSE_UNSPECIFIED", "FILE_PURPOSE_RETRIEVAL", "FILE_PURPOSE_KNOWLEDGE_DATASOURCE", "FILE_PURPOSE_BATCH"]],
    "content_type": Optional[str],
    "project_id": Optional[str],
}

Show Response

{
    "file": {
        "file_id": str,
        "purpose": Literal["FILE_PURPOSE_UNSPECIFIED", "FILE_PURPOSE_RETRIEVAL", "FILE_PURPOSE_KNOWLEDGE_DATASOURCE", "FILE_PURPOSE_BATCH"],
        "file_name": str,
        "bytes_": str,
        "created_at": date,
        "project_id": str,
    },
}

Get Content

Returns a presigned URL for downloading the file content by file ID.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.files.get_content(file_id_or_path="<value>")

    # Handle response
    print(res)

Show Parameters

{
    "file_id_or_path": str,  # required
}

Show Response

{
    "download_url": str,
}

Retrieve a File

Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.files.get(file_id="<id>")

    # Handle response
    print(res)

Show Parameters

{
    "file_id": str,  # required
}

Show Response

{
    "file": {
        "file_id": str,
        "purpose": Literal["FILE_PURPOSE_UNSPECIFIED", "FILE_PURPOSE_RETRIEVAL", "FILE_PURPOSE_KNOWLEDGE_DATASOURCE", "FILE_PURPOSE_BATCH"],
        "file_name": str,
        "bytes_": str,
        "created_at": date,
        "project_id": str,
    },
}

Delete a File

Permanently deletes a file and its stored content from the project.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.files.delete(file_id="<id>")

    # Handle response
    print(res)

Show Parameters

{
    "file_id": str,  # required
}

Update a File

Updates the metadata of an existing file object.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.files.update(file_id="<id>", file_name="example.file")

    # Handle response
    print(res)

Show Parameters

{
    "file_id": str,  # required
    "file_name": str,  # required
}

Show Response

{
    "file": {
        "file_id": str,
        "purpose": Literal["FILE_PURPOSE_UNSPECIFIED", "FILE_PURPOSE_RETRIEVAL", "FILE_PURPOSE_KNOWLEDGE_DATASOURCE", "FILE_PURPOSE_BATCH"],
        "file_name": str,
        "bytes_": str,
        "created_at": date,
        "project_id": str,
    },
}

​Files

​List Files

​Create a File

​Get Content

​Retrieve a File

​Delete a File

​Update a File

Files

List Files

Create a File

Get Content

Retrieve a File

Delete a File

Update a File