NumenoAPI-php

Introduction

Use the Numeno Persona API to create and manage Personas.

Evolving a Persona over time is dead-simple: create a Persona, then send natural-language descriptions of your users’ in-app activities to the Persona API. Under the hood, we create a rich set of models of the system that evolve over time. Then, ask Numeno to personalize some part of your experience using the Persona. Numeno will use our models to tailor your software to each user’s unique preferences and habits, allowing you to dynamically adjust your offerings.

For example, connect a Persona to the Numeno Article Recommender API to generate Article Feeds that evolve over time as your Persona evloves with user interaction.

Personas are not limited to modelling users. Posts in a social environment, articles or topics on a content platform, a screen or widget in your UI, a product in your inventory - groups of any of these things – Personas can evolve models of anything in your system! Get creative!

For more information, please visit https://numeno.ai/.

Installation & Usage

Requirements

PHP 7.4 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "minimum-stability": "dev",
  "require": {
    "numeno/api-persona": "dev-main"
  }
}

Then run composer install

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: ApiKeyAuth
$config = NumenoPersona\Configuration::getDefaultConfiguration()->setApiKey('X-Numeno-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NumenoPersona\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Numeno-Key', 'Bearer');


$apiInstance = new NumenoPersona\Api\DefaultApi(
    // 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
);
$persona_new = new \NumenoPersona\Model\PersonaNew(); // \NumenoPersona\Model\PersonaNew

try {
    $result = $apiInstance->createPersona($persona_new);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createPersona: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.numeno.ai/persona

Class	Method	HTTP request	Description
DefaultApi	createPersona	POST /v1/personas	Create a new Persona
DefaultApi	deletePersona	DELETE /v1/personas/{id}	Delete a Persona by ID
DefaultApi	getPersonaById	GET /v1/personas/{id}	Get a specific Persona by ID
DefaultApi	getPersonas	GET /v1/personas	Get a list of all Personas
DefaultApi	getScopes	GET /v1/scopes	Get the Scopes for this API
DefaultApi	healthCheck	GET /health	Check the health of the API
DefaultApi	updatePersona	PUT /v1/personas/{id}	Update a Persona by ID

Models

• ErrorDetail
• ErrorResponse
• HealthCheck
• Persona
• PersonaList
• PersonaNew
• PersonaUpdate
• Scopes

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-Numeno-Key
• Location: HTTP header

Author

support@numeno.ai

About this package

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

• API version: 1.0.0
  • Package version: 0.0.4
  • Generator version: 7.10.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen