Manage assistants
This page shows you how to view a list of assistants, check the status of an assistant, update an assistant, and delete an assistant.
List assistants for a project
Use the list_assistants
operation to get the name, status, and metadata for each Assistant in your project as in the following example:
This operation returns a response like the following:
You can use the name
value to check the status of an assistant.
You can list assistants using the Pinecone console.
Get the status of an assistant
Use the describe_assistant
operation to get the status and metadata for your assistant as in the following example:
This operation returns a response like the following:
The status
field has the following possible values:
- Initializing
- Failed
- Ready
- Terminating
You can check the status of an assistant using the Pinecone console.
Add instructions to an assistant
Use the update_assistant
operation to add or update the instructions for an existing assistant. Instructions are a short description or directive for the assistant to apply to all of its responses. For example, you can update the instructions to reflect the assistant’s role or purpose.
For example:
The example above returns a result like the following:
You can also add instructions when you create an assistant.
Delete an assistant
Use the delete_assistant
operation to delete an assistant.
Deleting an assistant also deletes all files uploaded to the assistant.
You can delete an assistant using the Pinecone console.
Was this page helpful?