文档中心对象存储SDK 文档PHP SDK任务接口分词任务接口

分词任务接口

最近更新时间：2023-11-23 19:42:40

本页目录：

简介
本文档提供关于分词任务接口的 API 概览和 SDK 示例代码。
API
操作描述
﻿提交分词任务﻿
提交分词任务
﻿查询任务结果﻿
查询指定的任务
提交音视频流分离任务
功能说明
提交一个分词任务。
方法原型
public Guzzle\\Service\\Resource\\Model createAiWordsGeneralizeJobs(array $args = array());
请求示例
<?php
﻿
require dirname(__FILE__, 2) . '/vendor/autoload.php';
﻿
$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
    array(
        'region' => $region,
        'scheme' => 'https', //协议头部，默认为 http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));
try {
    // 提交一个分词任务 https://cloud.tencent.com/document/product/460/84800
    $result = $cosClient->createAiWordsGeneralizeJobs(array(
        'Bucket' => 'examplebucket-125000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Tag' => 'WordsGeneralize',
        'Input' => array(
            'Object' => 'test.txt',
        ),
        'Operation' => array(
//            'UserData' => '',
//            'JobLevel' => '',
            'WordsGeneralize' => array(
                'NerMethod' => 'DL',
                'SegMethod' => 'MIX',
            ),
        ),
//        'CallBack' => '',
//        'CallBackFormat' => '',
//        'CallBackType' => '',
//        'CallBackMqConfig' => array(
//            'MqRegion' => '',
//            'MqMode' => '',
//            'MqName' => '',
//        ),
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}
参数说明
Request 中的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Tag
Request
创建任务的 Tag：WordsGeneralize
String
是
Input
Request
待操作的对象信息
Container
是
Operation
Request
操作规则
Container
是
CallBackFormat
Request
任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式
String
否
CallBackType
Request
任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型
String
否
CallBack
Request
任务回调地址，优先级高于队列的回调地址。设置为 no 时，表示队列的回调地址不产生回调
String
否
CallBackMqConfig
Request
任务回调 TDMQ 配置，当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig﻿
Container
否
Container 类型 Input 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Object
Request.Input
文件路径
String
是
Container 类型 Operation
 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
WordsGeneralize
Request.Operation
指定分词参数
Container
是
UserData
Request.Operation
透传用户信息，可打印的 ASCII 码，长度不超过1024
String
否
JobLevel
Request.Operation
任务优先级，级别限制：0 、1 、2。级别越大任务优先级越高，默认为0
String
否
Container 类型 WordsGeneralize 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
NerMethod
Request.Operation.WordsGeneralize
ner 方式，支持 NerBasic 和 DL，默认值 DL
String
否
SegMethod
Request.Operation.WordsGeneralize
分词粒度，支持 SegBasic 和 MIX，默认值 MIX
String
否
返回结果示例
GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjRjYNjRjMjIxODBfMzUxNGSIOJOIDAJOIDg=
    [ContentType] => application/xml
    [ContentLength] => 746
    [JobsDetail] => Array
        (
            [Code] => Success
            [Message] => 
            [JobId] => ae87e8pc7a00f19asf798sd7f89s7f2e646
            [Tag] => WordsGeneralize
            [State] => Submitted
            [CreationTime] => 2023-08-03T17:19:54+0800
            [StartTime] => -
            [EndTime] => -
            [QueueId] => p78f10pc7a00f19asf798sd7f89s7f2e646
            [QueueType] => AIProcess
            [Input] => Array
                (
                    [BucketId] => examplebucket-1250000000
                    [Region] => ap-guangzhou
                    [Object] => test.txt
                )
﻿
            [Operation] => Array
                (
                    [UserData] => xxx
                    [JobLevel] => 0
                    [WordsGeneralize] => Array
                        (
                            [NerMethod] => DL
                            [SegMethod] => MIX
                        )
﻿
                )
﻿
        )
﻿
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/jobs
)
查询任务结果
功能说明
查询指定的任务。
方法原型
public Guzzle\\Service\\Resource\\Model describeMediaJob(array $args = array());
请求示例
<?php
﻿
require dirname(__FILE__) . '/../vendor/autoload.php';
﻿
$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
    array(
        'region' => $region,
        'scheme' => 'https', //协议头部，默认为 http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));
try {
    // 查询指定的任务
    $result = $cosClient->describeMediaJob(array(
        'Bucket' => 'examplebucket-125000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key' => '', // jobId
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}
参数说明
Request 中的具体数据描述如下：
参数名称
类型
描述
是否必填
Bucket
String
存储桶名称，格式：BucketName-APPID
是
Key
String
需要查询的任务 ID
是
返回结果示例
GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjRkMNjRjMjIxODBfMzUxNGSIOJOIDAJOIDg=
    [ContentType] => application/xml
    [ContentLength] => 1836
    [Key] => j7380pc7a00f19asf798sd7f89s7f2e646
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/jobs/j7380pc7a00f19asf798sd7f89s7f2e646
    [Response] => Array
        (
            [JobsDetail] => Array
                (
                    [Code] => Success
                    [CreationTime] => 2023-08-07T16:07:28+0800
                    [EndTime] => 2023-08-07T16:07:29+0800
                    [Input] => Array
                        (
                            [BucketId] => examplebucket-1250000000
                            [Object] => object
                            [Region] => ap-guangzhou
                        )
﻿
                    [JobId] => j7380pc7a00f19asf798sd7f89s7f2e646
                    [Message] => 
                    [Operation] => Array
                        (
                            [JobLevel] => 0
                            [Output] => Array
                                (
                                    [Bucket] => examplebucket-1250000000
                                    [Object] => tmp/out_object
                                    [Region] => ap-guangzhou
                                )
﻿
                            [TemplateId] => t0pc7a00f19asf798sd7f89s7f2e646
                            [TemplateName] => TemplateName
                        )
﻿
                    [QueueId] => pc6f4d28f798sd7f89s7f2e646bffb5a
                    [QueueType] => QueueType
                    [StartTime] => 2023-08-07T16:07:28+0800
                    [State] => Success
                    [Tag] => Tag
                )
        )
)
﻿

上一篇: 翻译任务接口下一篇: 删除工作流

文档反馈

文档活动

目录