Leveraging Assistants in SpecFrog Projects

SpecFrog assistant helps a customer

SpecFrog Assistants transform how you interact with project documents, providing an AI-powered interface for querying and downloading files. This guide introduces you to Assistants, outlines their functionalities, and shares best practices for effective use.

Understanding Assistants

  • Project-Specific: Each project on SpecFrog comes with its dedicated Assistant, accessible via a unique link.
  • Open Access: Anyone with the Assistant link can engage with the project's documents, asking questions and downloading files as needed. Interacting with an assistant will use chat resources.
  • Assistant Sessions: Each time an assistant link is clicked a new session is created. Sessions can be viewed by the project owner, or anyone with the link to the session.

Assistant URLs

Using this link: SpecFrog.com/chat/***Assistant ID***/ will create a new session. These links are displayed on the Projects dashboard in the Assistant Link column, or within a project by clicking Copy Assistant Link.

Using this link: SpecFrog.com/chat/***Assistant ID***/***Session ID***/ will take you to an existing session. These links are displayed within a Project, on the Chat Sessions Tab.

Utilizing Assistants Effectively

Best Prompt Practices

When interacting with GPT-powered Assistants, crafting your queries effectively can significantly enhance the quality of responses:

  • Be Specific: Detailed questions lead to more accurate answers. Include relevant context or specifics about your query.
  • Follow-Up Queries: Build upon previous questions for deeper insights, as Assistants will soon use ongoing session chat history to provide contextually rich responses.
  • Session Review: Project owners can review session logs to verify the accuracy of the Assistant's responses and understand user interactions. Please be aware of your chat questions, as they can be reviewed by the project owner.
  • Document Queries: Queries unrelated to the project documents will not be answered. If an answer does not exist within a project document Assistants may decline answering or give a poor response.
SpecFrog view of interacting with a chat assistant

Access Control and Security

  • Revoking Access: To restrict access to an Assistant, you must delete the current project and initiate a new one. This process does not consume additional monthly resources.
  • Unlimited Projects: There's no cap on the number of projects you can create, enabling you to manage Assistant access flexibly.

Resource Management

  • Chat Limits: Assistants consume chat resources. Exceeding your monthly limit will prompt a notification to your customers about the reached quota.
  • Account Upgrades: Turn on variable usage (not available on free trial) via the SpecFrog dashboard 🔗, or opt for variable usage limits to accommodate fluctuating needs.

Security Practices

  • Selective Sharing: Share Assistant links judiciously to prevent unauthorized resource consumption. Avoid public postings to mitigate the risk of exploitation by malicious actors.
  • SpecFrog's Policy: While Assistant links are securely generated and not guessable, SpecFrog cannot be held accountable for resource depletion due to misuse by unauthorized users.

Sessions

A session is a unique instance of a project Assistant. Sessions are used to keep track of assistant interactions (chat history) and to provide session specific context to questions.

  • Session Creation: Clicking an Assistant link initiates a new session, allowing for a seamless Q&A flow. If you received an assistant link from a SpecFrog user, you will likely be creating a new assistant session for that project.
  • Future Enhancements: Anticipate more cohesive conversations with upcoming updates that will incorporate session history into responses, fostering more natural Assistant interactions.
SpecFrog Dashboard view of Session Management

By adhering to these guidelines, you can maximize the potential of SpecFrog Assistants in your projects, ensuring secure, efficient, and effective document management and collaboration.

Was this page helpful?