Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 5.55 KB

support-and-faqs.md

File metadata and controls

69 lines (45 loc) · 5.55 KB
Raw

Support and FAQs

Frequently Asked Questions (FAQs)

Q1: What types of API documentation does Yugo support?

A: Yugo is flexible and can analyze various types of API documentation. While we support OpenAPI (Swagger) specifications, our system uses advanced language models to analyze documentation in other formats as well, including Markdown. This allows us to process a wide range of API documentation styles.

Q2: Can I integrate multiple AI features into my service?

A: Yes, you can integrate multiple AI features. We recommend starting with one or two features and gradually adding more as you become familiar with the platform. Each integration is based on the specific analysis of your API documentation.

Q3: How secure is my API documentation and data?

A: In the current demo version, we prioritize ease of use for testing purposes. We recommend using only public information for this demo. Rest assured, in the full product version, we will implement stringent security measures, including encryption of data in transit and at rest, to protect your sensitive information.

Q4: What if the recommended AI features don't meet my needs?

A: Our AI feature recommendations are dynamically generated based on the analysis of your specific API documentation. Unlike a fixed catalog of pre-defined features, we create custom suggestions tailored to your API's structure and apparent functionality. If the initial recommendations don't fully meet your needs, you can initiate a new analysis or contact our support team for more specialized assistance.

Q5: Can I customize the AI models or features used?

A: While we don't offer direct customization of the underlying AI models in the current version, we do provide flexibility in feature customization. After integration, you can directly edit the prompts used for each AI feature. This allows for a form of prompt engineering, enabling you to fine-tune the AI's behavior to better suit your specific needs. We're continuously working on expanding customization options in future updates.

Q6: How often are new AI features or capabilities added?

A: As our system generates AI features based on your specific API, new capabilities are essentially created with each analysis. We're constantly improving our underlying models and analysis techniques, which in turn enhances the quality and range of AI features we can suggest and implement for your services.

Q7: Is there a limit to the size or complexity of API documentation I can analyze?

A: While our system can handle a wide range of documentation sizes and complexities, extremely large or complex APIs might require additional processing time. If you encounter any issues with large documentation sets, please contact our support team for assistance.

Q8: How does Yugo handle versioning of API integrations?

A: Currently, each integration is treated as a new instance. However, we're working on implementing a versioning system in future updates to allow for easier management and tracking of changes in your AI integrations over time.

Remember, Yugo is continuously evolving. We appreciate your feedback and use it to improve our platform. If you have any questions not covered here, please don't hesitate to reach out to our support team.

Troubleshooting

Issue: API Analysis Fails

  • Check that the documentation URL is accessible or that you've uploaded the text.
  • Try breaking down large API documents into smaller parts if the analysis times out.

Issue: AI Feature Integration Fails

  • Check your internet connection and try again.
  • If the problem persists, please contact support with the error message you receive.

Issue: Unable to Run AI Features

  • Ensure the feature is enabled in the AI Features tab.
  • Check that you have a valid API token (visible in the Tokens section).
  • Verify that you're using the correct API endpoint and parameters.

If you encounter any other issues not listed here, please don't hesitate to contact our support team.

Getting Help and Engaging with the Community

We're here to support you in making the most of Yugo. Here's how you can get help, share ideas, and connect with other users:

  1. GitHub Discussions: Our primary community hub is our GitHub Discussions. Here you can:

    • Ask questions and get answers in the Q&A category
    • Share and discover tips in the Tips & Tricks category
    • Suggest new features or improvements in the Feature Requests category
    • Troubleshoot issues in the Troubleshooting category
    • Engage in general conversations about Yugo in the General Discussion category

  2. Documentation: For comprehensive information on Yugo's features and capabilities, refer to our full documentation.

  3. Email Support: For direct assistance or sensitive inquiries, email our support team at support@yugo-ai.com. We aim to respond within 24 hours on business days.

  4. Stay Updated: Check the Announcements category in our GitHub Discussions for the latest updates, new features, and important information about Yugo.

  5. Report Bugs: If you encounter a bug or technical issue, please report it in the Issues section of our GitHub repository.

We value your feedback and active participation in our community. Your insights help us continuously improve Yugo and create a vibrant ecosystem for AI-Web integration.

Don't hesitate to reach out with any questions, concerns, or suggestions. We're excited to see what you'll build with Yugo and look forward to your contributions to our growing community!