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 finetuned 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.20.tar.gz (155.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.20-py3-none-any.whl (168.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: orca_sdk-0.1.20.tar.gz
  • Upload date:
  • Size: 155.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.20.tar.gz
Algorithm Hash digest
SHA256 8c42e534aa252ee07534a6ac127f7fde51b27e3220d7229a3b924a87ef799ec8
MD5 88f4e7242305341e842837edc1df1070
BLAKE2b-256 72f2efd51269b5d361af4d372e49b0a403975903689b452a9ec531aea45cd442

See more details on using hashes here.

Provenance

The following attestation bundles were made for orca_sdk-0.1.20.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.20-py3-none-any.whl.

File metadata

  • Download URL: orca_sdk-0.1.20-py3-none-any.whl
  • Upload date:
  • Size: 168.4 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.20-py3-none-any.whl
Algorithm Hash digest
SHA256 8d23a3bfc40390f71e72701e5cee5de4235bd2e350cbfef24ecde57fe742469a
MD5 89067f0d049be39132dfb6d3f2d6a7a1
BLAKE2b-256 66c499da46a61b4fb4c8724fb167dfbd699c0effe06f7f385a8fca44c785fb9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for orca_sdk-0.1.20-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