Skip to main content

Quick Start Guide

Introduction

Welcome to the Quick Start Guide for whyhow! This guide is designed to get you up and running with a basic project demonstrating the platform's capabilities. By the end of this guide, you will have created a simple knowledge graph and understand how to interact with it.

Prerequisites

Before you begin, ensure that you have:

  1. Set up your whyhow account and log into the platform. If you still need to do so, please refer to the Account Setup Guide.
  2. Uploaded at least one document to your workspace. If you need assistance with the document upload, please refer to the Document Upload Guide.

Defining a Schema

Before generating a knowledge graph, you need to define a schema that specifies the structure and relationships of your data.

Overview

  1. Click on the "Schemas" tab in the project dashboard.
  2. Click "Create Schema" to open the schema editor.
  3. Define your entities by providing a name and description for each entity type.
  4. Define the relationships between entities by specifying the source entity, relationship type, and target entity.
  5. Optionally, you can define patterns to capture specific graph structures or data patterns.
  6. Click "Save" to create the schema.
{
"entities": [
{
"name": "CorporateStructure",
"description": "Amazon's overall corporate organization and governance",
"fields": []
},
{
"name": "BusinessSegments",
"description": "Major operational divisions of Amazon",
"fields": []
},
{
"name": "ProductsAndServices",
"description": "Key offerings provided by Amazon",
"fields": []
},
{
"name": "RevenueStreams",
"description": "Sources of income for Amazon",
"fields": []
},
{
"name": "OperationalInfrastructure",
"description": "Key systems and networks supporting Amazon's operations",
"fields": []
},
{
"name": "StrategicPartnerships",
"description": "Important business relationships and collaborations",
"fields": []
},
{
"name": "RiskFactors",
"description": "Potential threats and challenges to Amazon's business",
"fields": []
},
{
"name": "FinancialPerformance",
"description": "Key financial metrics and results",
"fields": []
},
{
"name": "MarketPosition",
"description": "Amazon's standing in various markets and industries",
"fields": []
},
{
"name": "FutureOutlook",
"description": "Projections and strategic directions for Amazon",
"fields": []
}
],
"relations": [
{
"name": "comprises",
"description": "Indicates components or subdivisions of an entity"
},
{
"name": "contributes_to",
"description": "Indicates a positive impact or contribution"
},
{
"name": "depends_on",
"description": "Indicates a critical reliance or dependency"
},
{
"name": "influences",
"description": "Indicates a significant effect or impact"
},
{
"name": "competes_with",
"description": "Indicates competitive relationships"
},
{
"name": "mitigates",
"description": "Indicates strategies to address challenges or risks"
},
{
"name": "drives",
"description": "Indicates key factors behind growth or performance"
}
],
"patterns": [
{
"head": "CorporateStructure",
"relation": "comprises",
"tail": "BusinessSegments",
"description": "Amazon's corporate structure includes various business segments"
},
{
"head": "BusinessSegments",
"relation": "contributes_to",
"tail": "RevenueStreams",
"description": "Each business segment contributes to Amazon's revenue streams"
},
{
"head": "ProductsAndServices",
"relation": "depends_on",
"tail": "OperationalInfrastructure",
"description": "Amazon's products and services rely on its operational infrastructure"
},
{
"head": "StrategicPartnerships",
"relation": "influences",
"tail": "MarketPosition",
"description": "Strategic partnerships affect Amazon's market position"
},
{
"head": "RiskFactors",
"relation": "influences",
"tail": "FutureOutlook",
"description": "Identified risk factors impact Amazon's future outlook"
},
{
"head": "FinancialPerformance",
"relation": "drives",
"tail": "FutureOutlook",
"description": "Financial performance drives Amazon's future strategies and projections"
}
]
}

Generating the Knowledge Graph

With your schema defined, you can generate a knowledge graph from your uploaded document(s).

  1. Click on the "Graphs" tab in the project dashboard.
  2. Click "Generate Graph" to start the graph generation process.
  3. Select the schema you created in the previous step.
  4. Choose the document(s) you want to use for graph generation.
  5. Click "Generate" to initiate the graph generation process.

The platform will process your documents, extract relevant information based on the schema, and generate a knowledge graph.

Graph Generation One

Graph Generation Two

Graph Generation Three

Graph Generation Four

Exploring and Querying the Graph

Once the graph generation is complete, you can explore and query your knowledge graph.

  1. Click on the "Graphs" tab in the project dashboard.
  2. Click on the generated graph to open the graph visualization interface.
  3. Use the interactive controls to zoom in/out, pan, and explore the graph structure.
  4. Click on nodes and edges to view their properties and relationships.
  5. Use the search and filtering options to find specific entities or patterns within the graph.
  6. Switch to the "Query" tab to execute custom queries using natural or structured query languages.

Simple Query

Experimenting Further

Congratulations on creating your first knowledge graph project! Now that you have a basic understanding of the process try experimenting with different schemas, documents, and query techniques to uncover insights and relationships in your data.

Where to Go Next

To deepen your understanding of the whyhow platform and its capabilities, explore the following resources:

  • Concept-specific Documentation: Learn more about the core concepts used in whyhow, such as graphs, triples, nodes, entities, workspaces, and chunks.
  • User Interface Guide: Get familiar with the various components and features of the whyhow user interface.
  • API Documentation: Discover how to interact with the whyhow platform programmatically using the API for more advanced use cases.