Compartir a través de


Rainbird (Preview)

Rainbird is a no-code intelligent automation platform that enables you to automate complex decisions. This connector enables you to interact with knowledge maps you have built in Rainbird.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Rainbird Technologies Ltd
URL https://rainbird.ai/contact-us/
Email support@rainbird.zohodesk.eu
Connector Metadata
Publisher Rainbird Technologies ltd
Website https://rainbird.ai/
Privacy policy https://rainbird.ai/privacy-policy/
Categories AI;Business Intelligence

Rainbird enables your organisation to automate complex decision-making at scale. Leverage your own SMEs expertise to encode their decision-making logic in our no-code Studio, then connect to your workflow to provide high-quality, performant and auditable decisions that enable you to create fully automated end-to-end solutions.

Visit Rainbird's website for more details.

Prerequisites

To use this connector, you need access to a Rainbird account.

You can sign up now to get access to a free community account: Sign-up. For premium accounts, get in touch with us: Contact us.

How to get credentials

To use this connector, you will need the following: -API Key (ApiKey) -Knowledge Map ID (KmID)

The ApiKey and the KmID can be found in the Rainbird Studio.

  1. Login to your account
  2. Open your knowledge map (or create a new one if needed)
  3. Go to the 'Publish' page

The ApiKey will be needed to authenticate with Rainbird. When authenticating use your ApiKey as a username, you don't need a password (input any character if a password is required).

Visit Rainbird's documentation for more details.

Get started with your connector

In any scenario where you want to automate a decision with Rainbird, you will need to do the following:

-Start a Session on the Knowledge map you want to use -Provide data to your Session (optional) -Query Rainbird in your Session

Rainbird will either respond with a question if more information is required, which you can answer using the Response operation, or a result is provided.

How to start a Session:

Any decision will begin with a Start operation to start a session and obtain the SessionID. In the Start operation, provide your KmID to generate a SessionID. You must then use this ID with further operations to interact with your Knowledge Map within the same session.

How to provide batch data to your Session:

Use an Inject operation before querying to provide any data that is required to make a decision.

How to make a query:

To make a query, use the Query operation to provide the SessionID, relationship name and either or both the subject/object of the relationship.

Visit Rainbird's documentation to view examples of this request.

How to respond to a question

Use the Response operation to answer any question returned by Rainbird. Both the Query and Response operation will return either a question asking for more information or a result. The question/response loop is recursive until Rainnbird has enough information to provide a result.

Visit Rainbird's documentation for more information on the request flow.

Known issues and limitations

The current connector configuration doesn't allow users to use the security key for the evidence operation. If a user wants to use the evidence operation, they will have to make sure the evidence security is deactivated in the Rainbird Studio, at the Publish section of each map.

Common errors and remedies

Using the wrong environment variable:

-Error code: This mistake can output various error messages such as Session ID not found or 401: Unauthorized. -Resolution: Every operation needs to be done against the correct environment (the one linked to your account). Make sure each step matches your environment.

### Using the wrong data structure.

-Error code: 400: bad request -Resolution: This can be caused by data incompatibilities. Read the error details to get more context and make sure the data used in the flow matches your Rainbird model's data.

FAQ

How do I know which environment I need to use?

You can find the environment in your Rainbird account. Log in to your account, and go to the Account page (bottom of the left navigation menu). In the About section you'll find the information related to your account environment (Enterprise or Community).

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Api key securestring The api key associated to your Rainbird account True
optional password securestring No password required, type any character True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Evidence - Returns the evidence for a given fact

Generate an evidence-based on a fact ID. Knowledge inferred by Rainbird always come with data to explain the decision-making process. This data is made accessible through this action. Note: make sure the evidence key is off in Rainbird studio.

Inject - Inject facts into a session

Inject data in a knowledge map against a specific session ID. This is usually performed prior to a query. It's a way to upload data into a Rainbird model.

Query - Query a running session

Ask a question to a knowledge map. This action triggers Rainbird's decision engine. It performs the automated decisioning and then provides a final answer. If Rainbird needs more information to come to a conclusion, it will ask a question.

Response - Respond to an asked question

Give an answer back to Rainbird. When Rainbird comes back with a question to a query, it expects a user or a system to input more data. This action provides a response back.

Start - Start a new session

Create a new session ID on a knowledge map. This first step will allow you to make further actions against your Rainbird model, such as injecting facts or doing a query.

Undo - Undoes previous interaction with the engine

Undo a previous action. This action removes the last action performed. It removes the last piece of data given to Rainbird.

Version - Reports engine version

Return the current Rainbird's inference engine version.

Evidence - Returns the evidence for a given fact

Generate an evidence-based on a fact ID. Knowledge inferred by Rainbird always come with data to explain the decision-making process. This data is made accessible through this action. Note: make sure the evidence key is off in Rainbird studio.

