Skip to main content

CreateQualityCheckTask

Creates a quality check task.

Operation description

Before using this API, review the pricing and billing methods for the Tongyi Dianjin product. Prerequisites Activate Alibaba Cloud Model Studio and Tongyi Dianjin services. Obtain the workspaceId: Retrieve the workspace identity.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:
  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
  • API: The API that you can call to perform the action.
  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dianjin:CreateQualityCheckTask

create

*All Resource

*

NoneNone

Request syntax

POST /{workspaceId}/api/qualitycheck/task/submit HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

workspaceId

string

Yes

The workspace ID.

llm-xxxx

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

conversationList

object

Yes

The conversation content. If associated with a quality check scenario, pass multiple conversations. Otherwise, pass only one.

callType

string

No

Call type:

Valid values:

  • 1 :

    Inbound

  • 2 :

    Outbound

1

customerId

string

No

The Customer ID.

1

customerName

string

No

The customer name.

张三

customerServiceId

string

No

The customer service ID.

xxx

customerServiceName

string

No

The customer service name.

李四

dialogueList

array<object>

Yes

The list of dialogue details.

object

No

The dialogue details.

begin

integer

No

The start time of this sentence. This is the offset time in milliseconds from the start of the conversation.

0

beginTime

string

No

The start time of this sentence.

2024-05-23 14:57:50

content

string

Yes

The specific content of the dialogue.

您好,我是2001,很高兴为您服务!

customerId

string

No

The unique identifier of the dialogue role.

2348234

customerServiceId

string

No

The customer service ID.

23874627346

customerServiceType

string

No

Agent type:

Valid values:

  • 0 :

    Robot

  • 1 :

    Human

0

end

integer

No

The end time of this sentence. This is the offset time in milliseconds from the start of the conversation.

0

role

string

Yes

Role:

Valid values:

  • 0 :

    Customer

  • 1 :

    Agent

1

type

string

Yes

Dialogue content type:

Valid values:

  • IMAGE :

    Image

  • TEXT :

    Text

  • AUDIO :

    Audio

TEXT

gmtService

string

No

The conversation time.

2024-09-27 11:23:20

gmtService

string

Yes

The business occurrence time. The system uses this to record submission time, make task scheduling priority decisions, and so on.

2024-09-27 11:23:20

metaData

object

No

The metadata. These are properties related to business that rules consume during execution. The business system passes these in real-time when initiating a quality check.

string

No

The metadata.

{ "isSpecialArchive": false, "hasProcessingWorkOrder": false, "primaryArchiveType": "其他", "businessType": "预警", "workOrderActionType":"业务升级" }

qualityGroup

array

No

The quality check rule group.

string

No

The quality check rule.

warning_customers

requestId

string

Yes

The request ID.

0FC6636E-380A-5369-AE01-D1C15BB9B254

type

string

Yes

Quality check type:

Valid values:

  • 0 :

    Offline text conversation quality check

0

sceneCode

string

No

The scenario code.

o9c8u8

Response elements

Element

Type

Description

Example

object

ResultCode

cost

integer

The time consumed.

null

data

object

The response data.

taskId

string

The taskId.

172373500521

dataType

string

The data type.

null

errCode

string

The error code.

0

message

string

The error message.

ok

requestId

string

The request ID.

EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258

success

boolean

Indicates whether the operation succeeded.

true

time

string

The timestamp.

2024-04-24 11:54:34

Examples

Success response JSON format
{
  "cost": 0,
  "data": {
    "taskId": "172373500521"
  },
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.
Token Plan
Model Playground
Fine-tuning
Model Compression
Statistics and Monitoring
Support