# Teneo Platform

Welcome to Teneo Platform Reference Documentation \- here you will find documentation for the entire Teneo Platform.

## Reference Documentation

Reference Documentation about usage and configuration of all the Platform components can be found in the menu of this documentation area. The pages are organized into functional groups based on how and when the features will be seen in the Platform and will provide the reader with information and step-by-step guides on how to work with Teneo as well as conceptual overviews and detailed documents.

You might be looking for:

+ Reference:
  + [Language Capabilities in Teneo](/reference/nlp-capabilities/)
  + [Pre-built Knowledge](/reference/pre-built-knowledge/)
  + The complete [Teneo Linguistic Modeling Language](reference/teneo-programming/tlml-reference-manual) manual
  + The [Teneo Query Language](reference/teneo-programming/tql-manual) manual
+ User Guides:  
  + [Teneo Studio](/user-guide/teneo-studio/) 
  + [Teneo Log Data Manager (Inquire)](/user-guide/teneo-log-data-manager/)
  + [Teneo Manager](/user-guide/teneo-manager/)
+ [Component API Reference](#component-api-reference)
+ [Knowledge Base](/knowledge-base/)
+ Information related to [releases of the Teneo Platform](#releases)

## Component API Reference

The following documents are reference documents for parts of the Platform accessible via external code.



#### __Engine Scripting API__

__Engine Scripting Javadoc__

[Engine Scripting API](javadoc/engine-scripting-api/overview-summary.html ':ignore') describes the methods available via groovy scripting in scripts within a solution.

The key entry points into the scripting are [```engineAccess``` (alias: ```_```)](javadoc/engine-scripting-api/com/artisol/teneo/engine/core/engine/EngineAccess.html ':ignore') which provides access to the state and functionalities of the Teneo Engine including dialog history and Input Annotations, and [```engineEnvironment```](javadoc/engine-scripting-api/com/artisol/teneo/engine/webapp/HttpEngineEnvironment.html ':ignore') which provides access to the state of the servlet session including Request Parameters and Cookies

#### __Date & Time Handler API__

__Date & Time Javadoc__

[Date & Time Handler API](javadoc/datetime-postprocessing/overview-summary.html ':ignore') describes the methods available for post-processing of Date & Time data to interpret Dates & Times given in the input

The key entry point for the interpretation are the [```Handler```](javadoc/datetime-postprocessing/datetime/Handler.html ':ignore') class, specifically the [```interpret```](javadoc/datetime-postprocessing/datetime/Handler.html#interpret-java.util.Map- ':ignore') methods which are used in a solution to interpret the given inputs ([more here](reference/pre-built-knowledge/date-and-time?id=usage))

#### __Inquire API__

__Inquire Client Javadoc__

[Inquire Client API](javadoc/inquire-client/overview-summary.html ':ignore') describes the methods provided for interacting with the Teneo Inquire API for querying session logs and other functions from within java code.

The key entry point for querying log data in Inquire is the [```QueryClient```](javadoc/inquire-client/com/artisol/teneo/inquire/client/QueryClient.html ':ignore') class

__Inquire Server REST API Endpoints - Swagger__

[Inquire REST API](${variables.inquirePublicUrl}/swagger/index.html ':ignore') describes the endpoints which can be called in order to interact with Teneo Inquire for querying session logs and other functions.

__Inquire client and dependencies__

[${variables.inquirePublicUrl}/client/index.html](${variables.inquirePublicUrl}/client/index.html ':ignore') provides the jar files and dependency list for the Inquire client.

#### __Manager API__

__Manager Server REST API Endpoints - Swagger__

[Manager REST API](${variables.managerPublicUrl}/swagger/index.html ':ignore') describes the endpoints which can be called in order to interact with Teneo Manager for managing Teneo Platform user permissions and configuration.

__Manager client and dependencies__

[${variables.managerPublicUrl}/client/index.html](${variables.managerPublicUrl}/client/index.html ':ignore') provides the jar files and dependency list for the manager client.

#### __Studio API__

__Studio Server REST API Endpoints - Swagger__

[Studio REST API](${variables.studioPublicUrl}/swagger/index.html ':ignore') describes the endpoints which can be called in order to interact with Teneo Studio for editing, testing and publishing Teneo solutions.

__Studio client and dependencies__

[${variables.studioPublicUrl}/client/index.html](${variables.studioPublicUrl}/client/index.html ':ignore') provides the jar files and dependency list for the studio client.




## Releases

### Teneo Platform 7.1

__September 2022__

The __Teneo Platform Release 7.1__ brings new features and improvements to the Teneo Platform.

[Full details](/home/teneo-7.1/)

__Summary__

Key features included in this release are:

+ Teneo Studio Web comes with:
  + Globals: Variables, Listeners, Scripted Contexts and Scripts
  + Integrations
  + File Resources
  + Notifications in Tryout
+ Multiple Global Scripts in both Studio Web and Studio Desktop
+ Upgraded tech stack, including:
  + Kafka 3.2.0
  + Java 11.0.15
  + Cassandra 4.0.5
  + Tomcat 9.0.65
  + Spark 3.3.0
+ Extended public API (Studio)
+ User Driven Improvements and KI Resolutions

### Teneo Platform 7.0.3

__September 2022__

Being a maintenance release, __Teneo 7.0.3__ brings some fixes and improvements. 

[Full details](/home/teneo-7.0.3/)

__Summary__

+ Resolution of a security vulnerability in Teneo Manager
+ Improvements to Teneo Languages

### Teneo Platform 7.0.2

__August 2022__

Being a maintenance release, __Teneo 7.0.2__ brings some fixes and improvements.

[Full details](/home/teneo-7.0.2/)

__Summary__

Key features included in this release are:

+ Publish status retrieval in Teneo Studio Desktop for SaaS environments
+ Bug fixes and User Driven Improvements

### Teneo Platform 7.0.1

__June 2022__

Being a maintenance release, __Teneo 7.0.1__ brings various improvements.

[Full details](/home/teneo-7.0.1/)

__Summary__

Key features included in this release are:

+ Teneo Studio Web:	
  + General improvements to stability and performance
  + Open, see and work with big Entities (1000+)
  + Flow editor optimization
  + Support for delegated authentication
+ Teneo Studio Desktop
  + Optimization to improve general performance and solution loading
  + Bug fixes and User Driven Improvements

### Teneo Platform 7.0

__May 2022__

The __Teneo 7.0 Platform Release__ brings new features and improvements to the Teneo Platform.

[Full details](/home/teneo-7/)

__Summary__

Key features included in this release are:

+ Teneo Studio Web UI coming with:
  + Home page including Solutions list
  + Solution creation
  + Solution dashboard
  + Document creation and editing (Flows, Language Objects, Entities)
  + Simple Tryout
+ Teneo Studio Desktop brings:
  + Simplified solution creation process
  + More guidance for Flow creation and editing
+ First iteration of Audit Logging
+ Extended public APIs (Studio and Manager)
+ Tomcat version upgrade
+ Bug fixes and User Driven Improvements

----

RELEASE NOTES

Platform Dependencies

Dependencies and Licenses

Prerequisites of Teneo Frontends

Teneo 7.0

Teneo 7.0.1

Teneo 7.0.2

Teneo 7.0.3

Teneo 7.1

Technology and Deployment

Teneo Studio

Technology and deployment

KNOWLEDGE BASE

Bulk Import formats

Format Entities

Format Language Objects

Format Question and Answer pairs

General about format

General

FAQs

Log data

Data model

Metadata

Machine learning

Class Manager

Class Performance

Publish

Solution publish

Resources

Lexical resources

Lexical resources for log data analysis

Teneo naming conventions

Scripts

NLU Variables and Propagation scripts

Predicate scripts

Using scripts

Solution

Localization setup

Multiple Flow Triggers

Skip Conditions

Predefining template solutions

Prompt Triggers

Relative ordering

Resume Prompts

Safetynet and default output

Sub-flows

Teneo Engine

Environment recognition

Output parameters

Processing path

Script and Listener events in the matching process

Stack of active flows

The answering process

TLML Syntax

Limit unused words to

Draft TLML Syntax

Sentence test order and stop testing

TLML Syntax Summary

TLML Syntax Writing

REFERENCE

API reference doc

Teneo Inquire client

Interfacing with API JSPs

Web Socket API

NLP Capabilities

Chinese IP Chain

Japanese IP Chain

Korean IP Chain

Date and Time

Named Entity Recognizer

POS Tagger

Standard IP Chain

Turkish IP Chain

Conversational Modules

Date & Time

Deprecated objects

Pre-built Entities

Flow lists

Named Entity ANNOT objects

POS/Morphology ANNOT objects

Dialogue Resources

Lexical Resources

Offensive Language Detection

Sentiment & Intensity Analysis

Teneo Linguistic Modelling Language (TLML)

Teneo Query Language (TQL)

Auto-test

Auto-test results panel

Automated testing

Class management

Class manager window

Working with Classes and training data

Entity

Entity Basics

Entity Window

Entries Editor

Variables

Flow

Bot Output

After Matches

Flow Basics

Flow Link

Flow Listener

Nodes and elements

Flow Variable

Flow window

Integration

Matches

Prompt

Script

Sub-flow

Transition

User Intent

Globals

Emotions

Global Listeners

Global Scripted Contexts

Global Scripts

Global Variables

Troubleshooting Globals

Import Export

Bulk import

Export/Import of lexical resource

Importing and exporting

Merging solutions

Language Object

Language Object Basics

Language Object Window

Optimization

Class performance

Classifier

Improvement suggestions

Querying log data

Ordering

Ordering groups

Ordering suggestions

Trigger Ordering window

Working with trigger relations

Publish environments

Publish a solution

Integrations

Resource Files

Custom IP Resource File

Troubleshooting Resources

Document Basics

Version Control

Keyboard Shortcuts

Lexical Resource Information

Properties Lists

Localization Structure

Updates From Master

Recycle Bin

Search

Solution Properties

Solution Window

Syntax Editor

Referenced Documents

Teneo Log Data Manager

Augmenters

Teneo Manager

Get Started

Import/Export

Lexical

Solution Basics

Spellcheck

User Permissions

Login

Tryout

Advanced Tryout

Detailed information

TENEO 7.1.0

# Teneo Platform

Welcome to Teneo Platform Reference Documentation \- here you will find documentation for the entire Teneo Platform.

## Reference D