C# SDK文档

简介

Hi，您好，欢迎使用百度文字识别服务。

本文档主要针对C#开发者，描述百度文字识别接口服务的相关技术内容。如果您对文档内容有任何疑问，可以通过以下几种方式联系我们：

• 在百度云控制台内提交工单，咨询问题类型请选择人工智能服务；
• 如有疑问，进入AI社区交流：http://ai.baidu.com/forum/topic/list/164

接口能力

版本更新记录

快速入门

安装文字识别 C# SDK

C# SDK 现已开源! https://github.com/Baidu-AIP/dotnet-sdk

** 支持平台：.Net Framework 3.5 4.0 4.5， .Net Core 2.0 **

方法一：使用Nuget管理依赖 （推荐）

在NuGet中搜索 Baidu.AI，安装最新版即可。

packet地址 https://www.nuget.org/packages/Baidu.AI/

方法二：下载安装

文字识别 C# SDK目录结构

Baidu.Aip
    ├── net35
    │   ├── AipSdk.dll             // 百度AI服务 windows 动态库
    │   ├── AipSdk.xml             // 注释文件
    │   └── Newtonsoft.Json.dll    // 第三方依赖
    ├── net40
    ├── net45
    └── netstandard2.0
        ├── AipSdk.deps.json
        └── AipSdk.dll

如果需要在 Unity 平台使用，可引用工程源码自行编译。

安装

1.在官方网站下载C# SDK压缩工具包。

2.解压后，将 AipSdk.dll 和 Newtonsoft.Json.dll 中添加为引用。

新建交互类

Baidu.Aip.Ocr.Ocr是文字识别的交互类，为使用文字识别的开发人员提供了一系列的交互方法。

用户可以参考如下代码新建一个交互类：

// 设置APPID/AK/SK
var APP_ID = "你的 App ID";
var API_KEY = "你的 Api Key";
var SECRET_KEY = "你的 Secret Key";

var client = new Baidu.Aip.Ocr.Ocr(API_KEY, SECRET_KEY);
client.Timeout = 60000;  // 修改超时时间

在上面代码中，常量APP_ID在百度云控制台中创建，常量API_KEY与SECRET_KEY是在创建完毕应用后，系统分配给用户的，均为字符串，用于标识用户，为访问做签名验证，可在AI服务控制台中的应用列表中查看。

注意：如您以前是百度云的老用户，其中API_KEY对应百度云的“Access Key ID”，SECRET_KEY对应百度云的“Access Key Secret”。

接口说明

通用文字识别

用户向服务请求识别某张图中的所有文字

public void GeneralBasicDemo() {
	var image = File.ReadAllBytes("图片文件路径");
	// 调用通用文字识别, 图片参数为本地图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.GeneralBasic(image);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"language_type", "CHN_ENG"},
	    {"detect_direction", "true"},
	    {"detect_language", "true"},
	    {"probability", "true"}
	};
	// 带参数调用通用文字识别, 图片参数为本地图片
	result = client.GeneralBasic(image, options);
	Console.WriteLine(result);
}
public void GeneralBasicUrlDemo() {
	var url = "https//www.x.com/sample.jpg";
	
	// 调用通用文字识别, 图片参数为远程url图片，可能会抛出网络等异常，请使用try/catch捕获
	var result = client.GeneralBasicUrl(url);
	Console.WriteLine(result);
	// 如果有可选参数
	var options = new Dictionary<string, object>{
	    {"language_type", "CHN_ENG"},
	    {"detect_direction", "true"},
	    {"detect_language", "true"},
	    {"probability", "true"}
	};
	// 带参数调用通用文字识别, 图片参数为远程url图片
	result = client.GeneralBasicUrl(url, options);
	Console.WriteLine(result);
}

通用文字识别 请求参数详情

通用文字识别 返回数据参数详情

通用文字识别 返回示例

{
"log_id": 2471272194,
"words_result_num": 2,
"words_result":
    [
        {"words": " TSINGTAO"},
        {"words": "青島睥酒"}
    ]
}