NlpClient (tencentcloud-sdk-java 3.1.125 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.nlp.v20190408.NlpClient

public class NlpClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`NlpClient(Credential credential, String region)`
`NlpClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoSummarizationResponse`	`AutoSummarization(AutoSummarizationRequest req)` 利用人工智能算法，自动抽取文本中的关键信息并生成指定长度的文本摘要。可用于新闻标题生成、科技文献摘要生成和商品评论摘要等。
`ChatBotResponse`	`ChatBot(ChatBotRequest req)` 闲聊服务基于腾讯领先的NLP引擎能力、数据运算能力和千亿级互联网语料数据的支持，同时集成了广泛的知识问答能力，可实现上百种自定义属性配置，以及儿童语言风格及说话方式，从而让聊天变得更睿智、简单和有趣。
`CreateDictResponse`	`CreateDict(CreateDictRequest req)` 根据指定的名称、描述创建自定义词库。
`CreateWordItemsResponse`	`CreateWordItems(CreateWordItemsRequest req)` 向指定的词库中添加词条。
`DeleteDictResponse`	`DeleteDict(DeleteDictRequest req)` 删除自定义词库，会附带相应删除词库包含的所有词条。
`DeleteWordItemsResponse`	`DeleteWordItems(DeleteWordItemsRequest req)` 用于删除自定义词库中的词条。
`DependencyParsingResponse`	`DependencyParsing(DependencyParsingRequest req)` 句法依存分析接口能够分析出句子中词与词之间的相互依存关系，并揭示其句法结构，包括主谓关系、动宾关系、核心关系等等，可用于提取句子主干、提取句子核心词等，在机器翻译、自动问答、知识抽取等领域都有很好的应用。
`DescribeDictResponse`	`DescribeDict(DescribeDictRequest req)` 根据id或名称查询自定义词库信息。
`DescribeDictsResponse`	`DescribeDicts(DescribeDictsRequest req)` 返回属于当前用户的所有自定义词库列表。
`DescribeEntityResponse`	`DescribeEntity(DescribeEntityRequest req)` 输入实体名称，返回实体相关的信息如实体别名、实体英文名、实体详细信息、相关实体等。
`DescribeRelationResponse`	`DescribeRelation(DescribeRelationRequest req)` 输入两个实体，返回两个实体间的关系，例如马化腾与腾讯公司不仅是相关实体，二者还存在隶属关系（马化腾属于腾讯公司）。
`DescribeTripleResponse`	`DescribeTriple(DescribeTripleRequest req)` 三元组查询，主要分为两类，SP查询和PO查询。SP查询表示已知主语和谓语查询宾语，PO查询表示已知宾语和谓语查询主语。每一个SP或PO查询都是一个可独立执行的查询，TQL支持SP查询的嵌套查询，即主语可以是一个嵌套的子查询。其他复杂的三元组查询方法，请参考官网API文档示例。
`DescribeWordItemsResponse`	`DescribeWordItems(DescribeWordItemsRequest req)` 依据自定义词库的ID，查询对应的词条信息。
`KeywordsExtractionResponse`	`KeywordsExtraction(KeywordsExtractionRequest req)` 基于关键词提取平台，通过对文本内容进行深度分析，提取出文本内容中的关键信息，为用户实现诸如新闻内容关键词自动提取、评论关键词提取等提供基础服务。
`LexicalAnalysisResponse`	`LexicalAnalysis(LexicalAnalysisRequest req)` 词法分析接口提供以下三个功能： 1、智能分词：将连续的自然语言文本，切分成具有语义合理性和完整性的词汇序列； 2、词性标注：为每一个词附上对应的词性，例如名词、代词、形容词、动词等； 3、命名实体识别：快速识别文本中的实体，例如人名、地名、机构名等。所有的功能均基于千亿级大规模互联网语料进行持续迭代更新，以保证效果不断提升，用户无需担心新词发现、歧义消除、调用性能等问题。目前词法分析已经在泛互联网、金融、政务等不同垂直领域提供业务支持，并取得良好的效果。
`SearchWordItemsResponse`	`SearchWordItems(SearchWordItemsRequest req)` 查询指定自定义词库中的词条是否存在。
`SentenceEmbeddingResponse`	`SentenceEmbedding(SentenceEmbeddingRequest req)` 句向量接口能够将输入的句子映射成一个固定维度的向量，用来表示这个句子的语义特征，可用于文本聚类、文本相似度、文本分类等任务，能够显著提高它们的效果。该句向量服务由腾讯云自然语言处理团队联合微信智言团队共同打造，基于千亿级大规模互联网语料并采用Bert等领先的深度神经网络模型训练而成，在腾讯内部诸多业务的NLP任务上实测效果显著。
`SentimentAnalysisResponse`	`SentimentAnalysis(SentimentAnalysisRequest req)` 情感分析接口能够对带有情感色彩的主观性文本进行分析、处理、归纳和推理，识别出用户的情感倾向，是积极还是消极，并且提供各自概率。该功能基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升。
`SimilarWordsResponse`	`SimilarWords(SimilarWordsRequest req)` 相似词接口能够基于同义词库及词向量技术，检索出与输入词语在语义上最相似的若干个词语，可广泛用于检索系统、问答系统、文档归档等场景。
`TextClassificationResponse`	`TextClassification(TextClassificationRequest req)` 文本分类接口能够对用户输入的文本进行自动分类，将其映射到具体的类目上，用户只需要提供待分类的文本，而无需关注具体实现。该功能基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升。目前已提供： - 通用领域分类体系，包括15个分类类目，分别是汽车、科技、健康、体育、旅行、教育、职业、文化、军事、房产、娱乐、女性、奥运、财经以及其他，适用于通用的场景。 - 新闻领域分类体系，包括37个一级分类类目，285个二级分类（详细请见 [类目体系映射表](https://cloud.tencent.com/document/product/271/36459)），已应用于腾讯新闻的文章分类。更多垂直领域的分类体系即将推出，敬请期待。
`TextCorrectionResponse`	`TextCorrection(TextCorrectionRequest req)` 提供对中文文本的自动纠错功能，能够识别输入文本中的错误片段，定位错误并给出正确的文本结果；支持长度不超过2000字的长文本纠错。此功能是基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升，是搜索引擎、语音识别、内容审核等功能更好运行的基础之一。
`TextSimilarityResponse`	`TextSimilarity(TextSimilarityRequest req)` 句子相似度接口能够基于深度学习技术来计算一个源句子和多个目标句子的相似度，相似度分值越大的两个句子在语义上越相似。目前仅支持短文本（不超过500字符）的相似度计算，长文本的相似度计算也即将推出。鉴于句子相似度是一个应用非常广泛的功能，腾讯云自然语言处理团队在Bert等领先的深度神经网络模型的基础上，专门针对文本相似任务进行了优化，并持续迭代更新。基于句子相似度，可以轻松实现诸如文本去重、相似推荐等功能。
`UpdateDictResponse`	`UpdateDict(UpdateDictRequest req)` 修改自定义词库元数据信息，包括名称、描述。
`WordEmbeddingResponse`	`WordEmbedding(WordEmbeddingRequest req)` 词向量接口能够将输入的词语映射成一个固定维度的词向量，用来表示这个词语的语义特征。词向量是很多自然语言处理技术的基础，能够显著提高它们的效果。该词向量服务由腾讯知文自然语言处理团队联合腾讯AI Lab共同打造。使用的词向量基于千亿级大规模互联网语料并采用AI Lab自研的DSG算法训练而成，开源的词向量包含800多万中文词汇，在覆盖率、新鲜度及准确性等三方面性能突出。腾讯AI Lab词向量相关资料： https://ai.tencent.com/ailab/zh/news/detial?id=22 https://ai.tencent.com/ailab/nlp/zh/embedding.html
`WordSimilarityResponse`	`WordSimilarity(WordSimilarityRequest req)` 词相似度接口能够基于词向量技术来计算两个输入词语的余弦相似度，相似度数值越大的两个词语在语义上越相似。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NlpClient
```
public NlpClient(Credential credential,
                 String region)
```
  - NlpClient
```
public NlpClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - AutoSummarization
```
public AutoSummarizationResponse AutoSummarization(AutoSummarizationRequest req)
                                            throws TencentCloudSDKException
```
    利用人工智能算法，自动抽取文本中的关键信息并生成指定长度的文本摘要。可用于新闻标题生成、科技文献摘要生成和商品评论摘要等。
    
    Parameters:
    
    req - AutoSummarizationRequest
    
    Returns:
    
    AutoSummarizationResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChatBot
```
public ChatBotResponse ChatBot(ChatBotRequest req)
                        throws TencentCloudSDKException
```
    闲聊服务基于腾讯领先的NLP引擎能力、数据运算能力和千亿级互联网语料数据的支持，同时集成了广泛的知识问答能力，可实现上百种自定义属性配置，以及儿童语言风格及说话方式，从而让聊天变得更睿智、简单和有趣。
    
    Parameters:
    
    req - ChatBotRequest
    
    Returns:
    
    ChatBotResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDict
```
public CreateDictResponse CreateDict(CreateDictRequest req)
                              throws TencentCloudSDKException
```
    根据指定的名称、描述创建自定义词库。
    
    Parameters:
    
    req - CreateDictRequest
    
    Returns:
    
    CreateDictResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateWordItems
```
public CreateWordItemsResponse CreateWordItems(CreateWordItemsRequest req)
                                        throws TencentCloudSDKException
```
    向指定的词库中添加词条。
    
    Parameters:
    
    req - CreateWordItemsRequest
    
    Returns:
    
    CreateWordItemsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteDict
```
public DeleteDictResponse DeleteDict(DeleteDictRequest req)
                              throws TencentCloudSDKException
```
    删除自定义词库，会附带相应删除词库包含的所有词条。
    
    Parameters:
    
    req - DeleteDictRequest
    
    Returns:
    
    DeleteDictResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteWordItems
```
public DeleteWordItemsResponse DeleteWordItems(DeleteWordItemsRequest req)
                                        throws TencentCloudSDKException
```
    用于删除自定义词库中的词条。
    
    Parameters:
    
    req - DeleteWordItemsRequest
    
    Returns:
    
    DeleteWordItemsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DependencyParsing
```
public DependencyParsingResponse DependencyParsing(DependencyParsingRequest req)
                                            throws TencentCloudSDKException
```
    句法依存分析接口能够分析出句子中词与词之间的相互依存关系，并揭示其句法结构，包括主谓关系、动宾关系、核心关系等等，可用于提取句子主干、提取句子核心词等，在机器翻译、自动问答、知识抽取等领域都有很好的应用。
    
    Parameters:
    
    req - DependencyParsingRequest
    
    Returns:
    
    DependencyParsingResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDict
```
public DescribeDictResponse DescribeDict(DescribeDictRequest req)
                                  throws TencentCloudSDKException
```
    根据id或名称查询自定义词库信息。
    
    Parameters:
    
    req - DescribeDictRequest
    
    Returns:
    
    DescribeDictResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDicts
```
public DescribeDictsResponse DescribeDicts(DescribeDictsRequest req)
                                    throws TencentCloudSDKException
```
    返回属于当前用户的所有自定义词库列表。
    
    Parameters:
    
    req - DescribeDictsRequest
    
    Returns:
    
    DescribeDictsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeEntity
```
public DescribeEntityResponse DescribeEntity(DescribeEntityRequest req)
                                      throws TencentCloudSDKException
```
    输入实体名称，返回实体相关的信息如实体别名、实体英文名、实体详细信息、相关实体等。
    
    Parameters:
    
    req - DescribeEntityRequest
    
    Returns:
    
    DescribeEntityResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRelation
```
public DescribeRelationResponse DescribeRelation(DescribeRelationRequest req)
                                          throws TencentCloudSDKException
```
    输入两个实体，返回两个实体间的关系，例如马化腾与腾讯公司不仅是相关实体，二者还存在隶属关系（马化腾属于腾讯公司）。
    
    Parameters:
    
    req - DescribeRelationRequest
    
    Returns:
    
    DescribeRelationResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTriple
```
public DescribeTripleResponse DescribeTriple(DescribeTripleRequest req)
                                      throws TencentCloudSDKException
```
    三元组查询，主要分为两类，SP查询和PO查询。SP查询表示已知主语和谓语查询宾语，PO查询表示已知宾语和谓语查询主语。每一个SP或PO查询都是一个可独立执行的查询，TQL支持SP查询的嵌套查询，即主语可以是一个嵌套的子查询。其他复杂的三元组查询方法，请参考官网API文档示例。
    
    Parameters:
    
    req - DescribeTripleRequest
    
    Returns:
    
    DescribeTripleResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWordItems
```
public DescribeWordItemsResponse DescribeWordItems(DescribeWordItemsRequest req)
                                            throws TencentCloudSDKException
```
    依据自定义词库的ID，查询对应的词条信息。
    
    Parameters:
    
    req - DescribeWordItemsRequest
    
    Returns:
    
    DescribeWordItemsResponse
    
    Throws:
    
    TencentCloudSDKException
  - KeywordsExtraction
```
public KeywordsExtractionResponse KeywordsExtraction(KeywordsExtractionRequest req)
                                              throws TencentCloudSDKException
```
    基于关键词提取平台，通过对文本内容进行深度分析，提取出文本内容中的关键信息，为用户实现诸如新闻内容关键词自动提取、评论关键词提取等提供基础服务。
    
    Parameters:
    
    req - KeywordsExtractionRequest
    
    Returns:
    
    KeywordsExtractionResponse
    
    Throws:
    
    TencentCloudSDKException
  - LexicalAnalysis
```
public LexicalAnalysisResponse LexicalAnalysis(LexicalAnalysisRequest req)
                                        throws TencentCloudSDKException
```
    词法分析接口提供以下三个功能： 1、智能分词：将连续的自然语言文本，切分成具有语义合理性和完整性的词汇序列； 2、词性标注：为每一个词附上对应的词性，例如名词、代词、形容词、动词等； 3、命名实体识别：快速识别文本中的实体，例如人名、地名、机构名等。所有的功能均基于千亿级大规模互联网语料进行持续迭代更新，以保证效果不断提升，用户无需担心新词发现、歧义消除、调用性能等问题。目前词法分析已经在泛互联网、金融、政务等不同垂直领域提供业务支持，并取得良好的效果。
    
    Parameters:
    
    req - LexicalAnalysisRequest
    
    Returns:
    
    LexicalAnalysisResponse
    
    Throws:
    
    TencentCloudSDKException
  - SearchWordItems
```
public SearchWordItemsResponse SearchWordItems(SearchWordItemsRequest req)
                                        throws TencentCloudSDKException
```
    查询指定自定义词库中的词条是否存在。
    
    Parameters:
    
    req - SearchWordItemsRequest
    
    Returns:
    
    SearchWordItemsResponse
    
    Throws:
    
    TencentCloudSDKException
  - SentenceEmbedding
```
public SentenceEmbeddingResponse SentenceEmbedding(SentenceEmbeddingRequest req)
                                            throws TencentCloudSDKException
```
    句向量接口能够将输入的句子映射成一个固定维度的向量，用来表示这个句子的语义特征，可用于文本聚类、文本相似度、文本分类等任务，能够显著提高它们的效果。该句向量服务由腾讯云自然语言处理团队联合微信智言团队共同打造，基于千亿级大规模互联网语料并采用Bert等领先的深度神经网络模型训练而成，在腾讯内部诸多业务的NLP任务上实测效果显著。
    
    Parameters:
    
    req - SentenceEmbeddingRequest
    
    Returns:
    
    SentenceEmbeddingResponse
    
    Throws:
    
    TencentCloudSDKException
  - SentimentAnalysis
```
public SentimentAnalysisResponse SentimentAnalysis(SentimentAnalysisRequest req)
                                            throws TencentCloudSDKException
```
    情感分析接口能够对带有情感色彩的主观性文本进行分析、处理、归纳和推理，识别出用户的情感倾向，是积极还是消极，并且提供各自概率。该功能基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升。
    
    Parameters:
    
    req - SentimentAnalysisRequest
    
    Returns:
    
    SentimentAnalysisResponse
    
    Throws:
    
    TencentCloudSDKException
  - SimilarWords
```
public SimilarWordsResponse SimilarWords(SimilarWordsRequest req)
                                  throws TencentCloudSDKException
```
    相似词接口能够基于同义词库及词向量技术，检索出与输入词语在语义上最相似的若干个词语，可广泛用于检索系统、问答系统、文档归档等场景。
    
    Parameters:
    
    req - SimilarWordsRequest
    
    Returns:
    
    SimilarWordsResponse
    
    Throws:
    
    TencentCloudSDKException
  - TextClassification
```
public TextClassificationResponse TextClassification(TextClassificationRequest req)
                                              throws TencentCloudSDKException
```
    文本分类接口能够对用户输入的文本进行自动分类，将其映射到具体的类目上，用户只需要提供待分类的文本，而无需关注具体实现。该功能基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升。目前已提供： - 通用领域分类体系，包括15个分类类目，分别是汽车、科技、健康、体育、旅行、教育、职业、文化、军事、房产、娱乐、女性、奥运、财经以及其他，适用于通用的场景。 - 新闻领域分类体系，包括37个一级分类类目，285个二级分类（详细请见 [类目体系映射表](https://cloud.tencent.com/document/product/271/36459)），已应用于腾讯新闻的文章分类。更多垂直领域的分类体系即将推出，敬请期待。
    
    Parameters:
    
    req - TextClassificationRequest
    
    Returns:
    
    TextClassificationResponse
    
    Throws:
    
    TencentCloudSDKException
  - TextCorrection
```
public TextCorrectionResponse TextCorrection(TextCorrectionRequest req)
                                      throws TencentCloudSDKException
```
    提供对中文文本的自动纠错功能，能够识别输入文本中的错误片段，定位错误并给出正确的文本结果；支持长度不超过2000字的长文本纠错。此功能是基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升，是搜索引擎、语音识别、内容审核等功能更好运行的基础之一。
    
    Parameters:
    
    req - TextCorrectionRequest
    
    Returns:
    
    TextCorrectionResponse
    
    Throws:
    
    TencentCloudSDKException
  - TextSimilarity
```
public TextSimilarityResponse TextSimilarity(TextSimilarityRequest req)
                                      throws TencentCloudSDKException
```
    句子相似度接口能够基于深度学习技术来计算一个源句子和多个目标句子的相似度，相似度分值越大的两个句子在语义上越相似。目前仅支持短文本（不超过500字符）的相似度计算，长文本的相似度计算也即将推出。鉴于句子相似度是一个应用非常广泛的功能，腾讯云自然语言处理团队在Bert等领先的深度神经网络模型的基础上，专门针对文本相似任务进行了优化，并持续迭代更新。基于句子相似度，可以轻松实现诸如文本去重、相似推荐等功能。
    
    Parameters:
    
    req - TextSimilarityRequest
    
    Returns:
    
    TextSimilarityResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateDict
```
public UpdateDictResponse UpdateDict(UpdateDictRequest req)
                              throws TencentCloudSDKException
```
    修改自定义词库元数据信息，包括名称、描述。
    
    Parameters:
    
    req - UpdateDictRequest
    
    Returns:
    
    UpdateDictResponse
    
    Throws:
    
    TencentCloudSDKException
  - WordEmbedding
```
public WordEmbeddingResponse WordEmbedding(WordEmbeddingRequest req)
                                    throws TencentCloudSDKException
```
    词向量接口能够将输入的词语映射成一个固定维度的词向量，用来表示这个词语的语义特征。词向量是很多自然语言处理技术的基础，能够显著提高它们的效果。该词向量服务由腾讯知文自然语言处理团队联合腾讯AI Lab共同打造。使用的词向量基于千亿级大规模互联网语料并采用AI Lab自研的DSG算法训练而成，开源的词向量包含800多万中文词汇，在覆盖率、新鲜度及准确性等三方面性能突出。腾讯AI Lab词向量相关资料： https://ai.tencent.com/ailab/zh/news/detial?id=22 https://ai.tencent.com/ailab/nlp/zh/embedding.html
    
    Parameters:
    
    req - WordEmbeddingRequest
    
    Returns:
    
    WordEmbeddingResponse
    
    Throws:
    
    TencentCloudSDKException
  - WordSimilarity
```
public WordSimilarityResponse WordSimilarity(WordSimilarityRequest req)
                                      throws TencentCloudSDKException
```
    词相似度接口能够基于词向量技术来计算两个输入词语的余弦相似度，相似度数值越大的两个词语在语义上越相似。
    
    Parameters:
    
    req - WordSimilarityRequest
    
    Returns:
    
    WordSimilarityResponse
    
    Throws:
    
    TencentCloudSDKException

Class NlpClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

NlpClient

NlpClient

Method Detail

AutoSummarization

ChatBot

CreateDict

CreateWordItems

DeleteDict

DeleteWordItems

DependencyParsing

DescribeDict

DescribeDicts

DescribeEntity

DescribeRelation

DescribeTriple

DescribeWordItems

KeywordsExtraction

LexicalAnalysis

SearchWordItems

SentenceEmbedding

SentimentAnalysis

SimilarWords

TextClassification

TextCorrection

TextSimilarity

UpdateDict

WordEmbedding

WordSimilarity