# 概要

このリファレンスでは、標準のHTTPとJSONベースの通信を使用してTisane APIを操作するためのRESTful webメソッドについてご紹介します。

Version: 4.8.0.0

## Servers

Tisaneパブリッククラウド
```
https://api.tisane.ai
```

## Security

### Tisane-API-Key

[Tisane開発者向けポータル](https://dev.tisane.ai/profile) に記載のAPIサブスクリプションキー（プライマリまたはセカンダリ）

Type: apiKey
In: header
Name: Ocp-Apim-Subscription-Key

## Download OpenAPI description

[概要](https://docs.tisane.ai/_bundle/@l10n/ja/apis/tisane-api-short.yaml)

## NLU / NLP Methods

これらは、入力テキストの解析と変換を実際に実行するメソッドです。

### テキストの解析

 - [POST /parse](https://docs.tisane.ai/ja/apis/tisane-api-short/nlu-nlp-methods/parse.md): このメソッドは、入力データを解析し、問題のあるコンテンツ、感情スニペット、エンティティ、トピック、フレーズ構造、品詞、ストップワードなどを検出します。

### 利用可能なすべての言語を一覧表示

 - [GET /languages](https://docs.tisane.ai/ja/apis/tisane-api-short/nlu-nlp-methods/languages.md): サポートされている言語のリストを取得します。

レスポンスには以下の属性が含まれます。
* id - 言語ID。
* name - ネイティブネーム。
* englishName - 英語名。
* nativeEncoding - 言語のエンコーディング。
* preferredFont - 表示に推奨されるフォント。
* latin - 言語がラテン文字を使用しているかどうか。
* rightToLeft - 言語が右から左へ書く文字体系を使用しているか（例：アラビア語、ヘブライ語、ペルシア語）。

### テキストのクリーンアップ

 - [POST /helper/extract_text](https://docs.tisane.ai/ja/apis/tisane-api-short/nlu-nlp-methods/extract_text.md): JavaScript、CSSタグ、JSON、その他のマークアップを削除し、デコードされた純粋なテキストを返すサービスメソッド。
リクエストボディには、テキストが抽出されるマークアップコンテンツが含まれています。

注意：このメソッドはバイナリコンテンツを処理しません。

### 固有表現の比較

 - [POST /compare/entities](https://docs.tisane.ai/ja/apis/tisane-api-short/nlu-nlp-methods/compareentities.md): 2つの複合固有表現を比較し、違いを特定します。
リクエストボディには以下の内容を含める必要があります。
* language1 （文字列） -最初のエンティティの言語のIETFタグ。
* entity1（文字列） -最初のエンティティ。
* language2（文字列） - 2番目のエンティティの言語のIETFタグ。
* entity2（文字列） - 2番目のエンティティ。
* type（文字列） -エンティティのタイプ（現在、personのみがサポートされています）。

詳細：Tisane API レスポンスガイドにおける固有表現
レスポンスには以下が含まれます。
* result（文字列） - 比較結果：
* no_single_entity - 1つまたは両方のエンティティが無効です。
* same - エンティティは同一です（名前順が異なる場合があります）。
* different - エンティティは異なり、詳細はdifferencesに記載。
* differences（文字列の配列） - 検出された差異は以下の通り。

    * given_name
    
    * surname
    
    * title（例：Mr.、Mrs.）

    * social_role（例：学位）
    
    * suffix
    
    * variation（例：スペルやスタイルの違い）

### 意味的類似性

 - [POST /similarity](https://docs.tisane.ai/ja/apis/tisane-api-short/nlu-nlp-methods/similarity.md): 2つのテキスト断片の意味的類似度を計算します。同じ言語のテキスト断片でも、異なる言語のテキスト断片でも可能です。

リクエストボディには以下を含める必要があります。
* content1（文字列） - 最初のテキスト断片。
* language1（文字列） - content1のIETF言語コード。
* content2（文字列） -比較対象の2番目のテキスト断片。
* language2（文字列） -content2のIETF言語コード。
 settings (object) - Additional settings as per specifications. More information: " settings（オブジェクト） - 仕様に従った追加の設定。詳細：Tisane API設定およびカスタマイズガイド。"

レスポンスは0から1の間の数値で、送信されたテキスト断片の類似度を表します。

### 言語を検出する

 - [POST /detectLanguage](https://docs.tisane.ai/ja/apis/tisane-api-short/nlu-nlp-methods/detectlanguage.md): 提供されたテキスト断片で使用されている言語を検出し、オフセットごとの内訳を返します。

リクエストボディには以下の内容を含める必要があります。
* content（文字列） -解析対象のテキスト断片。
* languages（文字列、オプション） - 言語コードのバーティカルバー区切りリストで、キューとして使用します。
* delimiter (文字列、オプション) - 断片を分割するための正規表現。デフォルトでは、断片は分割されません。
レスポンスは、言語コードの内訳が記載されたlanguages を含むJSON構造です。

### テキストの翻訳

 - [POST /transform](https://docs.tisane.ai/ja/apis/tisane-api-short/nlu-nlp-methods/transform.md): このメソッドは、入力テキストを翻訳します。
リクエストボディには、以下の要素を含める必要があります。
 from（文字列） - ソース言語の標準IETFタグ。または言語コードのバーティカルバー区切りのセットを用いて自動検出を呼び出します。
* to (string) - ターゲット言語の標準IETFタグ。ソース言語とターゲット言語が同じ場合、パラフレーズが適用されます。
* content（文字列） - 翻訳対象のテキスト内容。
* settings（オブジェクト） - 追加の翻訳設定。

詳細：Tisane API設定およびカスタマイズガイド。

レスポンスは変換されたテキストです。

## Language Model Direct Access

言語モデルからエントリを取得し、検査するメソッド。

### 活用形のリスト

 - [GET /lm/inflections](https://docs.tisane.ai/ja/apis/tisane-api-short/language-model-direct-access/inflections.md): 所定の語族内の指定された語彙素の活用形を取得