Parameters

Name Key Required Type Description
Environment
environment True string

Account environment: Community (api.rainbird.ai) or Enterprise (enterprise-api.rainbird.ai).)

Fact ID
factID True string

The factID for which to retrieve evidence

Session ID
sessionID True string

The sessionID WITH EVIDENCE SECURITY OFF (see model settings) where the fact was created

Returns

Name Path Type Description
certainty
fact.certainty Certainty

How certain this fact or answer is

dataType
fact.object.dataType string
type
fact.object.type string
value
fact.object.value Object

The object-side concept instance or value

type
fact.relationship.type string
dataType
fact.subject.dataType string
type
fact.subject.type string
value
fact.subject.value string
factID
factID string
conditions
rule.bindings.conditions array of object
certainty
rule.bindings.conditions.certainty Certainty

How certain this fact or answer is

factID
rule.bindings.conditions.factID factID

ID used to fetch the evidence that lead to this decision

object
rule.bindings.conditions.object Object

The object-side concept instance or value

objectType
rule.bindings.conditions.objectType string
relationship
rule.bindings.conditions.relationship Relationship

The relationship linking Subject and Object

salience
rule.bindings.conditions.salience number
subject
rule.bindings.conditions.subject Subject

The subject-side concept instance or value

source
source string
time
time number

Inject - Inject facts into a session

Inject data in a knowledge map against a specific session ID. This is usually performed prior to a query. It's a way to upload data into a Rainbird model.

Parameters

Name Key Required Type Description
Environment
environment True string

Account environment: Community (api.rainbird.ai) or Enterprise (enterprise-api.rainbird.ai).)

Session ID
sessionID True string

The session to inject facts into

subject
subject True

The subject-side concept instance or value

relationship
relationship True

The relationship linking Subject and Object

object
object True

The object-side concept instance or value

certainty
certainty True number

How certain this fact or answer is

Returns

Name Path Type Description
result
result string

Query - Query a running session

Ask a question to a knowledge map. This action triggers Rainbird's decision engine. It performs the automated decisioning and then provides a final answer. If Rainbird needs more information to come to a conclusion, it will ask a question.

Parameters

Name Key Required Type Description
Environment
environment True string

Account environment: Community (api.rainbird.ai) or Enterprise (enterprise-api.rainbird.ai).)

Session ID
sessionID True string

The session to query against

subject
subject string

The subject-side concept instance (object or subject required)

relationship
relationship True string

The relationship to query for

object
object string

The object-side concept instance (object or subject required)

Returns

response
object

Response - Respond to an asked question

Give an answer back to Rainbird. When Rainbird comes back with a question to a query, it expects a user or a system to input more data. This action provides a response back.

Parameters

Name Key Required Type Description
Environment
environment True string

Account environment: Community (api.rainbird.ai) or Enterprise (enterprise-api.rainbird.ai).)

Session ID
sessionID True string

The session to send responses to

subject
subject True

The subject-side concept instance or value

relationship
relationship True

The relationship linking Subject and Object

object
object True

The object-side concept instance or value

certainty
certainty True number

How certain this fact or answer is

Returns

response
object

Start - Start a new session

Create a new session ID on a knowledge map. This first step will allow you to make further actions against your Rainbird model, such as injecting facts or doing a query.

Parameters

Name Key Required Type Description
Environment
environment True string

Account environment: Community (api.rainbird.ai) or Enterprise (enterprise-api.rainbird.ai).

Knowledge Map ID (kmId)
kmID True string

The knowledge map ID to start a session against

Returns

Name Path Type Description
id
id string

ID of newly created session

id
kmVersion.id string

ID of the version being queried, which will be different to the knowledge map ID when querying live versions of a knowledge map

Undo - Undoes previous interaction with the engine

Undo a previous action. This action removes the last action performed. It removes the last piece of data given to Rainbird.

Parameters

Name Key Required Type Description
Environment
environment True string

Account environment: Community (api.rainbird.ai) or Enterprise (enterprise-api.rainbird.ai).)

Session ID
sessionID True string

The session ID to step back with an undo

Returns

response
object

Version - Reports engine version

Return the current Rainbird's inference engine version.

Parameters

Name Key Required Type Description
Environment
environment True string

Account environment: Community (api.rainbird.ai) or Enterprise (enterprise-api.rainbird.ai).)

Returns

response
string

Definitions

Certainty

How certain this fact or answer is

How certain this fact or answer is

Subject

The subject-side concept instance or value

The subject-side concept instance or value

Relationship

The relationship linking Subject and Object

The relationship linking Subject and Object

Object

The object-side concept instance or value

The object-side concept instance or value

factID

ID used to fetch the evidence that lead to this decision

ID used to fetch the evidence that lead to this decision

object

This is the type 'object'.

string

This is the basic data type 'string'.