{"id":15176625,"url":"https://github.com/qualityunit/semanticwrap-php-client","last_synced_at":"2026-06-09T15:30:18.910Z","repository":{"id":142351219,"uuid":"611880131","full_name":"QualityUnit/semanticwrap-php-client","owner":"QualityUnit","description":null,"archived":false,"fork":false,"pushed_at":"2023-09-27T15:42:32.000Z","size":197,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-03T14:24:02.283Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QualityUnit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-09T18:23:19.000Z","updated_at":"2023-03-12T23:47:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"1d593ff6-72b2-4fe2-86c6-2f57b420ecb0","html_url":"https://github.com/QualityUnit/semanticwrap-php-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2Fsemanticwrap-php-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2Fsemanticwrap-php-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2Fsemanticwrap-php-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2Fsemanticwrap-php-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QualityUnit","download_url":"https://codeload.github.com/QualityUnit/semanticwrap-php-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240221317,"owners_count":19767442,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-27T13:22:05.654Z","updated_at":"2026-06-09T15:30:18.861Z","avatar_url":"https://github.com/QualityUnit.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPIClient-php\n\nTo answer any query about your data\n\n\n## Installation \u0026 Usage\n\n### Requirements\n\nPHP 7.4 and later.\nShould also work with PHP 8.0.\n\n### Composer\n\nTo install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"https://github.com/semanticwrap/semanticwrap-php-client.git\"\n    }\n  ],\n  \"require\": {\n    \"semanticwrap/semanticwrap-php-client\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n\u003c?php\nrequire_once('/path/to/OpenAPIClient-php/vendor/autoload.php');\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n\n\n$apiInstance = new Semanticwrap\\Api\\AugmentationApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client()\n);\n$index_name = 'index_name_example'; // string\n$payload = new \\Semanticwrap\\Model\\CompletionQuery(); // \\Semanticwrap\\Model\\CompletionQuery\n$error_on_empty_docs = 'error_on_empty_docs_example'; // string | If true, will return 400 error if no docs are found\n$with_source = 'with_source_example'; // string | If true, the source of the answer is returned\n\ntry {\n    $result = $apiInstance-\u003easyncAugment($index_name, $payload, $error_on_empty_docs, $with_source);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling AugmentationApi-\u003easyncAugment: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n```\n\n## API Endpoints\n\nAll URIs are relative to */api/v2*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AugmentationApi* | [**asyncAugment**](docs/Api/AugmentationApi.md#asyncaugment) | **POST** /augmentation/async/augment/{index_name} | Answers a given query from the documents in the index\n*AugmentationApi* | [**augment**](docs/Api/AugmentationApi.md#augment) | **POST** /augmentation/augment/{index_name} | Answers a given query from the documents in the index\n*AugmentationApi* | [**augmentByUrls**](docs/Api/AugmentationApi.md#augmentbyurls) | **POST** /augmentation/complex-chain/urls | Answers a given query from the documents in the index\n*AugmentationApi* | [**chatAugment**](docs/Api/AugmentationApi.md#chataugment) | **POST** /augmentation/chat/augment/{index_name} | Answers a given query from the documents in the index\n*AugmentationApi* | [**complexAugment**](docs/Api/AugmentationApi.md#complexaugment) | **POST** /augmentation/complex-chain/docs | Answers a given query from the documents in the index\n*DocumentsApi* | [**deleteDocument**](docs/Api/DocumentsApi.md#deletedocument) | **DELETE** /doc/{index_name}/{doc_id} | Deletes a document\n*DocumentsApi* | [**deleteDocumentByQuery**](docs/Api/DocumentsApi.md#deletedocumentbyquery) | **POST** /doc/delete_by_query/{index_name} | Delete a document by query\n*DocumentsApi* | [**getDocument**](docs/Api/DocumentsApi.md#getdocument) | **GET** /doc/{index_name}/{doc_id} | Get a document\n*DocumentsApi* | [**getDocumentByQuery**](docs/Api/DocumentsApi.md#getdocumentbyquery) | **POST** /doc/{index_name} | Get a document by query\n*DocumentsApi* | [**updateDocumentByQuery**](docs/Api/DocumentsApi.md#updatedocumentbyquery) | **POST** /doc/_update_by_query/{index_name} | Update a document by query\n*FineTunedApi* | [**listFineTunedModel**](docs/Api/FineTunedApi.md#listfinetunedmodel) | **POST** /fine_tuned/ | Get fine tuned models\n*FineTunedApi* | [**memorylessAugmentV2**](docs/Api/FineTunedApi.md#memorylessaugmentv2) | **POST** /fine_tuned/memoryless/augment | Answers a given query from the documents in the index\n*IndexApi* | [**createIndex**](docs/Api/IndexApi.md#createindex) | **PUT** /index/_mapping/{index_name} | Create a new index if it does not exist\n*IndexApi* | [**indexDocuments**](docs/Api/IndexApi.md#indexdocuments) | **POST** /index/bulk/{index_name} | Adds new documents to the index\n*ProcessApi* | [**getAsyncProcessResult**](docs/Api/ProcessApi.md#getasyncprocessresult) | **GET** /async_process/{process_id} | Get result of async process\n*SearchApi* | [**search**](docs/Api/SearchApi.md#search) | **POST** /search/{index_name} | Get Related Documents from the index with ANN search\n*SearchApi* | [**searchByVector**](docs/Api/SearchApi.md#searchbyvector) | **POST** /search/vector/{index_name} | Get Related Documents from the index with ANN search\n*SearchApi* | [**searchDocsById**](docs/Api/SearchApi.md#searchdocsbyid) | **POST** /search/{index_name}/{doc_id} | Get Related Documents from the index with ANN search for given document id\n*VideoApi* | [**getYoutubeTranscript**](docs/Api/VideoApi.md#getyoutubetranscript) | **POST** /video/youtube_transcript/{video_id} | Get video transcript\n\n## Models\n\n- [AIModel](docs/Model/AIModel.md)\n- [Ack](docs/Model/Ack.md)\n- [AsyncProcessResponse](docs/Model/AsyncProcessResponse.md)\n- [AugmentationQueryV2](docs/Model/AugmentationQueryV2.md)\n- [AuthSecurity](docs/Model/AuthSecurity.md)\n- [BulkIndex](docs/Model/BulkIndex.md)\n- [ChatCompletionQuery](docs/Model/ChatCompletionQuery.md)\n- [CompletionQuery](docs/Model/CompletionQuery.md)\n- [CompletionQueryFilter](docs/Model/CompletionQueryFilter.md)\n- [CompletionQueryModel](docs/Model/CompletionQueryModel.md)\n- [CompletionQueryPrompt](docs/Model/CompletionQueryPrompt.md)\n- [CompletionResponse](docs/Model/CompletionResponse.md)\n- [CompletionResponseResult](docs/Model/CompletionResponseResult.md)\n- [CompletionResponseTiming](docs/Model/CompletionResponseTiming.md)\n- [ComplexAugmentationWithDocs](docs/Model/ComplexAugmentationWithDocs.md)\n- [DocsSearch](docs/Model/DocsSearch.md)\n- [DocsSearchFilter](docs/Model/DocsSearchFilter.md)\n- [Document](docs/Model/Document.md)\n- [DocumentNonQuery](docs/Model/DocumentNonQuery.md)\n- [DocumentQuery](docs/Model/DocumentQuery.md)\n- [DocumentQueryByVector](docs/Model/DocumentQueryByVector.md)\n- [DocumentQueryFilter](docs/Model/DocumentQueryFilter.md)\n- [DocumentQueryModel](docs/Model/DocumentQueryModel.md)\n- [Error](docs/Model/Error.md)\n- [IndexMapping](docs/Model/IndexMapping.md)\n- [IndexMappingModel](docs/Model/IndexMappingModel.md)\n- [IndexResponse](docs/Model/IndexResponse.md)\n- [IndexResponseTiming](docs/Model/IndexResponseTiming.md)\n- [LlmBulkResponse](docs/Model/LlmBulkResponse.md)\n- [LlmBulkResponseTiming](docs/Model/LlmBulkResponseTiming.md)\n- [LlmResponse](docs/Model/LlmResponse.md)\n- [PromptTemplateModel](docs/Model/PromptTemplateModel.md)\n- [QueryFilter](docs/Model/QueryFilter.md)\n- [RelatedDocs](docs/Model/RelatedDocs.md)\n- [SWAIFineTunedModel](docs/Model/SWAIFineTunedModel.md)\n- [SearchResponse](docs/Model/SearchResponse.md)\n- [TimingModel](docs/Model/TimingModel.md)\n- [UpdateDoc](docs/Model/UpdateDoc.md)\n- [UrlCrawlingAugmentationQuery](docs/Model/UrlCrawlingAugmentationQuery.md)\n- [YoutubeMicrodataRequestModel](docs/Model/YoutubeMicrodataRequestModel.md)\n- [YoutubeTranscriptResponseModel](docs/Model/YoutubeTranscriptResponseModel.md)\n\n## Authorization\nAll endpoints do not require authorization.\n## Tests\n\nTo run the tests, use:\n\n```bash\ncomposer install\nvendor/bin/phpunit\n```\n\n## Author\n\n\n\n## About this package\n\nThis PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: `2.0`\n    - Package version: `2.0.5`\n- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualityunit%2Fsemanticwrap-php-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqualityunit%2Fsemanticwrap-php-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualityunit%2Fsemanticwrap-php-client/lists"}