To answer any query about your data
PHP 7.4 and later. Should also work with PHP 8.0.
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/semanticwrap/semanticwrap-php-client.git"
}
],
"require": {
"semanticwrap/semanticwrap-php-client": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php
:
<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Semanticwrap\Api\AugmentationApi(
// 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()
);
$index_name = 'index_name_example'; // string
$payload = new \Semanticwrap\Model\CompletionQuery(); // \Semanticwrap\Model\CompletionQuery
$error_on_empty_docs = 'error_on_empty_docs_example'; // string | If true, will return 400 error if no docs are found
$with_source = 'with_source_example'; // string | If true, the source of the answer is returned
try {
$result = $apiInstance->asyncAugment($index_name, $payload, $error_on_empty_docs, $with_source);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AugmentationApi->asyncAugment: ', $e->getMessage(), PHP_EOL;
}
All URIs are relative to /api/v2
Class | Method | HTTP request | Description |
---|---|---|---|
AugmentationApi | asyncAugment | POST /augmentation/async/augment/{index_name} | Answers a given query from the documents in the index |
AugmentationApi | augment | POST /augmentation/augment/{index_name} | Answers a given query from the documents in the index |
AugmentationApi | augmentByUrls | POST /augmentation/complex-chain/urls | Answers a given query from the documents in the index |
AugmentationApi | chatAugment | POST /augmentation/chat/augment/{index_name} | Answers a given query from the documents in the index |
AugmentationApi | complexAugment | POST /augmentation/complex-chain/docs | Answers a given query from the documents in the index |
DocumentsApi | deleteDocument | DELETE /doc/{index_name}/{doc_id} | Deletes a document |
DocumentsApi | deleteDocumentByQuery | POST /doc/delete_by_query/{index_name} | Delete a document by query |
DocumentsApi | getDocument | GET /doc/{index_name}/{doc_id} | Get a document |
DocumentsApi | getDocumentByQuery | POST /doc/{index_name} | Get a document by query |
DocumentsApi | updateDocumentByQuery | POST /doc/_update_by_query/{index_name} | Update a document by query |
FineTunedApi | listFineTunedModel | POST /fine_tuned/ | Get fine tuned models |
FineTunedApi | memorylessAugmentV2 | POST /fine_tuned/memoryless/augment | Answers a given query from the documents in the index |
IndexApi | createIndex | PUT /index/_mapping/{index_name} | Create a new index if it does not exist |
IndexApi | indexDocuments | POST /index/bulk/{index_name} | Adds new documents to the index |
ProcessApi | getAsyncProcessResult | GET /async_process/{process_id} | Get result of async process |
SearchApi | search | POST /search/{index_name} | Get Related Documents from the index with ANN search |
SearchApi | searchByVector | POST /search/vector/{index_name} | Get Related Documents from the index with ANN search |
SearchApi | searchDocsById | POST /search/{index_name}/{doc_id} | Get Related Documents from the index with ANN search for given document id |
VideoApi | getYoutubeTranscript | POST /video/youtube_transcript/{video_id} | Get video transcript |
- AIModel
- Ack
- AsyncProcessResponse
- AugmentationQueryV2
- AuthSecurity
- BulkIndex
- ChatCompletionQuery
- CompletionQuery
- CompletionQueryFilter
- CompletionQueryModel
- CompletionQueryPrompt
- CompletionResponse
- CompletionResponseResult
- CompletionResponseTiming
- ComplexAugmentationWithDocs
- DocsSearch
- DocsSearchFilter
- Document
- DocumentNonQuery
- DocumentQuery
- DocumentQueryByVector
- DocumentQueryFilter
- DocumentQueryModel
- Error
- IndexMapping
- IndexMappingModel
- IndexResponse
- IndexResponseTiming
- LlmBulkResponse
- LlmBulkResponseTiming
- LlmResponse
- PromptTemplateModel
- QueryFilter
- RelatedDocs
- SWAIFineTunedModel
- SearchResponse
- TimingModel
- UpdateDoc
- UrlCrawlingAugmentationQuery
- YoutubeMicrodataRequestModel
- YoutubeTranscriptResponseModel
All endpoints do not require authorization.
To run the tests, use:
composer install
vendor/bin/phpunit
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
2.0
- Package version:
2.0.5
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen