orca-sdk 0.0.78__tar.gz

orca_sdk-0.0.78/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.1
+Name: orca_sdk
+Version: 0.0.78
+Summary: SDK for interacting with Orca Services
+License: Apache-2.0
+Author: Orca DB Inc.
+Author-email: dev-rel@orcadb.ai
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: attrs (>=22.2.0)
+Requires-Dist: datasets (>=3.1.0,<4.0.0)
+Requires-Dist: gradio (==5.13.0)
+Requires-Dist: httpx (>=0.20.0,<0.29.0)
+Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: pyarrow (>=18.0.0,<19.0.0)
+Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
+Requires-Dist: torch (>=2.5.1,<3.0.0)
+Description-Content-Type: text/markdown
+
+<!--
+IMPORTANT NOTE:
+- This file will get rendered in the public facing PyPi page here: https://pypi.org/project/orca_sdk/
+- Only content suitable for public consumption should be placed in this file everything else should go into CONTRIBUTING.md
+-->
+
+# OrcaSDK
+
+OrcaSDK is a Python library for building and using retrieval-augmented models with [OrcaCloud](https://orcadb.ai). It enables you to create, deploy, and maintain models that can adapt to changing circumstances without retraining by accessing external data called "memories."
+
+## Documentation
+
+You can find the documentation for all things Orca at [docs.orcadb.ai](https://docs.orcadb.ai). This includes tutorials, how-to guides, and the full interface reference for OrcaSDK.
+
+## Features
+
+- **Labeled Memorysets**: Store and manage labeled examples that your models can use to guide predictions
+- **Classification Models**: Build retrieval-augmented classification models that adapt to new data without retraining
+- **Embedding Models**: Use pre-trained or fine-tuned embedding models to represent your data
+- **Telemetry**: Collect feedback and monitor memory usage to optimize model performance
+- **Datasources**: Easily ingest data from various sources into your memorysets
+
+## Installation
+
+Orca SDK is compatible with Python 3.10 or higher and is available on [PyPI](https://pypi.org/project/orca_sdk/). You can install it with your favorite python package manager:
+
+- Pip: `pip install orca_sdk`
+- Conda: `conda install orca_sdk`
+- Poetry: `poetry add orca_sdk`
+
+## Quick Start
+
+```python
+from dotenv import load_dotenv
+from orca_sdk import OrcaCredentials, LabeledMemoryset, ClassificationModel
+
+# Load your API key from environment variables
+load_dotenv()
+assert OrcaCredentials.is_authenticated()
+
+# Create a labeled memoryset
+memoryset = LabeledMemoryset.from_disk("my_memoryset", "./data.jsonl")
+
+# Create a classification model using the memoryset
+model = ClassificationModel("my_model", memoryset)
+
+# Make predictions
+prediction = model.predict("my input")
+```
+
+For a more detailed walkthrough, check out our [Quick Start Guide](https://docs.orcadb.ai/quickstart/).
+
+## Support
+
+If you have any questions, please reach out to us at support@orcadb.ai.
+

orca_sdk-0.0.78/README.md

@@ -0,0 +1,55 @@
+<!--
+IMPORTANT NOTE:
+- This file will get rendered in the public facing PyPi page here: https://pypi.org/project/orca_sdk/
+- Only content suitable for public consumption should be placed in this file everything else should go into CONTRIBUTING.md
+-->
+
+# OrcaSDK
+
+OrcaSDK is a Python library for building and using retrieval-augmented models with [OrcaCloud](https://orcadb.ai). It enables you to create, deploy, and maintain models that can adapt to changing circumstances without retraining by accessing external data called "memories."
+
+## Documentation
+
+You can find the documentation for all things Orca at [docs.orcadb.ai](https://docs.orcadb.ai). This includes tutorials, how-to guides, and the full interface reference for OrcaSDK.
+
+## Features
+
+- **Labeled Memorysets**: Store and manage labeled examples that your models can use to guide predictions
+- **Classification Models**: Build retrieval-augmented classification models that adapt to new data without retraining
+- **Embedding Models**: Use pre-trained or fine-tuned embedding models to represent your data
+- **Telemetry**: Collect feedback and monitor memory usage to optimize model performance
+- **Datasources**: Easily ingest data from various sources into your memorysets
+
+## Installation
+
+Orca SDK is compatible with Python 3.10 or higher and is available on [PyPI](https://pypi.org/project/orca_sdk/). You can install it with your favorite python package manager:
+
+- Pip: `pip install orca_sdk`
+- Conda: `conda install orca_sdk`
+- Poetry: `poetry add orca_sdk`
+
+## Quick Start
+
+```python
+from dotenv import load_dotenv
+from orca_sdk import OrcaCredentials, LabeledMemoryset, ClassificationModel
+
+# Load your API key from environment variables
+load_dotenv()
+assert OrcaCredentials.is_authenticated()
+
+# Create a labeled memoryset
+memoryset = LabeledMemoryset.from_disk("my_memoryset", "./data.jsonl")
+
+# Create a classification model using the memoryset
+model = ClassificationModel("my_model", memoryset)
+
+# Make predictions
+prediction = model.predict("my input")
+```
+
+For a more detailed walkthrough, check out our [Quick Start Guide](https://docs.orcadb.ai/quickstart/).
+
+## Support
+
+If you have any questions, please reach out to us at support@orcadb.ai.

orca_sdk-0.0.78/orca_sdk/__init__.py

@@ -0,0 +1,24 @@
+"""
+OrcaSDK is a Python library for building and using retrieval augmented models in the OrcaCloud.
+"""
+
+from ._utils.common import UNSET, CreateMode, DropMode
+from ._utils.task import TaskStatus
+from .classification_model import ClassificationModel
+from .credentials import OrcaCredentials
+from .datasource import Datasource
+from .embedding_model import (
+    FinetunedEmbeddingModel,
+    PretrainedEmbeddingModel,
+    PretrainedEmbeddingModelName,
+)
+from .memoryset import (
+    FilterItemTuple,
+    LabeledMemory,
+    LabeledMemoryLookup,
+    LabeledMemoryset,
+)
+from .telemetry import LabelPrediction
+
+# only specify things that should show up on the root page of the reference docs because they are in private modules
+__all__ = ["TaskStatus", "UNSET", "CreateMode", "DropMode"]

orca_sdk-0.0.78/orca_sdk/_generated_api_client/__init__.py

@@ -0,0 +1,3 @@
+import logging
+
+logging.getLogger("httpx").setLevel(logging.WARNING)

orca_sdk-0.0.78/orca_sdk/_generated_api_client/api/__init__.py

@@ -0,0 +1,205 @@
+"""Contains methods for accessing the API"""
+
+from .auth.check_authentication_auth_get import sync as check_authentication
+from .auth.create_api_key_auth_api_key_post import sync as create_api_key
+from .auth.delete_api_key_auth_api_key_name_or_id_delete import sync as delete_api_key
+from .auth.delete_org_auth_org_delete import sync as delete_org
+from .auth.list_api_keys_auth_api_key_get import sync as list_api_keys
+from .classification_model.create_evaluation_classification_model_model_name_or_id_evaluation_post import (
+    sync as create_evaluation,
+)
+from .classification_model.create_model_classification_model_post import (
+    sync as create_model,
+)
+from .classification_model.delete_evaluation_classification_model_model_name_or_id_evaluation_task_id_delete import (
+    sync as delete_evaluation,
+)
+from .classification_model.delete_model_classification_model_name_or_id_delete import (
+    sync as delete_model,
+)
+from .classification_model.get_evaluation_classification_model_model_name_or_id_evaluation_task_id_get import (
+    sync as get_evaluation,
+)
+from .classification_model.get_model_classification_model_name_or_id_get import (
+    sync as get_model,
+)
+from .classification_model.list_evaluations_classification_model_model_name_or_id_evaluation_get import (
+    sync as list_evaluations,
+)
+from .classification_model.list_models_classification_model_get import (
+    sync as list_models,
+)
+from .classification_model.predict_gpu_classification_model_name_or_id_prediction_post import (
+    sync as predict_gpu,
+)
+from .datasource.create_datasource_datasource_post import sync as create_datasource
+from .datasource.create_embedding_evaluation_datasource_name_or_id_embedding_evaluation_post import (
+    sync as create_embedding_evaluation,
+)
+from .datasource.delete_datasource_datasource_name_or_id_delete import (
+    sync as delete_datasource,
+)
+from .datasource.get_datasource_datasource_name_or_id_get import sync as get_datasource
+from .datasource.get_embedding_evaluation_datasource_name_or_id_embedding_evaluation_task_id_get import (
+    sync as get_embedding_evaluation,
+)
+from .datasource.list_datasources_datasource_get import sync as list_datasources
+from .datasource.list_embedding_evaluations_datasource_name_or_id_embedding_evaluation_get import (
+    sync as list_embedding_evaluations,
+)
+from .default.healthcheck_get import sync as healthcheck
+from .default.healthcheck_gpu_get import sync as healthcheck_gpu
+from .finetuned_embedding_model.create_finetuned_embedding_model_finetuned_embedding_model_post import (
+    sync as create_finetuned_embedding_model,
+)
+from .finetuned_embedding_model.delete_finetuned_embedding_model_finetuned_embedding_model_name_or_id_delete import (
+    sync as delete_finetuned_embedding_model,
+)
+from .finetuned_embedding_model.embed_with_finetuned_model_gpu_finetuned_embedding_model_name_or_id_embedding_post import (
+    sync as embed_with_finetuned_model_gpu,
+)
+from .finetuned_embedding_model.get_finetuned_embedding_model_finetuned_embedding_model_name_or_id_get import (
+    sync as get_finetuned_embedding_model,
+)
+from .finetuned_embedding_model.list_finetuned_embedding_models_finetuned_embedding_model_get import (
+    sync as list_finetuned_embedding_models,
+)
+from .memoryset.clone_memoryset_memoryset_name_or_id_clone_post import (
+    sync as clone_memoryset,
+)
+from .memoryset.create_analysis_memoryset_name_or_id_analysis_post import (
+    sync as create_analysis,
+)
+from .memoryset.create_memoryset_memoryset_post import sync as create_memoryset
+from .memoryset.delete_memories_memoryset_name_or_id_memories_delete_post import (
+    sync as delete_memories,
+)
+from .memoryset.delete_memory_memoryset_name_or_id_memory_memory_id_delete import (
+    sync as delete_memory,
+)
+from .memoryset.delete_memoryset_memoryset_name_or_id_delete import (
+    sync as delete_memoryset,
+)
+from .memoryset.get_analysis_memoryset_name_or_id_analysis_analysis_task_id_get import (
+    sync as get_analysis,
+)
+from .memoryset.get_memories_memoryset_name_or_id_memories_get_post import (
+    sync as get_memories,
+)
+from .memoryset.get_memory_memoryset_name_or_id_memory_memory_id_get import (
+    sync as get_memory,
+)
+from .memoryset.get_memoryset_memoryset_name_or_id_get import sync as get_memoryset
+from .memoryset.insert_memories_gpu_memoryset_name_or_id_memory_post import (
+    sync as insert_memories_gpu,
+)
+from .memoryset.list_analyses_memoryset_name_or_id_analysis_get import (
+    sync as list_analyses,
+)
+from .memoryset.list_memorysets_memoryset_get import sync as list_memorysets
+from .memoryset.memoryset_lookup_gpu_memoryset_name_or_id_lookup_post import (
+    sync as memoryset_lookup_gpu,
+)
+from .memoryset.query_memoryset_memoryset_name_or_id_memories_post import (
+    sync as query_memoryset,
+)
+from .memoryset.update_memories_gpu_memoryset_name_or_id_memories_patch import (
+    sync as update_memories_gpu,
+)
+from .memoryset.update_memory_gpu_memoryset_name_or_id_memory_patch import (
+    sync as update_memory_gpu,
+)
+from .pretrained_embedding_model.embed_with_pretrained_model_gpu_pretrained_embedding_model_model_name_embedding_post import (
+    sync as embed_with_pretrained_model_gpu,
+)
+from .pretrained_embedding_model.get_pretrained_embedding_model_pretrained_embedding_model_model_name_get import (
+    sync as get_pretrained_embedding_model,
+)
+from .pretrained_embedding_model.list_pretrained_embedding_models_pretrained_embedding_model_get import (
+    sync as list_pretrained_embedding_models,
+)
+from .task.abort_task_task_task_id_abort_delete import sync as abort_task
+from .task.get_task_status_task_task_id_status_get import sync as get_task_status_task
+from .task.list_tasks_task_get import sync as list_tasks
+from .telemetry.drop_feedback_category_with_data_telemetry_feedback_category_name_or_id_delete import (
+    sync as drop_feedback_category_with_data,
+)
+from .telemetry.get_feedback_category_telemetry_feedback_category_name_or_id_get import (
+    sync as get_feedback_category,
+)
+from .telemetry.get_prediction_telemetry_prediction_prediction_id_get import (
+    sync as get_prediction,
+)
+from .telemetry.list_feedback_categories_telemetry_feedback_category_get import (
+    sync as list_feedback_categories,
+)
+from .telemetry.list_predictions_telemetry_prediction_post import (
+    sync as list_predictions,
+)
+from .telemetry.record_prediction_feedback_telemetry_prediction_feedback_put import (
+    sync as record_prediction_feedback,
+)
+from .telemetry.update_prediction_telemetry_prediction_prediction_id_patch import (
+    sync as update_prediction,
+)
+
+__all__ = [
+    "abort_task",
+    "check_authentication",
+    "clone_memoryset",
+    "create_analysis",
+    "create_api_key",
+    "create_datasource",
+    "create_embedding_evaluation",
+    "create_evaluation",
+    "create_finetuned_embedding_model",
+    "create_memoryset",
+    "create_model",
+    "delete_api_key",
+    "delete_datasource",
+    "delete_evaluation",
+    "delete_finetuned_embedding_model",
+    "delete_memories",
+    "delete_memory",
+    "delete_memoryset",
+    "delete_model",
+    "delete_org",
+    "drop_feedback_category_with_data",
+    "embed_with_finetuned_model_gpu",
+    "embed_with_pretrained_model_gpu",
+    "get_analysis",
+    "get_datasource",
+    "get_embedding_evaluation",
+    "get_evaluation",
+    "get_feedback_category",
+    "get_finetuned_embedding_model",
+    "get_memories",
+    "get_memory",
+    "get_memoryset",
+    "get_model",
+    "get_prediction",
+    "get_pretrained_embedding_model",
+    "get_task_status_task",
+    "healthcheck",
+    "healthcheck_gpu",
+    "insert_memories_gpu",
+    "list_analyses",
+    "list_api_keys",
+    "list_datasources",
+    "list_embedding_evaluations",
+    "list_evaluations",
+    "list_feedback_categories",
+    "list_finetuned_embedding_models",
+    "list_memorysets",
+    "list_models",
+    "list_predictions",
+    "list_pretrained_embedding_models",
+    "list_tasks",
+    "memoryset_lookup_gpu",
+    "predict_gpu",
+    "query_memoryset",
+    "record_prediction_feedback",
+    "update_memories_gpu",
+    "update_memory_gpu",
+    "update_prediction",
+]

orca_sdk-0.0.78/orca_sdk/_generated_api_client/api/auth/check_authentication_auth_get.py

@@ -0,0 +1,130 @@
+"""
+This file is generated by the openapi-python-client tool via the generate_api_client.py script
+
+It is a customized template from the openapi-python-client tool's default template:
+https://github.com/openapi-generators/openapi-python-client/blob/861ef5622f10fc96d240dc9becb0edf94e61446c/openapi_python_client/templates/endpoint_module.py.jinja
+
+The main changes are:
+- Update the API call responses to either return the successful response type or raise an error by:
+    - Updating the _parse_response function to raise an error if the response status code is not in the 2xx range
+- Inject a client into every method via a context manager
+"""
+
+from http import HTTPStatus
+from typing import Any, cast
+
+import httpx
+
+from ...client import _client_context
+from ...errors import get_error_for_response
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/auth/",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, response: httpx.Response) -> bool:
+    if response.status_code == 200:
+        response_200 = cast(bool, response.json())
+        return response_200
+    if response.status_code == 401:
+        raise get_error_for_response(response)
+    if response.status_code == 500:
+        raise get_error_for_response(response)
+    if response.status_code == 503:
+        raise get_error_for_response(response)
+    if response.status_code == 422:
+        raise get_error_for_response(response)
+    else:
+        raise get_error_for_response(response)
+
+
+def _build_response(*, response: httpx.Response) -> Response[bool]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def sync_detailed() -> Response[bool]:
+    """Check Authentication
+
+     Returns true if the api key header is valid for the org (will be false for admin api key)
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[bool]
+    """
+
+    kwargs = _get_kwargs()
+
+    with _client_context() as client:
+        response = client.get_httpx_client().request(
+            **kwargs,
+        )
+
+        return _build_response(response=response)
+
+
+def sync() -> bool:
+    """Check Authentication
+
+     Returns true if the api key header is valid for the org (will be false for admin api key)
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        bool
+    """
+
+    return sync_detailed().parsed
+
+
+async def asyncio_detailed() -> Response[bool]:
+    """Check Authentication
+
+     Returns true if the api key header is valid for the org (will be false for admin api key)
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[bool]
+    """
+
+    kwargs = _get_kwargs()
+
+    with _client_context() as client:
+        response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(response=response)
+
+
+async def asyncio() -> bool:
+    """Check Authentication
+
+     Returns true if the api key header is valid for the org (will be false for admin api key)
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        bool
+    """
+
+    return (await asyncio_detailed()).parsed

orca_sdk-0.0.78/orca_sdk/_generated_api_client/api/auth/create_api_key_auth_api_key_post.py

@@ -0,0 +1,172 @@
+"""
+This file is generated by the openapi-python-client tool via the generate_api_client.py script
+
+It is a customized template from the openapi-python-client tool's default template:
+https://github.com/openapi-generators/openapi-python-client/blob/861ef5622f10fc96d240dc9becb0edf94e61446c/openapi_python_client/templates/endpoint_module.py.jinja
+
+The main changes are:
+- Update the API call responses to either return the successful response type or raise an error by:
+    - Updating the _parse_response function to raise an error if the response status code is not in the 2xx range
+- Inject a client into every method via a context manager
+"""
+
+from http import HTTPStatus
+from typing import Any, Dict
+
+import httpx
+
+from ...client import _client_context
+from ...errors import get_error_for_response
+from ...models.create_api_key_request import CreateApiKeyRequest
+from ...models.create_api_key_response import CreateApiKeyResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: CreateApiKeyRequest,
+) -> dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/auth/api_key",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, response: httpx.Response) -> CreateApiKeyResponse:
+    if response.status_code == 201:
+        response_201 = CreateApiKeyResponse.from_dict(response.json())
+
+        return response_201
+    if response.status_code == 401:
+        raise get_error_for_response(response)
+    if response.status_code == 500:
+        raise get_error_for_response(response)
+    if response.status_code == 503:
+        raise get_error_for_response(response)
+    if response.status_code == 422:
+        raise get_error_for_response(response)
+    if response.status_code == 403:
+        raise get_error_for_response(response)
+    else:
+        raise get_error_for_response(response)
+
+
+def _build_response(*, response: httpx.Response) -> Response[CreateApiKeyResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    body: CreateApiKeyRequest,
+) -> Response[CreateApiKeyResponse]:
+    """Create Api Key
+
+    Args:
+        body (CreateApiKeyRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[CreateApiKeyResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    with _client_context() as client:
+        response = client.get_httpx_client().request(
+            **kwargs,
+        )
+
+        return _build_response(response=response)
+
+
+def sync(
+    *,
+    body: CreateApiKeyRequest,
+) -> CreateApiKeyResponse:
+    """Create Api Key
+
+    Args:
+        body (CreateApiKeyRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        CreateApiKeyResponse
+    """
+
+    return sync_detailed(
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    body: CreateApiKeyRequest,
+) -> Response[CreateApiKeyResponse]:
+    """Create Api Key
+
+    Args:
+        body (CreateApiKeyRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[CreateApiKeyResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    with _client_context() as client:
+        response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(response=response)
+
+
+async def asyncio(
+    *,
+    body: CreateApiKeyRequest,
+) -> CreateApiKeyResponse:
+    """Create Api Key
+
+    Args:
+        body (CreateApiKeyRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        CreateApiKeyResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            body=body,
+        )
+    ).parsed