README

OpenAPIClient-php

To answer any query about your data

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

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;
}

API Endpoints

All URIs are relative to /api/v2

Models

• 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

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 2.0
  • Package version: 2.0.5
• Build package: org.openapitools.codegen.languages.PhpClientCodegen