Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python sdk #547

Merged
merged 20 commits into from
Aug 24, 2024
Merged

Python sdk #547

merged 20 commits into from
Aug 24, 2024

Conversation

choir27
Copy link
Contributor

@choir27 choir27 commented Aug 17, 2024

Adds content, code samples, installation guide, and full example for Pieces Copilot Python SDK

Fixes #541

https://github.com/mason-at-pieces/pieces-copilot-python-sdk

… Add features section. Add introduction. Add Usage section. Add community section.
…edirec to Pieces OS docs. Change Usage to Initialize SDK. Update instructions to initialize Pieces OS. Update Features to table and content. Add parameters, return type, and example sections for the following: ask_question(), create_conversation(), prompt_conversation(), get_conversation(), update_conversation_name(), get_conversations(), get_user_profile_picture(), and Full Example using all Python SDK methods
Copy link

vercel bot commented Aug 17, 2024

@choir27 is attempting to deploy a commit to the Pieces for Developers Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Aug 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Aug 24, 2024 3:35pm

If you are using a remote instance of Pieces OS, use the URL you have set up for that.

```python
from pieces_copilot_sdk import PiecesClient
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @choir27 this is wonderful! Just one small comment, at the moment, @Bishoy-at-pieces @mason-at-pieces @jimbobbennett are working on the Wrapper SDK implementation which will be added to the main Pieces Org. There is a complete rewrite of the wrapper SDK code being implemented right now which means that the implementation for the methods will change. But this is a good start. It also gives us good time to rethink how to actually structure the docs regarding the SDK.

On a high level - we can think of initially introducing: what are the main category of APIs such as Assets APIs, Conversation APIs and have individual docs for each of these broad category alongside one main doc around the core SDK.

Let me know your thoughts @mason-at-pieces

…thods and properties to copilot and assets for python sdk
@Bishoy-at-pieces
Copy link
Contributor

Absolutely great work @choir27 💪💪

sidebars.ts Outdated
{
type: 'doc',
id: 'build/sdks/python/index',
label: '📚 Python',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we update the label with Python icon? Not sure if that is possible @mason-at-pieces @choir27

Copilot Chats | Communicate seamlessly with copilot chats functionality.
Asset Management | Save and manage assets and formats efficiently.
Local Server Interaction | Interact with a locally hosted server for various functionalities.
Multi LLMs support | Use any Pieces supported LLMs to power apps.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use any of the Pieces supported offline and online LLMs

description: Quickly set up the Pieces Wrapper Python SDK
---

# Python QuickStart
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quickstart


If you are using a remote instance of Pieces OS, use the URL you have set up for that.

## Getting started
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mention about our Wrapper here. and how is it different than the base SDK.

Copy link
Contributor

@Bishoy-at-pieces Bishoy-at-pieces left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mason-at-pieces mason-at-pieces merged commit ec6b69c into pieces-app:main Aug 24, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Python SDK
4 participants