tencentcloud-sdk-nodejs/tencentcloud/services/nlp/v20190408/nlp_models.d.ts

腾讯云 API NODEJS SDK

/**
 * 分类详细信息
 */
export interface Category {
    /**
     * 分类id。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Id?: number;
    /**
     * 分类英文名。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label?: string;
    /**
     * 分类中文名。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Name?: string;
    /**
     * 分类置信度。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Score?: number;
}
/**
 * TextEmbellish请求参数结构体
 */
export interface TextEmbellishRequest {
    /**
     * 待润色的文本。中文文本长度需<=50字符；英文文本长度需<=30个单词。
     */
    Text: string;
    /**
     * 待润色文本的语言类型，支持语言如下：
  zh：中文
  en：英文
     */
    SourceLang: string;
    /**
     * 返回润色结果的个数。数量需>=1且<=5。
  （注意实际结果可能小于指定个数）
     */
    Number: number;
    /**
     * 控制润色类型，类型如下：
  both：同时返回改写和扩写
  expansion：扩写
  rewriting：改写
  m2a：从现代文改写为古文
  a2m：从古文改写为现代文
  默认为both。
     */
    Style?: string;
}
/**
 * EvaluateWordSimilarity返回参数结构体
 */
export interface EvaluateWordSimilarityResponse {
    /**
     * 词相似度分值。
     */
    Similarity?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RetrieveSimilarWords请求参数结构体
 */
export interface RetrieveSimilarWordsRequest {
    /**
     * 输入的词语。（仅支持UTF-8格式，不超过10字符）
     */
    Text: string;
    /**
     * 召回的相似词个数，取值范围为1-20。
     */
    Number: number;
}
/**
 * ClassifyContent返回参数结构体
 */
export interface ClassifyContentResponse {
    /**
     * 一级分类。（请参见附录[三级分类体系表](https://cloud.tencent.com/document/product/271/94286)）
     */
    FirstClassification?: Category;
    /**
     * 二级分类。（请参见附录[三级分类体系表](https://cloud.tencent.com/document/product/271/94286)）
     */
    SecondClassification?: Category;
    /**
     * 三级分类。（请参见附录[三级分类体系表](https://cloud.tencent.com/document/product/271/94286)）
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ThirdClassification?: Category;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ParseWords返回参数结构体
 */
export interface ParseWordsResponse {
    /**
     * 输入文本正则化的结果。（包括对英文文本中的开头和实体进行大写等）
     */
    NormalText?: string;
    /**
     * 基础粒度分词和词性标注的结果。（请参见附录[词性表](https://cloud.tencent.com/document/product/271/36460)）
     */
    BasicParticiples?: Array<BasicParticiple>;
    /**
     * 复合粒度分词和词性标注的结果。（请参见附录[词性表](https://cloud.tencent.com/document/product/271/36460)）
     */
    CompoundParticiples?: Array<CompoundParticiple>;
    /**
     * 实体识别结果。（请参见附录[实体类型数据](https://cloud.tencent.com/document/product/271/90592)）
  
     */
    Entities?: Array<Entity>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 基础粒度分词和词性标注的结果
 */
export interface BasicParticiple {
    /**
     * 基础词。
     */
    Word?: string;
    /**
     * 基础词在NormalText中的起始位置。
     */
    BeginOffset?: number;
    /**
     * 基础词的长度。
     */
    Length?: number;
    /**
     * 词性。
     */
    Pos?: string;
}
/**
 * ComposePoetry返回参数结构体
 */
export interface ComposePoetryResponse {
    /**
     * 诗题，即输入的生成诗词的关键词。
     */
    Title?: string;
    /**
     * 诗的内容。
     */
    Content?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ClassifyContent请求参数结构体
 */
export interface ClassifyContentRequest {
    /**
     * 待分类的文章的标题（仅支持UTF-8格式，不超过100字符）。
     */
    Title: string;
    /**
     * 待分类文章的内容, 每个元素对应一个段落。（仅支持UTF-8格式，文章内容长度总和不超过2000字符）
     */
    Content: Array<string>;
}
/**
 * RetrieveSimilarWords返回参数结构体
 */
export interface RetrieveSimilarWordsResponse {
    /**
     * 召回的相似词数组。
     */
    WordList?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * EvaluateSentenceSimilarity返回参数结构体
 */
export interface EvaluateSentenceSimilarityResponse {
    /**
     * 每个句子对的相似度分值。
     */
    ScoreList?: Array<number>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 文本润色结果
 */
export interface Embellish {
    /**
     * 润色后的文本。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Text?: string;
    /**
     * 润色类型。类型如下：
  expansion：扩写
  rewriting：改写
  translation_m2a：从现代文改写为古文
  translation_a2m：从古文改写为现代文
  
  
  注意：此字段可能返回 null，表示取不到有效值。
     */
    EmbellishType?: string;
}
/**
 * EvaluateWordSimilarity请求参数结构体
 */
export interface EvaluateWordSimilarityRequest {
    /**
     * 计算相似度的源词。（仅支持UTF-8格式，不超过10字符）
  
     */
    SourceWord: string;
    /**
     * 计算相似度的目标词。（仅支持UTF-8格式，不超过10字符）
  
     */
    TargetWord: string;
}
/**
 * 复合粒度分词和词性标注的结果。
 */
export interface CompoundParticiple {
    /**
     * 基础词。
     */
    Word?: string;
    /**
     * 基础词在NormalText中的起始位置。
     */
    BeginOffset?: number;
    /**
     * 基础词的长度。
     */
    Length?: number;
    /**
     * 词性。
     */
    Pos?: string;
}
/**
 * TextWriting返回参数结构体
 */
export interface TextWritingResponse {
    /**
     * 续写结果列表。
     */
    WritingList?: Array<Writing>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * AnalyzeSentiment返回参数结构体
 */
export interface AnalyzeSentimentResponse {
    /**
     * 正面情感概率。
     */
    Positive?: number;
    /**
     * 中性情感概率。
     */
    Neutral?: number;
    /**
     * 负面情感概率。
     */
    Negative?: number;
    /**
     * 情感分类结果：
  positive：正面情感
  negative：负面情感
  neutral：中性、无情感
     */
    Sentiment?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ParseWords请求参数结构体
 */
export interface ParseWordsRequest {
    /**
     * 待分析的文本（支持中英文文本，不超过500字符）
     */
    Text: string;
}
/**
 * 文本续写结果
 */
export interface Writing {
    /**
     * 续写的文本。
     */
    TargetText?: string;
    /**
     * 续写的前缀。
     */
    PrefixText?: string;
}
/**
 * SentenceCorrection返回参数结构体
 */
export interface SentenceCorrectionResponse {
    /**
     * 纠错结果列表。
  （注意仅展示错误句子的纠错结果，若句子无错则不展示，若全部待纠错句子都被认为无错，则可能返回数组为空）
     */
    CorrectionList?: Array<CorrectionItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 待分析的句子对
 */
export interface SentencePair {
    /**
     * 需要与目标句子计算相似度的源句子。（仅支持UTF-8格式，不超过500字符）
     */
    SourceText: string;
    /**
     * 目标句子。（仅支持UTF-8格式，不超过500字符）
  
     */
    TargetText: string;
}
/**
 * 通过关键词生成的句子信息
 */
export interface KeywordSentence {
    /**
     * 通过关键词生成的句子。
     */
    TargetText?: string;
}
/**
 * ComposeCouplet请求参数结构体
 */
export interface ComposeCoupletRequest {
    /**
     * 生成对联的关键词。长度需>=2，当长度>2时，自动截取前两个字作为关键字。内容需为常用汉字（不含有数字、英文、韩语、日语、符号等等其他）。
     */
    Text: string;
    /**
     * 返回的文本结果为繁体还是简体。0：简体；1：繁体。默认为0。
     */
    TargetType?: number;
}
/**
 * EvaluateSentenceSimilarity请求参数结构体
 */
export interface EvaluateSentenceSimilarityRequest {
    /**
     * 待分析的句子对数组。句子对应不超过1对，仅支持中文文本，原句子与目标句子均应不超过500字符。
     */
    SentencePairList: Array<SentencePair>;
}
/**
 * TextWriting请求参数结构体
 */
export interface TextWritingRequest {
    /**
     * 待续写的句子，文本统一使用utf-8格式编码，长度不超过200字符。
     */
    Text: string;
    /**
     * 待续写文本的语言类型，支持语言如下：
  zh：中文
  en：英文
     */
    SourceLang: string;
    /**
     * 返回续写结果的个数。数量需>=1且<=5。
  （注意实际结果可能小于指定个数）
     */
    Number: number;
    /**
     * 指定续写领域，支持领域如下：
  general：通用领域，支持中英文补全
  academic：学术领域，仅支持英文补全
  默认为general（通用领域）。
     */
    Domain?: string;
    /**
     * 指定续写风格，支持风格如下：
  science_fiction：科幻
  military_history：军事
  xuanhuan_wuxia：武侠
  urban_officialdom：职场
  默认为xuanhuan_wuxia（武侠）。
     */
    Style?: string;
}
/**
 * GenerateKeywordSentence返回参数结构体
 */
export interface GenerateKeywordSentenceResponse {
    /**
     * 生成的句子列表。
     */
    KeywordSentenceList?: Array<KeywordSentence>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 实体识别结果。
 */
export interface Entity {
    /**
     * 基础词。
     */
    Word?: string;
    /**
     * 基础词在NormalText中的起始位置。
     */
    BeginOffset?: number;
    /**
     * 基础词的长度。
     */
    Length?: number;
    /**
     * 实体类型的标准名字。
     */
    Type?: string;
    /**
     * 类型名字的自然语言表达。（中文或英文）
     */
    Name?: string;
}
/**
 * ComposePoetry请求参数结构体
 */
export interface ComposePoetryRequest {
    /**
     * 生成诗词的关键词。
     */
    Text: string;
    /**
     * 生成诗词的类型。0：藏头或藏身；1：藏头；2：藏身。默认为0。
     */
    PoetryType?: number;
    /**
     * 诗的体裁。0：五言律诗或七言律诗；5：五言律诗；7：七言律诗。默认为0。
     */
    Genre?: number;
}
/**
 * SentenceCorrection请求参数结构体
 */
export interface SentenceCorrectionRequest {
    /**
     * 待纠错的句子列表。可以以数组方式在一次请求中填写多个待纠错的句子。文本统一使用utf-8格式编码，每个中文句子的长度不超过150字符，每个英文句子的长度不超过100个单词，且数组长度需小于30，即句子总数需少于30句。
     */
    TextList: Array<string>;
}
/**
 * TextEmbellish返回参数结构体
 */
export interface TextEmbellishResponse {
    /**
     * 润色结果列表。
     */
    EmbellishList?: Array<Embellish>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * AnalyzeSentiment请求参数结构体
 */
export interface AnalyzeSentimentRequest {
    /**
     * 待分析的文本（仅支持UTF-8格式，不超过200字）。
     */
    Text: string;
}
/**
 * 纠错结果列表
 */
export interface CorrectionItem {
    /**
     * 纠错句子的序号。
     */
    Order?: number;
    /**
     * 错误的起始位置，从0开始。
     */
    BeginOffset?: number;
    /**
     * 错误内容长度。
     */
    Len?: number;
    /**
     * 错误内容。
     */
    Word?: string;
    /**
     * 纠错结果，当为删除类错误时，结果为null。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CorrectWord?: Array<string>;
    /**
     * 纠错类型。0：替换；1：插入；2：删除。
     */
    CorrectionType?: number;
    /**
     * 纠错信息置信度。0：error；1：warning；error的置信度更高。（仅供参考）
     */
    Confidence?: number;
    /**
     * 纠错信息中文描述。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DescriptionZh?: string;
    /**
     * 纠错信息英文描述。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DescriptionEn?: string;
}
/**
 * GenerateKeywordSentence请求参数结构体
 */
export interface GenerateKeywordSentenceRequest {
    /**
     * 生成句子的关键词，关键词个数需不超过4个，中文关键词长度应不超过10字符，英文关键词长度不超过3个单词。关键词中不可包含标点符号。
     */
    WordList: Array<string>;
    /**
     * 返回生成句子的个数。数量需>=1且<=5。
  （注意实际结果可能小于指定个数）
     */
    Number: number;
    /**
     * 指定生成句子的领域，支持领域如下：
  general：通用领域，支持中英文
  academic：学术领域，仅支持英文
  默认为general（通用领域）。
     */
    Domain?: string;
}
/**
 * ComposeCouplet返回参数结构体
 */
export interface ComposeCoupletResponse {
    /**
     * 横批。
     */
    TopScroll?: string;
    /**
     * 上联与下联。
     */
    Content?: Array<string>;
    /**
     * 当对联随机生成时，展示随机生成原因。
     */
    RandomCause?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}