文字识别 OCR-.NET SDK:开始使用

时间:2024-06-13 19:17:47

开始使用

  1. 导入依赖模块
    using System;
    using System.Collections.Generic;
    using HuaweiCloud.SDK.Core;
    using HuaweiCloud.SDK.Core.Auth;
    using HuaweiCloud.SDK.Ocr;
    using HuaweiCloud.SDK.Ocr.V1;
    using HuaweiCloud.SDK.Ocr.V1.Model;
  2. 配置客户端连接参数
    • 默认配置
      // 使用默认配置
      var config = HttpConfig.GetDefaultConfig();
    • 网络代理(可选)
      // 根据需要配置网络代理
      config.ProxyHost = "proxy.huaweicloud.com";
      config.ProxyPort = 8080;
      config.ProxyUsername = "test";
      config.ProxyPassword = "test";
    • 超时配置(可选)
      // 默认超时时间为120秒,可根据需要调整
      config.Timeout = 120;
    • SSL配置(可选)
      // 根据需要配置是否跳过SSL证书验证
      config.IgnoreSslVerification = true;
  3. 配置认证信息

    配置AK、SK信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见准备工作

    const string ak = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_AK");
    const string sk = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_SK");
    var auth = new BasicCredentials(ak, sk);
    • 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
    • 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
  4. 初始化客户端(二选一)
    • 指定云服务region方式(推荐)
      // 初始化指定云服务的客户端 {Service}Client ,以初始化OCR服务的 OcrClient 为例
      var client = OcrClient.NewBuilder()
          .WithCredential(auth)
          .WithRegion(OcrRegion.ValueOf("cn-north-4"))
          .WithHttpConfig(config)
          .Build();
    • 指定云服务endpoint方式
      // 指定终端节点,以OCR服务北京四的 endpoint 为例
      String endpoint = "https://ocr.cn-north-4.myhuaweicloud.com";
      // 初始化客户端认证信息,需要填写相应 projectId,以初始化 BasicCredentials 为例
      var auth = new BasicCredentials(ak, sk, projectId);
      
      // 初始化指定云服务的客户端 {Service}Client,以初始化OCR服务的 OcrClient 为例
      var client = OcrClient.NewBuilder()
          .WithCredential(auth)
          .WithEndPoint(endpoint)
          .WithHttpConfig(config)
          .Build();

      endpoint是华为云各服务应用区域和各服务的终端节点,详情请查看 地区和终端节点

  5. 发送请求并查看响应
    // 以调用通用 表格识别 接口 RecognizeGeneralTable 为例
    var req = new RecognizeGeneralTableRequest
    {
    };
    req.Body = new GeneralTableRequestBody()
    {
        Url = "图片的url"
    };
    try
    {
        var resp = client.RecognizeGeneralTable(req);
        var respStatusCode = resp.HttpStatusCode;
        Console.WriteLine(respStatusCode);
    }
  6. 异常处理
    表1 异常处理

    一级分类

    一级分类说明

    二级分类

    二级分类说明

    ConnectionException

    连接类异常

    HostUnreachableException

    网络不可达、被拒绝。

    SslHandShakeException

    SSL认证异常。

    RequestTimeoutException

    响应超时异常

    CallTimeoutException

    单次请求,服务器处理超时未返回。

    RetryOutageException

    在重试策略消耗完成后,仍无有效的响应。

    ServiceResponseException

    服务器响应异常

    ServerResponseException

    服务端内部错误,Http响应码:[500,]。

    ClientRequestException

    请求参数不合法,Http响应码:[400, 500)

    try
    {
       var resp = client.RecognizeGeneralTable(req);
       var respStatusCode = resp.HttpStatusCode;
       Console.WriteLine(respStatusCode);
    }
    catch (RequestTimeoutException requestTimeoutException)
    {
        Console.WriteLine(requestTimeoutException.ErrorMessage);
     }
        catch (ServiceResponseException clientRequestException)
    {
        Console.WriteLine(clientRequestException.HttpStatusCode);
        Console.WriteLine(clientRequestException.ErrorCode);
        Console.WriteLine(clientRequestException.ErrorMsg);
    }
        catch (ConnectionException connectionException)
    {
        Console.WriteLine(connectionException.ErrorMessage);
    }
support.huaweicloud.com/sdkreference-ocr/ocr_04_0012.html