Skip to main content

SDK for interacting with Orca Services

Project description

OrcaSDK

OrcaSDK is a Python library for building and using retrieval-augmented models with OrcaCloud. 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. 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

OrcaSDK is compatible with Python 3.10 or higher and is available on PyPI. 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

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")

# Get Action Recommendation
action, rationale = prediction.recommend_action()
print(f"Recommended action: {action}")
print(f"Rationale: {rationale}")

# Generate and add synthetic memory suggestions
if action == "add_memories":
    suggestions = prediction.generate_memory_suggestions(num_memories=3)

    # Review suggestions
    for suggestion in suggestions:
        print(f"Suggested: '{suggestion['value']}' -> {suggestion['label']}")

    # Add suggestions to memoryset
    model.memoryset.insert(suggestions)
    print(f"Added {len(suggestions)} new memories to improve model performance!")

For a more detailed walkthrough, check out our Quick Start Guide.

Support

If you have any questions, please reach out to us at support@orcadb.ai.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orca_sdk-0.1.19.tar.gz (154.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orca_sdk-0.1.19-py3-none-any.whl (167.5 kB view details)

Uploaded Python 3

File details

Details for the file orca_sdk-0.1.19.tar.gz.

File metadata

  • Download URL: orca_sdk-0.1.19.tar.gz
  • Upload date:
  • Size: 154.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for orca_sdk-0.1.19.tar.gz
Algorithm Hash digest
SHA256 2d1d3b99af387d3b90309cf7f1018e200c60909f8d2bfb227cf8dab73d8a9b04
MD5 4600939b9c2417b0b28cf7eb7e85f547
BLAKE2b-256 da9d768372e6d7e6d940a1f1c398be34951fd50268931721ee77ac2cac75cbc6

See more details on using hashes here.

Provenance

The following attestation bundles were made for orca_sdk-0.1.19.tar.gz:

Publisher: orca-sdk-release.yml on OrcaDB/orca

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file orca_sdk-0.1.19-py3-none-any.whl.

File metadata

  • Download URL: orca_sdk-0.1.19-py3-none-any.whl
  • Upload date:
  • Size: 167.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for orca_sdk-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 802dd784a06042bb74332c0e8f5fab8c94c68e23b1d989cf13f6fd13042d2703
MD5 fe3c06ee907be74039798d9b396c357e
BLAKE2b-256 36fc61e0aed5e6496e804f0d93fe30209f21c8a5c73dc89baa278aa509ac12d7

See more details on using hashes here.

Provenance

The following attestation bundles were made for orca_sdk-0.1.19-py3-none-any.whl:

Publisher: orca-sdk-release.yml on OrcaDB/orca

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page