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

[KE] Add assistant description #469

Merged
merged 1 commit into from
Mar 25, 2025
Merged

[KE] Add assistant description #469

merged 1 commit into from
Mar 25, 2025

Conversation

avi1mizrahi
Copy link
Member

Problem

There were no info on assistant in the readme

Solution

Now there is info on assistant in the readme

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

Test Plan

Describe specific steps for validating this change.

@nihohit
Copy link

nihohit commented Mar 24, 2025

it's better than nothing, but let's aim to have as much visibility as inference here.

Copy link
Contributor

@austin-denoble austin-denoble left a comment

Choose a reason for hiding this comment

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

Thanks for adding a callout to the core python README.

The Assistant representation in the typescript client is fairly detailed if you're interested in modeling it around that: https://github.com/pinecone-io/pinecone-ts-client?tab=readme-ov-file#pinecone-assistant

@avi1mizrahi
Copy link
Member Author

avi1mizrahi commented Mar 25, 2025

Thanks for adding a callout to the core python README.

The Assistant representation in the typescript client is fairly detailed if you're interested in modeling it around that: https://github.com/pinecone-io/pinecone-ts-client?tab=readme-ov-file#pinecone-assistant

Thanks Austin! Because we are currently have separated repos for the Python SDK and the plugin, this adds another place we need to keep in sync. I hope soon we will be able to merge the plugin and add documentation only here.

@avi1mizrahi avi1mizrahi merged commit edb9655 into main Mar 25, 2025
58 checks passed
@avi1mizrahi avi1mizrahi deleted the avi/ke/readme-assistant branch March 25, 2025 15:25
jhamon pushed a commit that referenced this pull request Apr 8, 2025
## Problem

There were no info on assistant in the readme

## Solution

Now there is info on assistant in the readme

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update
- [ ] Infrastructure change (CI configs, etc)
- [x] Non-code change (docs, etc)
- [ ] None of the above: (explain here)

## Test Plan

Describe specific steps for validating this change.
jhamon pushed a commit that referenced this pull request Apr 8, 2025
## Problem

There were no info on assistant in the readme

## Solution

Now there is info on assistant in the readme

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update
- [ ] Infrastructure change (CI configs, etc)
- [x] Non-code change (docs, etc)
- [ ] None of the above: (explain here)

## Test Plan

Describe specific steps for validating this change.
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.

3 participants