Protocol Documentation

Table of Contents

api/base/v1/base.proto

Top

AddressLocationRequest

@description 通过城市名称获取经纬度请求

FieldTypeLabelDescription
address string

地址信息

Validated Fields

Field Validations
address
  • string.min_len: 1
  • string.max_len: 128

AddressResponse

FieldTypeLabelDescription
country string

国家

province string

省份

city string

城市

AiQuestionRequest

@description AI问答请求

FieldTypeLabelDescription
content string

询问内容

Validated Fields

Field Validations
content
  • string.min_len: 1
  • string.max_len: 5000

AiQuestionResponse

@description AI问答响应

FieldTypeLabelDescription
result string

回答内容

CaptchaResponse

@description 图形验证码响应

FieldTypeLabelDescription
code int32

状态码

msg string

状态消息

uuid string

唯一标识

img string

图片，base64编码

CustomScanRequest

@description 自定义扫码识别请求

FieldTypeLabelDescription
file bytes

要识别的文件

fieldName string

字段名称, 如果有多个，用逗号隔开

fieldDesc string

字段描述, 如果有多个，用逗号隔开, 和字段名称需要一一对应

Validated Fields

Field Validations
file
  • bytes.min_len: 10
  • bytes.max_len: 10485760
fieldName
  • string.max_len: 500
fieldDesc
  • string.max_len: 500

CustomScanResponse

@description 自定义扫码识别响应

FieldTypeLabelDescription
scanObj string

识别后，返回包含指定字段的对象字符串，json字符串格式

scanText string

识别后的所有文本信息

scanTextList string repeated

识别后的文本列表信息

DetectLanguageRequest

@description 文本语种检测请求

FieldTypeLabelDescription
text string

待识别的文字

Validated Fields

Field Validations
text
  • string.min_len: 1
  • string.max_len: 128

DetectLanguageResponse

@description 文本语种检测响应

FieldTypeLabelDescription
languageCode string

识别到的语言

EmailRequest

@description 邮件发送请求

FieldTypeLabelDescription
email string

邮箱

source int32

邮件来源（1：注册，2：登录，3：忘记密码，4：修改密码, 5：企业认证）

header Header

请求头

Validated Fields

Field Validations
email
  • string.min_len: 6
  • string.max_len: 50
  • string.email: true
source
  • int32.in: [1 2 3 4 5]

EmptyRequest

@description 空请求

FileUploadRequest

@description 文件上传请求

FieldTypeLabelDescription
fileName string

文件名

fileData bytes

文件数据(直接图片的二进制数据)

Validated Fields

Field Validations
fileName
  • string.max_len: 50
fileData
  • bytes.min_len: 10
  • bytes.max_len: 10485760

FileUploadResponse

@description 文件上传响应

FieldTypeLabelDescription
code int32

状态码

msg string

状态信息

data UrlInfo

下载地址

GoogleWord

@description 识别到的单个文字信息

FieldTypeLabelDescription
text string

识别到的文字

location TextLocation repeated

识别到的文字位置

HandwritingRecognitionRequest

@description 手写文字识别请求

FieldTypeLabelDescription
x int32 repeated

x坐标

y int32 repeated

y坐标

Validated Fields

Field Validations
x
  • repeated.min_items: 1
  • repeated.max_items: 5000
y
  • repeated.min_items: 1
  • repeated.max_items: 5000

HandwritingRecognitionResponse

@description 手写文字识别响应

FieldTypeLabelDescription
texts string repeated

识别到的文字

Header

@description 请求头

FieldTypeLabelDescription
appToken string

应用token

appIp string

应用ip地址

appType string

应用标识 assist, probe, namepower, brandpower, domain, ww等等

appVersion string

应用版本

sysType string

系统版本 1=android；2=iOS

languageCode string

语种

userMark string

应用设备唯一标识

Validated Fields

Field Validations
appIp
  • string.max_len: 15
appType
  • string.max_len: 15
  • string.ip: true
appVersion
  • string.max_len: 15
sysType
  • string.in: [1 2 3 4 5]
languageCode
  • string.max_len: 12
userMark
  • string.max_len: 64

ImageObjectDetectionRequest

@description 图片物体检测请求

FieldTypeLabelDescription
image bytes

图片，图片的直接二进制数据

languageCode string

语言

fileName string

图片名

Validated Fields

Field Validations
image
  • bytes.min_len: 10
  • bytes.max_len: 10485760
languageCode
  • string.max_len: 12
fileName
  • string.max_len: 128

ImageObjectDetectionResponse

@description 图片物体检测响应

FieldTypeLabelDescription
localizedObjectAnnoList LocalizedObjectAnno repeated

识别到的物体

ImageRecognitionRequest

@description 图片文字识别请求

FieldTypeLabelDescription
image bytes

图片，图片的直接二进制数据

fileName string

图片名

Validated Fields

Field Validations
image
  • bytes.min_len: 10
  • bytes.max_len: 10485760
fileName
  • string.max_len: 128

ImageRecognitionResponse

@description 图片文字识别响应

