SDKs overview
Tisane offers software development kits (SDKs) and client libraries designed to facilitate integration with its text analysis API. These SDKs aim to abstract underlying HTTP requests and response parsing, enabling developers to incorporate features like content moderation, sentiment analysis, and named entity recognition directly within their applications Tisane API documentation. Client libraries are available for several popular programming languages, providing idiomatic interfaces for interacting with the Tisane platform.
The SDKs are built to support various use cases, including real-time text processing for social media monitoring, batch analysis for customer support tickets, and automated content filtering. They typically handle API authentication, request formatting, and error handling, allowing developers to focus on application logic rather than low-level API communication. The official SDKs are maintained by Tisane, with community contributions often expanding language support or offering alternative integration patterns.
Official SDKs by language
Tisane provides official SDKs for several programming languages, each designed to offer a native integration experience. These SDKs are maintained to reflect the latest API features and ensure compatibility. The table below outlines the officially supported languages, their corresponding package names, typical installation commands, and their general maturity status as of 2026.
| Language | Package/Module | Typical Install Command | Maturity |
|---|---|---|---|
| Python | tisane-sdk-python |
pip install tisane-sdk-python |
Stable |
| Node.js | @tisane/sdk |
npm install @tisane/sdk |
Stable |
| Java | com.tisane:tisane-java-sdk |
Add to pom.xml or build.gradle |
Stable |
| PHP | tisane/php-sdk |
composer require tisane/php-sdk |
Stable |
| Ruby | tisane-ruby-sdk |
gem install tisane-ruby-sdk |
Mature |
| Go | github.com/tisane/go-sdk |
go get github.com/tisane/go-sdk |
Mature |
| C# | Tisane.Sdk |
dotnet add package Tisane.Sdk |
Mature |
| Rust | tisane-sdk |
Add to Cargo.toml |
Mature |
For detailed documentation on each SDK, including specific class methods and configuration options, consult the official Tisane developer documentation.
Installation
Installing a Tisane SDK typically involves using the package manager specific to the chosen programming language. The process generally requires an active internet connection to download the necessary dependencies. Before installation, developers should ensure their development environment meets the minimum version requirements for the respective language and package manager.
Python SDK Installation
The Python SDK can be installed using pip, the standard package installer for Python:
pip install tisane-sdk-python
Node.js SDK Installation
For Node.js projects, the SDK is available via npm, the Node package manager:
npm install @tisane/sdk
Java SDK Installation
Java developers using Maven or Gradle can add the Tisane SDK as a dependency in their project's build file. For Maven, add the following to your pom.xml:
<dependency>
<groupId>com.tisane</groupId>
<artifactId>tisane-java-sdk</artifactId>
<version>1.0.0</version> <!-- Replace with the latest version -->
</dependency>
For Gradle, add to your build.gradle:
implementation 'com.tisane:tisane-java-sdk:1.0.0' // Replace with the latest version
PHP SDK Installation
The PHP SDK is installed using Composer:
composer require tisane/php-sdk
Ruby SDK Installation
The Ruby SDK can be installed via RubyGems:
gem install tisane-ruby-sdk
Go SDK Installation
For Go projects, use the go get command:
go get github.com/tisane/go-sdk
C# SDK Installation
C# developers can install the SDK using the .NET CLI or NuGet Package Manager:
dotnet add package Tisane.Sdk
Rust SDK Installation
For Rust projects, add the SDK to your Cargo.toml file:
[dependencies]
tisane-sdk = "0.1.0" # Replace with the latest version
After installation, an API key obtained from your Tisane account is required for authentication with the API services Tisane API reference documentation.
Quickstart example
This example demonstrates how to perform a basic text analysis using the Tisane Python SDK. The snippet illustrates authentication, sending a text for analysis, and processing the results. Similar quickstart guides for other languages are available in the Tisane documentation portal.
from tisane.tisane_sdk import TisaneClient
from tisane.models import Document, Request
# Replace 'YOUR_API_KEY' with your actual Tisane API key
api_key = "YOUR_API_KEY"
client = TisaneClient(api_key=api_key)
# Define the text to be analyzed
text_to_analyze = "The quick brown fox jumps over the lazy dog. This is a neutral sentence."
# Create a Document object
document = Document(text=text_to_analyze, language="en")
# Create a Request object, specifying analysis features if needed
# For a basic analysis, no explicit features are required.
request = Request(documents=[document])
try:
# Send the request to the Tisane API
response = client.analyze(request)
# Process the response
if response and response.documents:
for doc_result in response.documents:
print(f"Document ID: {doc_result.document_id}")
if doc_result.sentiment:
print(f" Sentiment: {doc_result.sentiment.label} (Score: {doc_result.sentiment.score})")
if doc_result.entities:
print(" Entities:")
for entity in doc_result.entities:
print(f" - {entity.text} (Type: {entity.type})")
if doc_result.profanity:
print(" Profanity detected.")
if doc_result.hate_speech:
print(" Hate speech detected.")
else:
print("No analysis results returned.")
except Exception as e:
print(f"An error occurred: {e}")
This Python quickstart demonstrates fetching sentiment, entities, and basic moderation flags. The specific features returned depend on the analysis options configured in the request and the capabilities of your Tisane subscription.
Community libraries
In addition to the official SDKs, the Tisane API can be accessed using standard HTTP client libraries available in virtually any programming language MDN Web Docs on HTTP status codes. This allows developers to integrate Tisane's services even if an official SDK is not available for their preferred language or if they require highly customized API interactions.
Examples of generic HTTP client libraries include:
- Python:
requests - JavaScript/Node.js:
axios,fetchAPI - Java:
java.net.HttpClient, Apache HttpClient - PHP: Guzzle HTTP Client
- Ruby:
Net::HTTP,Faraday - Go:
net/httppackage - C#:
HttpClient - Rust:
reqwest
When using a community-maintained library or a generic HTTP client, developers are responsible for handling API request construction, JSON serialization/deserialization, authentication header management, and error handling in accordance with the Tisane API specification. While these methods offer flexibility, official SDKs often provide a more streamlined development experience with pre-built models and methods for common tasks.