Protocol Documentation

Table of Contents

api/serverVisionSearch/v1/ime.proto

Top

CharacterInfo

@Description 汉字信息

FieldTypeLabelDescription
characterName string

汉字名称

characterFontLibrary int32

汉字字体库

CharacterPage

@Description 汉字分页数据

FieldTypeLabelDescription
characters CharacterInfo repeated

汉字列表

total int64

总数

CharacterRequest

@Description 汉字请求

FieldTypeLabelDescription
dataCode string

构件和构件位置编码拼接的，例如 A089_A03,A045_A01, 构件及位置用下划线连接，多个构件的话，使用逗号连接

CharacterResponse

@Description 汉字列表响应数据

FieldTypeLabelDescription
code int32

状态码

msg string

状态信息

data CharacterPage

响应数据

ComponentInfo

@Description 组件信息

FieldTypeLabelDescription
componentCode string

组件编码

componentFontLibrary int32

组件字体库

componentName string

组件名称

ComponentPage

@Description 组件分页数据

FieldTypeLabelDescription
components ComponentInfo repeated

组件列表

total int64

总数

ComponentPositionInfo

@Description 组件位置信息

FieldTypeLabelDescription
positionCode string

组件位置编码

positionImg string

组件位置图片

positionImgSelected string

组件位置图片-被选中

positionName string

组件位置名称

ComponentPositionPage

@Description 组件位置分页数据

FieldTypeLabelDescription
positionList ComponentPositionInfo repeated

组件位置列表

total int64

总数

ComponentPositionRequest

@Description 组件位置请求

FieldTypeLabelDescription
componentCode string

组件编码

ComponentPositionResponse

@Description 组件位置列表响应数据

FieldTypeLabelDescription
code int32

状态码

msg string

状态信息

data ComponentPositionPage

响应数据

ComponentRequest

@Description 组件信息请求，只一个笔画

FieldTypeLabelDescription
strokesCode string

笔画编码

ComponentResponse

@Description 组件列表响应数据

FieldTypeLabelDescription
code int32

状态码

msg string

状态信息

data ComponentPage

响应数据

StrokeInfo

@Description 笔画信息

FieldTypeLabelDescription
strokesCode string

笔画编码

strokesName string

笔画名称

strokesPinyin string

笔画拼音

strokesFontLibrary int32

笔画字体库

StrokePage

@Description 笔画分页数据

FieldTypeLabelDescription
tChineseFindStrokess StrokeInfo repeated

笔画列表

total int64

总数

StrokeRequest

@Description 笔画请求

FieldTypeLabelDescription
page int32

页码，从0开始，0=第一页

limit int32

每页数量

StrokeResponse

@Description 笔画列表响应数据

FieldTypeLabelDescription
code int32

状态码

msg string

状态信息

data StrokePage

响应数据

WordPage

@Description 联想词分页数据

FieldTypeLabelDescription
wordNames string repeated

联想词

briefWords string repeated

联想词简写

total int32

总数

WordRequest

@Description 联想词请求

FieldTypeLabelDescription
page int32

页码，从0开始，0=第一页

limit int32

每页数量

characterName string

单个汉字

characterCount int32

汉字数量

WordResponse

@Description 联想词列表响应数据

FieldTypeLabelDescription
code int32

状态码

msg string

状态信息

data WordPage

响应数据

Ime

Method NameRequest TypeResponse TypeDescription
Strokes .StrokeRequest .StrokeResponse

@Summary 获取笔画列表 @Description /ime/Strokes
Components .ComponentRequest .ComponentResponse

@Summary 获取组件列表 @Description /ime/Components
ComponentPositions .ComponentPositionRequest .ComponentPositionResponse

@Summary 获取组件位置列表 @Description /ime/ComponentPositions
Characters .CharacterRequest .CharacterResponse

@Summary 获取汉字列表 @Description /ime/Characters
WordRelated .WordRequest .WordResponse

@Summary 获取词语列表 @Description /ime/WordRelated

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)