Starts an asynchronous job to analyze sentiments in a transcript.
The transcript can be supplied through text
as plain text or json
as a rev.com transcript format
Sentiment Analysis Job Options
Sentiment Analysis Job Details
Bad Request
Request Unauthorized
Payload Too Large
{- "language": "en",
- "metadata": "sample user provided metadata",
- "notification_config": {
- "auth_headers": {
- "Authorization": "Bearer <notification-url-token>"
}
}, - "delete_after_seconds": 1000000,
- "json": {
- "monologues": [
- {
- "speaker": 1,
- "elements": [
- {
- "type": "text",
- "value": "hello",
- "ts": 0.75,
- "end_ts": 1.25,
- "confidence": 0.85
}
]
}
]
}
}
{- "id": "Umx5c6F7pH7r",
- "status": "in_progress",
- "language": "en",
- "created_on": "2018-05-05T23:23:22.29Z",
- "type": "sentiment_analysis"
}
Gets a list of sentiment analysis jobs submitted within the last 30 days in reverse chronological order up to the provided limit
number of jobs per call. Note: Jobs older than 30 days will not be listed. Pagination is supported via passing the last job id
from a previous call into starting_after
.
List of Rev AI Sentiment Analysis Jobs
Bad Request
Request Unauthorized
curl -i -X GET \ 'https://api.rev.ai/sentiment_analysis/v1/jobs?limit=100&starting_after=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
[- {
- "id": "Umx5c6F7pH7r",
- "status": "in_progress",
- "language": "en",
- "created_on": "2018-05-05T23:23:22.29Z",
- "type": "sentiment_analysis"
}, - {
- "id": "6BxQYGa638Yt",
- "status": "completed",
- "language": "en",
- "created_on": "2018-05-05T23:23:22.29Z",
- "completed_on": "2018-05-05T23:45:13.41Z",
- "word_count": 4231,
- "type": "sentiment_analysis"
}
]
Returns information about a sentiment analysis job
Sentiment Analysis Job Details
Request Unauthorized
Job Not Found
curl -i -X GET \ 'https://api.rev.ai/sentiment_analysis/v1/jobs/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "id": "Umx5c6F7pH7r",
- "status": "in_progress",
- "language": "en",
- "created_on": "2018-05-05T23:23:22.29Z",
- "type": "sentiment_analysis"
}
Deletes a sentiment analysis job. All data related to the job will be permanently deleted. A job can only be deleted once it's completed (either with success or failure).
Job was successfully deleted
Request Unauthorized
Job Not Found
Conflict
curl -i -X DELETE \ 'https://api.rev.ai/sentiment_analysis/v1/jobs/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "title": "Authorization has been denied for this request",
- "status": 401
}
Returns the results for a completed sentiment analysis job.
Rev AI API Sentiment Analysis Result
Request Unauthorized
Job Not Found
Conflict
curl -i -X GET \ 'https://api.rev.ai/sentiment_analysis/v1/jobs/{id}/result?filter_for=positive' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "messages": [
- {
- "content": "This is wonderful, I could not be more pleased.",
- "score": 0.9,
- "sentiment": "positive",
- "ts": 1,
- "end_ts": 4.6
}, - {
- "content": "I'm very disappointed.",
- "score": -0.81,
- "sentiment": "negative",
- "ts": 10,
- "end_ts": 12.2
}, - {
- "content": "That car is red.",
- "score": 0.1,
- "sentiment": "neutral",
- "ts": 15,
- "end_ts": 16.6
}
]
}