Skip to content
Qualia Docs

Episodes_ReviewSuggestions

POST
/v1/accounts/{account}/datasets/{dataset}/episodes:reviewSuggestions
 
curl --request POST \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/datasets/example/episodes:reviewSuggestions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "parent": "example", "selection": { "names": { "names": [ "example" ] }, "filter": "example" }, "origin": "ORIGIN_UNSPECIFIED", "review": "REVIEW_UNSPECIFIED", "requestId": "example" }'

Settles every PROPOSED subtask span of one origin over the episodes a filter leaves: accept or reject in one call (QUA-1794).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

dataset
required
string

The dataset id.

Request Body required

Section titled “Request Body required ”
Media type application/json

Request for Episodes.ReviewSuggestions.

object
parent
required

Accounts/{account}/datasets/{dataset}

string
selection
required

Which episodes.

object
names

Episode names under the request’s parent.

object
names

Accounts/{account}/datasets/{dataset}/episodes/{episode}, at most 10000.

Array<string>
filter

A ListEpisodes filter over the parent (e.g. what the filter bar leaves).

string
origin

Only spans of this origin (MODEL or HEURISTIC); unset means both.

string format: enum
Allowed values: ORIGIN_UNSPECIFIED HUMAN MODEL HEURISTIC
review
required

ACCEPTED or REJECTED.

string format: enum
Allowed values: REVIEW_UNSPECIFIED PROPOSED ACCEPTED REJECTED
requestId

Optional UUID4 identifying this logical edit. Reusing it with the same caller and request returns the original result; different input conflicts. When absent, each call starts a new logical edit.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Episodes.ReviewSuggestions.

object
episodeCount

Episodes that had a span settled.

integer format: int32
spanCount

Spans settled.

integer format: int32
Example generated
{
  "episodeCount": 1,
  "spanCount": 1
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}