FieldTypeLabelDescription
words GoogleWord repeated

识别到的文字信息

LocalBoundingPoly

@description 图片物体边界框

FieldTypeLabelDescription
normalizedVertices Vertice repeated

顶点

LocalizedObjectAnno

@description 图片物体识别信息

FieldTypeLabelDescription
zhName string

识别到的物体中文名称

localName string

识别到的物体系统名称

boundingPoly LocalBoundingPoly

识别到的物体位置

Location

@description 经纬度响应

FieldTypeLabelDescription
latitude double

纬度

longitude double

经度

Validated Fields

Field Validations
latitude
  • double.lte: 180
  • double.gte: -180
longitude
  • double.lte: 180
  • double.gte: -180

SmsRequest

@description 短信发送请求，只针对于国内手机号

FieldTypeLabelDescription
userPhone string

手机号

source int32

短信来源（1：注册，2：登录，3：忘记密码，4：修改密码, 5：企业认证）

Validated Fields

Field Validations
userPhone
  • string.min_len: 11
  • string.max_len: 11
  • string.ip: true
source
  • int32.in: [1 2 3 4 5]

SpeechToTextRequest

@description 语音转文字请求

FieldTypeLabelDescription
audio bytes

语音数据，语音的直接二进制数据

languageCode string

语音语言

fileName string

语音名

Validated Fields

Field Validations
audio
  • bytes.min_len: 10
  • bytes.max_len: 10485760
languageCode
  • string.max_len: 12
fileName
  • string.max_len: 128

SpeechToTextResponse

@description 语音转文字响应

FieldTypeLabelDescription
text string

识别到的文字

SuccessResponse

@description 成功响应

FieldTypeLabelDescription
code int32

状态码

msg string

状态信息

TextLocation

@description 文本位置坐标属性

FieldTypeLabelDescription
x float

x坐标

y float

y坐标

TextToSpeechRequest

@description 文字转语音请求

FieldTypeLabelDescription
text string

待识别的文字

languageCode string

语音语言

Validated Fields

Field Validations
text
  • string.min_len: 1
  • string.max_len: 5000
languageCode
  • string.max_len: 12

TextToSpeechResponse

@description 文字转语音响应

FieldTypeLabelDescription
audioData string

语音数据，语音的直接二进制数据

TranslationRequest

@description 翻译请求

FieldTypeLabelDescription
text string repeated

待翻译的文字

languageCode string

目标语言

Validated Fields

Field Validations
text
  • repeated.max_items: 5000
  • repeated.items.string.min_len: 1
  • repeated.items.string.max_len: 5000
languageCode
  • string.max_len: 12

TranslationResponse

@description 翻译响应

FieldTypeLabelDescription
texts string repeated

翻译后的文字

UrlInfo

@description 文件url信息

FieldTypeLabelDescription
url string

下载地址

Validated Fields

Field Validations
url
  • string.uri: true

Vertice

@description 物体顶点位置百分比

FieldTypeLabelDescription
x double

x坐标百分比

y double

y坐标百分比

Base

Method NameRequest TypeResponse TypeDescription
GetSmsCodeDomestic .SmsRequest .SuccessResponse

@Summary 发送短信验证码 @Description /base/getSmsCodeDomestic
EmailVerifyCode .EmailRequest .SuccessResponse

@Summary 发送邮箱验证码 @Description /base/emailVerifyCode
GetVerifyCodeImage .EmptyRequest .CaptchaResponse

@Summary 获取验证码图片 @Description /base/getVerifyCodeImage
UploadFile .FileUploadRequest .FileUploadResponse

@Summary 上传单个文件 @Description /base/uploadFile
GetLocationByAddress .AddressLocationRequest .Location

@Summary 获取城市经纬度 @Description /base/getLocationByAddress
GetAddressByLocation .Location .AddressResponse

@Summary 获取城市信息 @Description /base/getAddressByLocation
ImageRecognition .ImageRecognitionRequest .ImageRecognitionResponse

@Summary 图片文字识别 @Description /base/imageRecognition
AiQuestion .AiQuestionRequest .AiQuestionResponse

@Summary AI问答 @Description /base/aiQuestion
SpeechToText .SpeechToTextRequest .SpeechToTextResponse

@Summary 语音转文字 @Description /base/speechToText
TextToSpeech .TextToSpeechRequest .TextToSpeechResponse

@Summary 文字转语音 @Description /base/textToSpeech
DetectLanguage .DetectLanguageRequest .DetectLanguageResponse

@Summary 文本语种检测 @Description /base/detectLanguage
ImageObjectDetection .ImageObjectDetectionRequest .ImageObjectDetectionResponse

@Summary 图片物体检测 @Description /base/imageObjectDetection
CustomScan .CustomScanRequest .CustomScanResponse

@Summary 自定义扫码识别 @Description /base/customScan
Translate .TranslationRequest .TranslationResponse

@Summary 翻译 @Description /base/translate
HandwritingRecognize .HandwritingRecognitionRequest .HandwritingRecognitionResponse

@Summary 手写文字识别 @Description /base/handwritingRecognize

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)