AIApi
in package
AIApi Class Doc Comment
Tags
Table of Contents
Constants
- contentTypes : array<string|int, string> = ['textToAction' => ['application/json']]
Properties
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
Methods
- __construct() : mixed
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- textToAction() : TextToActionResult|ErrorResponse
- Operation textToAction
- textToActionAsync() : PromiseInterface
- Operation textToActionAsync
- textToActionAsyncWithHttpInfo() : PromiseInterface
- Operation textToActionAsyncWithHttpInfo
- textToActionRequest() : Request
- Create request for operation 'textToAction'
- textToActionWithHttpInfo() : array<string|int, mixed>
- Operation textToActionWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- handleResponseWithDataType() : array<string|int, mixed>
- responseWithinRangeCode() : bool
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['textToAction' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int = 0
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
getConfig()
public
getConfig() : Configuration
Return values
ConfigurationgetHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
textToAction()
Operation textToAction
public
textToAction(TextToActionRequest $text_to_action_request[, string $contentType = self::contentTypes['textToAction'][0] ]) : TextToActionResult|ErrorResponse
Turn a sentence into a BIM.works action (BQL, BVL or BCL)
Parameters
- $text_to_action_request : TextToActionRequest
-
text_to_action_request (required)
- $contentType : string = self::contentTypes['textToAction'][0]
-
The value for the Content-Type header. Check self::contentTypes['textToAction'] to see the possible values for this operation
Tags
Return values
TextToActionResult|ErrorResponsetextToActionAsync()
Operation textToActionAsync
public
textToActionAsync(TextToActionRequest $text_to_action_request[, string $contentType = self::contentTypes['textToAction'][0] ]) : PromiseInterface
Turn a sentence into a BIM.works action (BQL, BVL or BCL)
Parameters
- $text_to_action_request : TextToActionRequest
-
(required)
- $contentType : string = self::contentTypes['textToAction'][0]
-
The value for the Content-Type header. Check self::contentTypes['textToAction'] to see the possible values for this operation
Tags
Return values
PromiseInterfacetextToActionAsyncWithHttpInfo()
Operation textToActionAsyncWithHttpInfo
public
textToActionAsyncWithHttpInfo(TextToActionRequest $text_to_action_request[, string $contentType = self::contentTypes['textToAction'][0] ]) : PromiseInterface
Turn a sentence into a BIM.works action (BQL, BVL or BCL)
Parameters
- $text_to_action_request : TextToActionRequest
-
(required)
- $contentType : string = self::contentTypes['textToAction'][0]
-
The value for the Content-Type header. Check self::contentTypes['textToAction'] to see the possible values for this operation
Tags
Return values
PromiseInterfacetextToActionRequest()
Create request for operation 'textToAction'
public
textToActionRequest(TextToActionRequest $text_to_action_request[, string $contentType = self::contentTypes['textToAction'][0] ]) : Request
Parameters
- $text_to_action_request : TextToActionRequest
-
(required)
- $contentType : string = self::contentTypes['textToAction'][0]
-
The value for the Content-Type header. Check self::contentTypes['textToAction'] to see the possible values for this operation
Tags
Return values
RequesttextToActionWithHttpInfo()
Operation textToActionWithHttpInfo
public
textToActionWithHttpInfo(TextToActionRequest $text_to_action_request[, string $contentType = self::contentTypes['textToAction'][0] ]) : array<string|int, mixed>
Turn a sentence into a BIM.works action (BQL, BVL or BCL)
Parameters
- $text_to_action_request : TextToActionRequest
-
(required)
- $contentType : string = self::contentTypes['textToAction'][0]
-
The value for the Content-Type header. Check self::contentTypes['textToAction'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \BIMworks\Model\TextToActionResult|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
handleResponseWithDataType()
private
handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>
Parameters
- $dataType : string
- $request : RequestInterface
- $response : ResponseInterface
Return values
array<string|int, mixed>responseWithinRangeCode()
private
responseWithinRangeCode(string $rangeCode, int $statusCode) : bool
Parameters
- $rangeCode : string
- $statusCode : int