ListSearchTaskDialogues

Updated at:

Retrieves the task details for MiaoSou search generation tasks.

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

aimiaobi:ListSearchTaskDialogues

list

*All Resource

*

NoneNone

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

WorkspaceId

string

Yes

The unique ID of the Model Studio workspace. For more information, see Obtain a workspace ID.

xxxx

PageSize

integer

No

The number of results to return.

10

TaskId

string

No

The unique ID of the task.

You do not need to specify this parameter. The system generates it automatically. If you specify the same TaskId for multiple tasks, they are grouped into the same conversation.

xxxx

PageNumber

integer

No

The number of the page to return.

1

Response elements

Element

Type

Description

Example

object

The response.

Data

array<object>

The data returned.

array<object>

The data returned.

SessionId

string

The unique ID of a single-turn conversation.

xxxx

OriginSessionId

string

The original session ID.

xxxx

TaskId

string

The unique ID of the task.

xxxx

Rating

string

The rating of the content, which can be Like or Dislike.

thumbsUp

Tags

array

The tags.

string

The tag.

xx

Text

string

The customer feedback.

xxx

GoodText

string

The generated content that the customer rated as good.

xxx

Prompt

string

The input prompt.

xxx

CreateTime

string

The time when the task was created.

2024-11-25 13:33:01

DialogueType

integer

The type of generation.

24

ResponseBodyStr

string

The response body as a string.

{}

ChatConfig

object

The configuration.

GenerateTechnology

string

The type of content generation.

copilotReference

SearchParam

object

SearchSources

array<object>

The search sources.

object

The search source.

Code

string

The type.

x'x

Name

string

The description.

x

DatasetName

string

The unique ID.

xx

EndTime

string

StartTime

string

MultimodalSearchTypes

array

string

DialogueType

integer

The request type.

24

GenerateLevel

string

The generation level.

concise

EndToEnd

boolean

Indicates whether the process is end-to-end.

SearchModels

array

The search type.

string

The search type.

TextGenerate

PageNumber

integer

The number of the page returned.

1

PageSize

integer

The number of entries returned per page.

10

TotalCount

integer

The total number of entries.

100

RequestId

string

The unique ID of the request.

1813ceee-7fe5-41b4-87e5-982a4d18cca5

Success

boolean

Indicates whether the request was successful. `true` indicates success. `false` indicates failure.

true

Code

string

The status code.

NoData

Message

string

The error message.

success

HttpStatusCode

integer

The HTTP status code.

200

Examples

Success response

JSON format

{
  "Data": [
    {
      "SessionId": "xxxx",
      "OriginSessionId": "xxxx",
      "TaskId": "xxxx",
      "Rating": "thumbsUp",
      "Tags": [
        "xx"
      ],
      "Text": "xxx",
      "GoodText": "xxx",
      "Prompt": "xxx",
      "CreateTime": "2024-11-25 13:33:01",
      "DialogueType": 24,
      "ResponseBodyStr": "{}",
      "ChatConfig": {
        "GenerateTechnology": "copilotReference",
        "SearchParam": {
          "SearchSources": [
            {
              "Code": "x'x",
              "Name": "x",
              "DatasetName": "xx"
            }
          ],
          "EndTime": "",
          "StartTime": "",
          "MultimodalSearchTypes": [
            ""
          ]
        },
        "DialogueType": 24,
        "GenerateLevel": "concise",
        "EndToEnd": false,
        "SearchModels": [
          "TextGenerate"
        ]
      }
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "Code": "NoData",
  "Message": "success",
  "HttpStatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.