Rainbird
  • 🏃‍♂️Getting started
    • What is Rainbird?
    • How does Rainbird work?
    • Example use cases
      • 📈Investment suitability assessment
      • 🤖Digital tax consultant
      • 🏥Covid risk assessment
      • 🚗Insurance claims liability
      • 💰Fraud identification
    • Hosting options
    • Quickstart guide
    • Onboarding with Rainbird
  • 🧠Knowledge Modelling
    • What is knowledge modelling?
    • What is a query?
    • Modelling
      • Concepts
        • Concept instances
      • Relationships
        • Question Configuration
        • Rules
          • Match, Infer, Ask process
          • Expressions List
      • Facts
      • Datasources
      • Other features
        • Markdown
        • Import/Export Knowledge Maps
      • Troubleshooting Tips
    • Testing
      • Manual tests
      • Automated tests
      • External User Acceptance Testing (UAT)
    • Versioning
    • Publishing
      • API Management
      • Setting a live version
      • Publishing an agent
    • Stats and Reporting
    • Managing your data
    • The library
      • How to: update a template
  • 🔍Evidence
    • What is evidence?
    • The Evidence Tree
      • The Salience Chart
  • 👩‍💻Developer guides
    • Overview
    • API Guide
      • API request flow
      • Run example queries
      • Environments
      • Error codes
      • Skipping an answer to a question
      • Retrieving a full Evidence Tree for use with a custom UI or application
      • Building an Evidence Tree URL
    • API interactive documentation
    • SDKs
  • Rainbird Labs
    • Overview
    • Consult
    • Generate from documentation
    • Co-author
    • /interact
    • /explain
Powered by GitBook
On this page
  1. Developer guides
  2. API Guide

Run example queries

Last updated 3 months ago

From within the , example requests can be made to a live Rainbird environment using the example api key and Knowledge Map ID below.

Description
Value

API Host

https://api.rainbird.ai

API Key

37582f71-b9b1-4451-b9e6-c130c7fd2412

Knowledge Map ID

2fd1be28-b38d-4fa3-8b9d-b0976821912c

The example Knowledge Map is a simple model of national languages and the likelihood that a person who lives in the country, speaks the national language of the country. The Knowledge Map contains a single rule on the speaks relationship. When performing a query against the speaks relationship this rule is eligible to be run by the Rainbird engine.

A query can be run against the speaks relationship in the following ways by making a POST request to /{sessionID}/query:

  • To find what language Tom speaks (Tom -> speaks -> ?), pass subject and relationship:

    {
      "subject": "Tom",
      "relationship": "speaks"
    }
  • To find who speaks French (? -> speaks -> French), pass relationship and object:

    {
      "relationship": "speaks",
      "object": "French"
    }
  • To check if Tom speaks French (Tom -> speaks -> French), pass subject, relationship and object:

    {
      "subject": "Tom",
      "relationship": "speaks",
      "object": "French"
    }

👩‍💻
interactive documentation