POST
/
api
/
v1
/
session_labels
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.session_labels.create(request={
        "session_id": 1,
        "type": "auto-rating",
        "code": "BAD",
        "user_email": "user@email.com",
        "issue_categories": [
            "Silent treatment",
        ],
    })

    # Handle response
    print(res)
{
  "session_id": 1,
  "type": "auto-rating",
  "code": "GOOD",
  "user_email": "user@email.com",
  "comments": "<string>",
  "issue_categories": [
    "Silent treatment"
  ],
  "id": 1,
  "timestamp": "2024-01-01T12:00:00Z"
}

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json
​
session_id
integer
required

The internal ID of the session (see Session.session_id)

Example:

1

​
type
string
required

The type of the label (either "auto-rating" or "human-rating")

Example:

"auto-rating"

​
code
string
required

A code describing the quality of the labeled session (either "GOOD", "OK", "BAD", or "N/A")

Example:

"GOOD"

​
user_email
string
required

The email of the user who created the label

Example:

"user@email.com"

​
comments
string | null

Comment string describing additional details about the session

​
issue_categories
string[] | null

Descriptions of issues occurring in the labeled call

Example:
["Silent treatment"]

Response

200
application/json
Successful Response

Response model for session label operations. A session label is associated with a given session and contains an evaluation of quality and descriptions of issues the user encountered in that session or other details.

​
session_id
integer
required

The internal ID of the session (see Session.session_id)

Example:

1

​
type
string
required

The type of the label (either "auto-rating" or "human-rating")

Example:

"auto-rating"

​
code
string
required

A code describing the quality of the labeled session (either "GOOD", "OK", "BAD", or "N/A")

Example:

"GOOD"

​
user_email
string
required

The email of the user who created the label

Example:

"user@email.com"

​
id
integer
required

The internal ID of the label

Example:

1

​
timestamp
string
required

The timestamp at which the label was created

Example:

"2024-01-01T12:00:00Z"

​
comments
string | null

Comment string describing additional details about the session

​
issue_categories
string[] | null

Descriptions of issues occurring in the labeled call

Example:
["Silent treatment"]