博舍

ocr文字识别接口 ocr识别api

ocr文字识别接口

视频教程

1.请求URI

请求URI由如下部分组成:{URI-scheme}://{endpoint}/{resource-path}?{query-string}

URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。

endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的endpoint不同,您可以从终端节点章节查看。例如OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。

resource-path:资源路径,也即API访问路径。从具体OCR识别API的URI章节获取,例如OCR接口的网络图片识别API的“resource-path”为“v2/{project_id}/ocr/web-image”。

query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。

2.请求方法

HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。

GET:请求服务器返回指定资源。

PUT:请求服务器更新指定资源。

POST:请求服务器新增资源或执行特殊操作。

DELETE:请求服务器删除指定资源,如删除对象等。

HEAD:请求服务器资源头部。

PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。

例如,OCR接口的网络图片识别URI部分,您可以看到其请求方法为“POST”,则其请求为:

POSThttps://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image

3.请求消息头

附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。

Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。

X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token请参考认证鉴权。

添加消息头后的请求如下所示。

POSThttps://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image

Content-Type:application/json

x-auth-token:MIIaBgYJKoZIhvcNAQcC…

4.请求消息体

请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。

例如,对于OCR接口中的网络图片识别接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。

POSThttps://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image

RequestHeader:

Content-Type:application/json

X-Auth-Token:MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

RequestBody:

{

"image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAA..."

}

到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

视频教程

1.请求URI

请求URI由如下部分组成:{URI-scheme}://{endpoint}/{resource-path}?{query-string}

URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。

endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的endpoint不同,您可以从终端节点章节查看。例如OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。

resource-path:资源路径,也即API访问路径。从具体OCR识别API的URI章节获取,例如OCR接口的网络图片识别API的“resource-path”为“v2/{project_id}/ocr/web-image”。

query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。

2.请求方法

HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。

GET:请求服务器返回指定资源。

PUT:请求服务器更新指定资源。

POST:请求服务器新增资源或执行特殊操作。

DELETE:请求服务器删除指定资源,如删除对象等。

HEAD:请求服务器资源头部。

PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。

例如,OCR接口的网络图片识别URI部分,您可以看到其请求方法为“POST”,则其请求为:

POSThttps://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image

3.请求消息头

附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。

Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。

X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token请参考认证鉴权。

添加消息头后的请求如下所示。

POSThttps://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image

Content-Type:application/json

x-auth-token:MIIaBgYJKoZIhvcNAQcC…

4.请求消息体

请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。

例如,对于OCR接口中的网络图片识别接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。

POSThttps://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/web-image

RequestHeader:

Content-Type:application/json

X-Auth-Token:MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

RequestBody:

{

"image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAA..."

}

到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,一经查实,本站将立刻删除。

上一篇

下一篇