Slamby API
This PHP package is automatically generated by the modified Swagger Codegen project:
- API version: 1.5.0
- Package version: 1.5.1
- Build date: 2017-02-07T12:59:29.743+01:00
- Build package: class io.swagger.codegen.languages.PhpClientCodegen
PHP 5.4.0 and later
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/slamby/slamby-sdk-php.git"
}
],
"require": {
"slamby/slamby-sdk-php": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php
:
require_once('/path/to/SwaggerClient-php/autoload.php');
To run the unit tests:
composer install
./vendor/bin/phpunit lib/Tests
require 'autoload.php';
use \Swagger\Client\Configuration;
use \Swagger\Client\ApiClient;
use \Swagger\Client\ApiException;
use \Swagger\Client\ObjectSerializer;
use \Swagger\Client\Api;
use \Swagger\Client\Model;
$config = new Configuration();
$config->setHost("http://<api_host>/");
$config->setSSLVerification(false);
$config->addDefaultHeader("Authorization", "Slamby <api_secret>");
$client = new ApiClient($config);
Getting DataSet list
$dataSetManager = new Api\DataSetApi($client);
$dataSets = $dataSetManager->getDataSets();
Selecting a DataSet for work
$config->addDefaultHeader("X-DataSet", "<my_dataset>");
Get Tag list
$tagManager = new Api\TagApi($client);
$tags = $tagManager->getTags();
Creating a new Tag
$tag = new Model\Tag();
$tag["id"] = "123";
$tag["name"] = "New tag";
try {
$tagManager->createTag($tag);
} catch (ApiException $e) {
print($e->getResponseObject());
}
Get a Document
$documentManager = new Api\DocumentApi($client);
$document = $documentManager->getDocument("123456");
Update a Document
try {
$document->language = "hu";
$documentManager->updateDocument("123456", $document);
} catch (ApiException $e) {
print($e->getResponseObject());
}
All URIs are relative to https://localhost/
Class | Method | HTTP request | Description |
---|---|---|---|
ClassifierServiceApi | classifierActivateService | POST /api/Services/Classifier/{id}/Activate | |
ClassifierServiceApi | classifierDeactivateService | POST /api/Services/Classifier/{id}/Deactivate | |
ClassifierServiceApi | classifierExportDictionaries | POST /api/Services/Classifier/{id}/ExportDictionaries | |
ClassifierServiceApi | classifierGetService | GET /api/Services/Classifier/{id} | |
ClassifierServiceApi | classifierPrepareService | POST /api/Services/Classifier/{id}/Prepare | |
ClassifierServiceApi | classifierRecommendService | POST /api/Services/Classifier/{id}/Recommend | |
DataSetApi | createDataSet | POST /api/DataSets | |
DataSetApi | createDataSetSchema | POST /api/DataSets/Schema | |
DataSetApi | deleteDataSet | DELETE /api/DataSets/{name} | |
DataSetApi | getDataSet | GET /api/DataSets/{name} | |
DataSetApi | getDataSets | GET /api/DataSets | |
DataSetApi | updateDataSet | PUT /api/DataSets/{existingName} | |
DocumentApi | bulkDocuments | POST /api/Documents/Bulk | |
DocumentApi | copyDocuments | POST /api/Documents/Copy | |
DocumentApi | createDocument | POST /api/Documents | |
DocumentApi | deleteDocument | DELETE /api/Documents/{id} | |
DocumentApi | getDocument | GET /api/Documents/{id} | |
DocumentApi | getFilteredDocuments | POST /api/Documents/Filter/{scrollId} | |
DocumentApi | getSampleDocuments | POST /api/Documents/Sample | |
DocumentApi | moveDocuments | POST /api/Documents/Move | |
DocumentApi | updateDocument | PUT /api/Documents/{id} | |
HelperApi | fileParser | POST /api/Helper/FileParser | |
LicenseApi | changeLicense | POST /api/License | |
LicenseApi | getLicense | GET /api/License | |
MaintenanceApi | changeSecret | POST /api/Maintenance/ChangeSecret | |
PrcServiceApi | prcActivateService | POST /api/Services/Prc/{id}/Activate | |
PrcServiceApi | prcDeactivateService | POST /api/Services/Prc/{id}/Deactivate | |
PrcServiceApi | prcExportDictionaries | POST /api/Services/Prc/{id}/ExportDictionaries | |
PrcServiceApi | prcGetService | GET /api/Services/Prc/{id} | |
PrcServiceApi | prcIndexPartialService | POST /api/Services/Prc/{id}/IndexPartial | |
PrcServiceApi | prcIndexService | POST /api/Services/Prc/{id}/Index | |
PrcServiceApi | prcKeywordsService | POST /api/Services/Prc/{id}/Keywords | |
PrcServiceApi | prcPrepareService | POST /api/Services/Prc/{id}/Prepare | |
PrcServiceApi | prcRecommendByIdService | POST /api/Services/Prc/{id}/RecommendById | |
PrcServiceApi | prcRecommendService | POST /api/Services/Prc/{id}/Recommend | |
ProcessApi | cancelProcess | POST /api/Processes/{id}/Cancel | |
ProcessApi | getProcess | GET /api/Processes/{id} | |
ProcessApi | getProcesses | GET /api/Processes | |
SearchServiceApi | searchActivateService | POST /api/Services/Search/{id}/Activate | |
SearchServiceApi | searchDeactivateService | POST /api/Services/Search/{id}/Deactivate | |
SearchServiceApi | searchGetService | GET /api/Services/Search/{id} | |
SearchServiceApi | searchPrepareService | POST /api/Services/Search/{id}/Prepare | |
SearchServiceApi | searchService | POST /api/Services/Search/{id} | |
ServiceApi | createService | POST /api/Services | |
ServiceApi | deleteService | DELETE /api/Services/{id} | |
ServiceApi | getService | GET /api/Services/{id} | |
ServiceApi | getServices | GET /api/Services | |
ServiceApi | updateService | PUT /api/Services/{id} | |
StatisticsApi | getStatistics | GET /api/Statistics | |
StatisticsApi | getStatistics_0 | GET /api/Statistics/{year} | |
StatisticsApi | getStatistics_1 | GET /api/Statistics/{year}/{month} | |
StatusApi | getStatus | GET /api/Status | |
TagApi | bulkTags | POST /api/Tags/Bulk | |
TagApi | cleanDocuments | POST /api/Tags/CleanDocuments | |
TagApi | createTag | POST /api/Tags | |
TagApi | deleteTag | DELETE /api/Tags/{id} | |
TagApi | getTag | GET /api/Tags/{id} | |
TagApi | getTags | GET /api/Tags | |
TagApi | updateTag | PUT /api/Tags/{id} | |
TagApi | wordsExport | POST /api/Tags/ExportWords |
- Action
- AutoCompleteResult
- AutoCompleteSettings
- BulkResult
- BulkResults
- ChangeLicense
- ChangeSecret
- ClassifierActivateSettings
- ClassifierPrepareSettings
- ClassifierRecommendationRequest
- ClassifierRecommendationResult
- ClassifierService
- ClassifierSettings
- CompressSettings
- DataSet
- DataSetStats
- DataSetUpdate
- DocumentBulkSettings
- DocumentCopySettings
- DocumentFilterSettings
- DocumentMoveSettings
- DocumentSampleSettings
- ErrorsModel
- ExportDictionariesSettings
- FileParser
- FileParserResult
- Filter
- License
- Order
- PaginatedListObject
- Pagination
- PathItem
- PrcActivateSettings
- PrcIndexSettings
- PrcKeywordsRequest
- PrcKeywordsResult
- PrcPrepareSettings
- PrcRecommendationByIdRequest
- PrcRecommendationRequest
- PrcRecommendationResult
- PrcService
- Process
- SearchActivateSettings
- SearchClassifierRecommendationResult
- SearchPrepareSettings
- SearchRequest
- SearchResult
- SearchResultWrapper
- SearchService
- SearchSettings
- Service
- Statistics
- StatisticsWrapper
- Status
- Tag
- TagBulkSettings
- TagProperties
- TagsExportWordsSettings
- Weight
All endpoints do not require authorization.