POST
/
tools
/
mentions
/
Explainability Model
curl --request POST \
  --url https://api.{environment}.corti.app/v2/tools/mentions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-Name: <tenant-name>' \
  --data '{
  "query": "<string>",
  "referenceTexts": [
    "<string>"
  ]
}'
{
  "properties": "<string>",
  "range": [
    123
  ],
  "time": [
    123
  ],
  "snippet": "<string>",
  "documentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "utteranceId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Input your token

Headers

​
Tenant-Name
string
required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:

"copiloteu"

Body

application/json
​
query
string
required

The text-based query from the user.

​
referenceTexts
string[]
required

An array of reference texts where the mentions will be searched.

Response

Returns an array of mentions found in the reference texts.

​
properties
string

The type of mention (e.g., transcript, document).

​
range
integer[]

Character range for document type.

​
time
integer[]

Time range in seconds for transcript type.

​
snippet
string

Text snippet for the mention.

​
documentId
string<uuid>

The document ID if applicable.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
utteranceId
string<uuid>

The utterance ID if applicable.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
timestamp
string<date-time>

The timestamp for transcript mentions.