MAXIOM API文档

MAXIOM是一个多语言自然语言处理API平台。本文档将提供MAXIOM API的使用说明及示例。

### API接口地址

MAXIOM API的接口地址为：https://api.maxiom.tech

### API使用说明

#### 请求URL

POST https://api.maxiom.tech/v1/nlp

#### 请求参数

| 参数名 | 类型 | 是否必填 | 参数说明 |
| ---------- | ------ | -------- | ------------------------------------------------------------ |
| text | string | 是 | 需要进行自然语言处理的文本。 |
| lang | string | 否 | 文本的语言类型，目前支持的语言有：中文（zh）和英文（en），默认为中文（zh）。 |
| nlp_module | string | 否 | 需要进行的NLP模块，目前支持的模块有：分词（segment）、词性标注（pos_tagging）、命名实体识别（ner）、依存句法分析（dep_parsing）、关键词提取（keyword_extraction）、文本摘要（summarization）、情感分析（sentiment_analysis）和问答系统（qa），默认为分词（segment）。 |

#### 请求示例

以下示例使用curl命令发送请求：

curl -X POST \
  https://api.maxiom.tech/v1/nlp \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "这是一个测试文本。",
    "lang": "zh",
    "nlp_module": "segment"
  }'

#### 响应参数

| 参数名 | 类型 | 参数说明 |
| ------ | ------ | ------------------------------------------ |
| code | int | 接口返回状态码，200表示请求成功。 |
| msg | string | 接口返回状态信息，请求成功时为"success"。 |
| data | object | 接口返回的数据。 |

#### 响应示例

以下示例为接口正常响应时的返回结果：

{
    "code": 200,
    "msg": "success",
    "data": {
        "result": [
            "这是",
            "一个",
            "测试",
            "文本",
            "。"
        ]
    }
}

### API模块说明

MAXIOM API目前支持以下NLP模块：

#### 分词（segment）

分词是将一段文本按照一定规则切分成词语的过程。MAXIOM API使用jieba分词工具进行中文分词，使用nltk分词工具进行英文分词。

#### 词性标注（pos_tagging）

词性标注是为分词结果中的每个词语标注其词性的过程。MAXIOM API使用jieba分词工具进行中文词性标注，使用nltk词性标注工具进行英文词性标注。

#### 命名实体识别（ner）

命名实体识别是识别出文本中的人名、地名、机构名等实体的过程。MAXIOM API使用jieba分词工具进行中文命名实体识别，使用spacy命名实体识别工具进行英文命名实体识别。

#### 依存句法分析（dep_parsing）

依存句法分析是分析句子中各个词语之间的依存关系的过程。MAXIOM API使用stanfordnlp依存句法分析工具进行中英文依存句法分析。

#### 关键词提取（keyword_extraction）

关键词提取是从文本中提取出最具代表性的词语的过程。MAXIOM API使用textrank算法进行中英文关键词提取。

#### 文本摘要（summarization）

文本摘要是将一篇文章压缩成关键信息的过程。MAXIOM API使用textrank算法进行中英文文本摘要。

#### 情感分析（sentiment_analysis）

情感分析是对一段文本进行情绪分析的过程，即判断该文本的情感倾向是正面、负面还是中性。MAXIOM API使用TextBlob进行英文情感分析。

#### 问答系统（qa）

问答系统是针对一个特定领域的问题进行自动回答的系统。MAXIOM API使用BERT和SQuAD2.0数据集进行中英文问答系统的构建。

### API调用示例

以下示例展示了如何使用Python代码调用MAXIOM API：

import requests
import json

api_url = 'https://api.maxiom.tech/v1/nlp'
text = '这是一个测试文本。'
payload = {'text': text, 'lang': 'zh', 'nlp_module': 'segment'}
headers = {'Content-Type': 'application/json'}

response = requests.post(api_url, headers=headers, data=json.dumps(payload))
if response.status_code == 200:
    result = response.json()['data']['result']
    print(result)
else:
    print('API调用失败')

以上代码使用requests库发送POST请求，将需要进行自然语言处理的文本以JSON格式发送到MAXIOM API接口，并从返回结果中获取分词的结果。