AI Toolkit NLP API Documentation

Welcome to the AI Toolkit NLP API documentation. This page provides an overview of the Natural Language Processing (NLP) capabilities of the AI Toolkit, including various endpoints and their functionalities.

Overview

The AI Toolkit NLP API offers a suite of powerful tools for analyzing, understanding, and generating natural language. Whether you're looking to build a chatbot, analyze sentiment, or extract insights from text, our API has you covered.

Endpoints

Sentiment Analysis

Sentiment Analysis is used to determine the sentiment of a given text. It can be positive, negative, or neutral.

Endpoint: /api/nlp/sentiment
Method: POST

Example Request:

{
  "text": "I love using the AI Toolkit NLP API!"
}

Example Response:
```
{
  "sentiment": "positive"
}
```

Text Classification

Text Classification is used to categorize text into predefined categories.

Endpoint: /api/nlp/classification
Method: POST

Example Request:

{
  "text": "This is a great product!",
  "categories": ["positive", "neutral", "negative"]
}

Example Response:
```
{
  "category": "positive"
}
```

Language Detection

Language Detection is used to identify the language of a given text.

Endpoint: /api/nlp/language-detection
Method: POST

Example Request:

{
  "text": "Bonjour, comment ça va?"
}

Example Response:
```
{
  "language": "fr"
}
```

Entity Recognition

Entity Recognition is used to extract entities from a given text, such as names, locations, and organizations.

Endpoint: /api/nlp/entity-recognition
Method: POST

Example Request:

{
  "text": "Apple Inc. is an American multinational technology company headquartered in Cupertino, California."
}

Example Response:

{
  "entities": [
    {
      "entity": "Apple Inc.",
      "type": "organization"
    },
    {
      "entity": "Cupertino",
      "type": "location"
    }
  ]
}

Usage

To get started with the AI Toolkit NLP API, you'll need to sign up for an account and obtain an API key. Once you have your API key, you can make requests to the API endpoints using your preferred programming language.

For more information on how to get started, please visit our Getting Started Guide.