Pieces OS Client SDK For Python

Introduction

The Pieces OS Client SDK is a powerful code engine package designed for writing applications on top of Pieces OS. It facilitates communication with a locally hosted server to enable features such as copilot chats, asset saving, and more.

Features

The Pieces SDK offers the following key features:

1. Copilot Chats: Communicate seamlessly with copilot chats functionality.
2. Asset Management: Save and manage assets and formats efficiently.
3. Local Server Interaction: Interact with a locally hosted server for various functionalities.
4. Multi LLMs support: Use any Pieces supported LLM to power your app.

Installation

To get started with the Pieces OS Client SDK, follow these steps:

1. Download Pieces OS: Pieces OS serves as the primary backend service, providing essential functionality for the SDK. Download the appropriate version for your operating system:

   • macOS
   • Windows
   • Linux

2. Install the SDK: Use pip to install the Pieces OS Client SDK package:

   pip install pieces_os_client
   

Basic Usage

The Pieces OS Client SDK has a built-in wrapper that simplifies the process of interacting with the Pieces OS server. Here's how you can get started with the wrapper.

Initialize the Pieces Client

from pieces_os_client.wrapper import PiecesClient
import platform

# Defining the port based on the operating system
platform_info = platform.platform()
if 'Linux' in platform_info:
   port = 5323
else:
   port = 1000

pieces_client = PiecesClient(config={'host': f'http://localhost:{port}'})

Determining Your Base URL

In the code snippet above, we use the platform package to determine the base URL based on the operating system. However, you can also set the base URL manually if you know your application will only run on a specific operating system.

• Local Instance of Pieces OS:
  • On macOS/Windows, use http://localhost:1000
  • On Linux, use http://localhost:5323
• Remote Instance of Pieces OS:
  • Use the URL you have set up for your remote instance

Create a New Asset

To create a new asset, you can use the create_asset method of the Pieces Client. Here's an example of how to create a new asset:

from pieces_os_client.wrapper import PiecesClient
from pieces_os_client import FragmentMetadata

# Replace 'your_base_url' with the base URL of your Pieces OS server
pieces_client = PiecesClient(config={'host': 'your_base_url'})

# Set the content and metadata for the new asset
content = "print('Hello, World!')"
metadata = FragmentMetadata(ext=ClassificationSpecificEnum.PY) # optional metadata

# Create the new asset using the content and metadata
new_asset_id = pieces_client.create_asset(content, metadata)

print(f"Created asset with ID: {new_asset_id}")

Get All Assets

To get all your assets, you can use the assets method of the Pieces Client. Here's an example of how to get all your assets and print their names:

from pieces_os_client.wrapper import PiecesClient

# Replace 'your_base_url' with the base URL of your Pieces OS server
pieces_client = PiecesClient(config={'host': 'your_base_url'})

# Get all assets and print their names
assets = pieces_client.assets()
for asset in assets:
   logger.info(f"Asset Name: {asset.name}")

Ask a Question to Pieces Copilot

To ask a question to Pieces Copilot and stream the response, you can use the stream_question method of the Pieces Client. Here's an example of how to ask a question and stream the response:

from pieces_os_client.wrapper import PiecesClient

pieces_client = PiecesClient(config={'host': 'your_base_url'})

# Set the question you want to ask
question = "What is Object-Oriented Programming?"

# Ask the question and stream the response
for response in pieces_client.copilot.stream_question(question):
   if response.question:
         # Each answer is a chunk of the entire response to the question
         answers = response.question.answers.iterable
         for answer in answers:
            print(answer.text,end="")

Next Steps

You can explore more features and functionalities of the built-in wrapper by referring to the Pieces OS Client Wrapper SDK documentation.

Advanced Usage

If you want to use the Pieces OS Client SDK directly without the built-in wrapper, you can follow these steps to get started.

Getting Started

First, we will create a Python script to test the connection to the Pieces OS server.

Create a python file and add the following code to confirm you can connect to your Pieces OS server:

import pieces_os_client
import platform

# Define the localhost port based on your operating system
# For Linux, use port 5323, for macOS/Windows, use port 1000
platform_info = platform.platform()
if 'Linux' in platform_info:
    port = 5323
else:
    port = 1000

# The `basePath` defaults to http://localhost:1000, but in this case we are checking the operating system to correctly set the port
configuration = pieces_os_client.Configuration(host=f"http://localhost:{port}")

# Initialize the Pieces ApiClient
api_client = pieces_os_client.ApiClient(configuration)

# Enter a context with an instance of the ApiClient
with pieces_os_client.ApiClient(configuration) as api_client:
    # Create an instance of the WellKnown API
    api_instance = pieces_os_client.WellKnownApi(api_client)

    try:
        # Retrieve the (wellknown) health of your Pieces OS server
        api_response = api_instance.get_well_known_health()
        print("The response of WellKnownApi().get_well_known_health:")
        print(api_response) # Response: ok
    except Exception as e:
        print("Exception when calling WellKnownApi->get_well_known_health: %s\n" % e)

Examples

Here are some examples of the basic endpoint for getting up and running:

# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = pieces_os_client.ConnectorApi(api_client)
  seeded_connector_connection = pieces_os_client.SeededConnectorConnection() # SeededConnectorConnection |  (optional)

  try:
      # /connect [POST]
      api_response = api_instance.connect(seeded_connector_connection=seeded_connector_connection)
      print("The response of ConnectorApi->connect:\n")
      pprint(api_response)
  except Exception as e:
      print("Exception when calling ConnectorApi->connect: %s\n" % e) 

# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
   # Create an instance of the API class
   api_instance = Assets API(api_client)
   transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)
   seed = pieces_os_client.Seed() # Seed |  (optional)

   try:
      # /assets/create [POST] Scoped to Asset
      api_response = api_instance.assets_create_new_asset(transferables=transferables, seed=seed)
      print("The response of AssetsApi->assets_create_new_asset:\n")
      pprint(api_response)
   except Exception as e:
      print("Exception when calling AssetsApi->assets_create_new_asset: %s\n" % e)

# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pieces_os_client.AssetApi(api_client)
    asset = '2254f2c8-5797-40e8-ac56-41166dc0e159' # str | The id (uuid) of the asset that you are trying to access.
    transferables = True # bool | This is a boolean that will decide if we want to return the transferable data (default) or not (performance enhancement) (optional)
    seeded_accessor = pieces_os_client.SeededAccessor() # SeededAccessor |  (optional)

    try:
         # api_instance.asset_snapshot(asset, transferables=transferables, seeded_accessor=seeded_accessor) [POST] Scoped to an Asset
        api_response = api_instance.asset_snapshot_post(asset, transferables=transferables, seeded_accessor=seeded_accessor)
        print("The response of AssetApi->asset_snapshot_post:\n")
        print(api_response)
    except Exception as e:
        print("Exception when calling AssetApi->asset_snapshot_post: %s\n" % e)

A developer documentation that outlines all the ins and outs of our available endpoints can be found here.

Learn More / Support

Explore more about Pieces SDK and get help from the following resources:

• 🚀 Getting Started with Pieces
• 📜 Pieces Docs
• 💬 Discord Community

License

This repository is available under the MIT License.