Package nl.bimbase.bimworks.client.apis

Class AiApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.AiApi

public class AiApi
extends SubApi

AI related API calls. These calls require a BIM.works instance with AI enabled. Note AI integration is still in development and this API should be considered in beta stage.

Constructor Summary

Constructors

Constructor	Description
AiApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
TextToActionResponse	textToAction(String text)	Convert natural language to a BIM.works Action.

Methods inherited from class nl.bimbase.bimworks.client.apis.SubApi

getBimWorksClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AiApi

public AiApi(BimWorksClient bimWorksClient)

Method Details

textToAction

public TextToActionResponse textToAction(String text)
                                  throws InterruptedException,
BimWorksException

Convert natural language to a BIM.works Action. Conversions generally work best when the natural language is English, but other common languages usually work pretty well too.

Parameters:

text - The input text.

Returns:

The response. Currently 3 different types can be returned: - QUERY3 (can be executed using BimApi.query(String, java.util.Set) - BVL (can be resolved using BimApi.resolveBvl(String, java.util.Set)) - CHECK3 (can be executed using {})

Throws:

InterruptedException

BimWorksException