OpenAPI\Client\ExamplesApi

All URIs are relative to https://chatbots.obilytics.com/api

Method	HTTP request	Description
chatbotChatbotIDEntityStatisticsGet	GET /chatbot/{chatbotID}/entity_statistics	Get statistics per entity
chatbotChatbotIDExamplesDelete	DELETE /chatbot/{chatbotID}/examples	Delete a all training examples
chatbotChatbotIDExamplesExampleIDDelete	DELETE /chatbot/{chatbotID}/examples/{exampleID}	Delete a specific training example
chatbotChatbotIDExamplesExampleIDGet	GET /chatbot/{chatbotID}/examples/{exampleID}	Get a specific training example
chatbotChatbotIDExamplesExampleIDPut	PUT /chatbot/{chatbotID}/examples/{exampleID}	Returns a specific examples
chatbotChatbotIDExamplesGet	GET /chatbot/{chatbotID}/examples	Returns all training examples
chatbotChatbotIDExamplesPost	POST /chatbot/{chatbotID}/examples	Create a specific training example
chatbotChatbotIDIntentStatisticsGet	GET /chatbot/{chatbotID}/intent_statistics	Get statistics per intent

chatbotChatbotIDEntityStatisticsGet

object chatbotChatbotIDEntityStatisticsGet($chatbot_id)

Get statistics per entity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ExamplesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.

try {
    $result = $apiInstance->chatbotChatbotIDEntityStatisticsGet($chatbot_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExamplesApi->chatbotChatbotIDEntityStatisticsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.

Return type

object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

chatbotChatbotIDExamplesDelete

chatbotChatbotIDExamplesDelete($chatbot_id)

Delete a all training examples

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ExamplesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.

try {
    $apiInstance->chatbotChatbotIDExamplesDelete($chatbot_id);
} catch (Exception $e) {
    echo 'Exception when calling ExamplesApi->chatbotChatbotIDExamplesDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

chatbotChatbotIDExamplesExampleIDDelete

chatbotChatbotIDExamplesExampleIDDelete($chatbot_id, $example_id)

Delete a specific training example

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ExamplesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.
$example_id = 'example_id_example'; // string | Pass in a exampleID to identify the example.

try {
    $apiInstance->chatbotChatbotIDExamplesExampleIDDelete($chatbot_id, $example_id);
} catch (Exception $e) {
    echo 'Exception when calling ExamplesApi->chatbotChatbotIDExamplesExampleIDDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.
example_id	string	Pass in a exampleID to identify the example.

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

chatbotChatbotIDExamplesExampleIDGet

\OpenAPI\Client\Model\TrainingExample chatbotChatbotIDExamplesExampleIDGet($chatbot_id, $example_id)

Get a specific training example

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ExamplesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.
$example_id = 'example_id_example'; // string | Pass in a exampleID to identify the example.

try {
    $result = $apiInstance->chatbotChatbotIDExamplesExampleIDGet($chatbot_id, $example_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExamplesApi->chatbotChatbotIDExamplesExampleIDGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.
example_id	string	Pass in a exampleID to identify the example.

Return type

\OpenAPI\Client\Model\TrainingExample

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

chatbotChatbotIDExamplesExampleIDPut

\OpenAPI\Client\Model\TrainingExample chatbotChatbotIDExamplesExampleIDPut($chatbot_id, $example_id, $training_example)

Returns a specific examples

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ExamplesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.
$example_id = 'example_id_example'; // string | Pass in a exampleID to identify the example.
$training_example = new \OpenAPI\Client\Model\TrainingExample(); // \OpenAPI\Client\Model\TrainingExample | 

try {
    $result = $apiInstance->chatbotChatbotIDExamplesExampleIDPut($chatbot_id, $example_id, $training_example);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExamplesApi->chatbotChatbotIDExamplesExampleIDPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
chatbot_id	string	Pass in a chatbotID to identify the chatbot.
example_id	string	Pass in a exampleID to identify the example.
training_example	\OpenAPI\Client\Model\TrainingExample

Return type

\OpenAPI\Client\Model\TrainingExample

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

chatbotChatbotIDExamplesGet

\OpenAPI\Client\Model\TrainingExample[] chatbotChatbotIDExamplesGet($chatbot_id)

Returns all training examples

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ExamplesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.

try {
    $result = $apiInstance->chatbotChatbotIDExamplesGet($chatbot_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExamplesApi->chatbotChatbotIDExamplesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.

Return type

\OpenAPI\Client\Model\TrainingExample[]

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

chatbotChatbotIDExamplesPost

\OpenAPI\Client\Model\TrainingExample chatbotChatbotIDExamplesPost($chatbot_id, $training_example)

Create a specific training example

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ExamplesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.
$training_example = new \OpenAPI\Client\Model\TrainingExample(); // \OpenAPI\Client\Model\TrainingExample | 

try {
    $result = $apiInstance->chatbotChatbotIDExamplesPost($chatbot_id, $training_example);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExamplesApi->chatbotChatbotIDExamplesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.
training_example	\OpenAPI\Client\Model\TrainingExample

Return type

\OpenAPI\Client\Model\TrainingExample

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

chatbotChatbotIDIntentStatisticsGet

object chatbotChatbotIDIntentStatisticsGet($chatbot_id)

Get statistics per intent

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ExamplesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.

try {
    $result = $apiInstance->chatbotChatbotIDIntentStatisticsGet($chatbot_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExamplesApi->chatbotChatbotIDIntentStatisticsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.

Return type

object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ExamplesApi.md

Latest commit

History

ExamplesApi.md

File metadata and controls

OpenAPI\Client\ExamplesApi

chatbotChatbotIDEntityStatisticsGet

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDExamplesDelete

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDExamplesExampleIDDelete

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDExamplesExampleIDGet

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDExamplesExampleIDPut

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDExamplesGet

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDExamplesPost

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDIntentStatisticsGet

Example

Parameters

Return type

Authorization

HTTP request headers