Skip to main content
Version: Next

Documentation structure and philosophy

Structure​

The Enterprise h2oGPTe documentation is organized into the following main sections:

  • Get started: This section introduces Enterprise h2oGPTe.
  • Concepts: This section provides fundamental concepts surrounding Enterprise h2oGPTe.
  • Tutorials: This section offers tutorials on Enterprise h2oGPTe.
  • Guide: This section encompasses several subsections:
    • Collections: This subsection covers Collections in Enterprise h2oGPTe.
    • Documents: This subsection covers Documents in Enterprise h2oGPTe.
    • Chats: This subsection covers Chats in Enterprise h2oGPTe.
    • Prompts: This subsection covers how to create a prompt templates in Enterprise h2oGPTe.
    • Feedback: This subsection covers how you can view past submitted feedback on certain Upvote and Updown responses.
    • Platform usage: This subsection covers the usage of Large Language Models (LLMs) in Enterprise h2oGPTe.
    • Impersonate another user: This subsection covers the user impersonation feature that lets you temporarily sign in as a different user.
    • APIs: This subsection provides guidance on creating API Keys for integrating external applications to Enterprise h2oGPTe.
    • Jobs: This subsection covers Jobs in Enterprise h2oGPTe.
    • Admin center: This subsection covers the admin center page that offers administrators an overview of recent Jobs.
  • Python Client guide: This section connects you to the external h2oGPTe Python client library documentation, which supports H2O.ai's Enterprise h2oGPTe platform.
  • Key terms: This section defines key terms relevant to Enterprise h2oGPTe.
  • Architecture: This subsection covers the Enterprise h2oGPTe architecture and vector database.
  • FAQs: This section answers frequently asked questions about Enterprise h2oGPTe.

Philosophy​

  • Philosophy of alignment: The documentation for Enterprise h2oGPTe is designed to match the product's structure. This means that information in the documentation is organized to align with the features and workflows of Enterprise h2oGPTe. Our goal is to make learning the product easy and intuitive for users.

  • Simplicity and modularity principles: Our documentation follows a simple and modular approach. Most pages have two main sections: "Overview" and "Instructions." A page can also have other sections that heavily relate to the page's "Overview" and "Instructions." This makes it easier for users to understand and use Enterprise h2oGPTe effectively.

Feedback