Search API

This API helps you search inside your conversation for key moments and concepts.

Overview

Marsview's Search API is powered by Marsview's proprietary Knowledge Web architecture which helps in extracting information from both visual and audio components.

Knowledge Web representation

Model dependency: Speech to text, OCR, Topics

Optional dependency: Screen Activity, Emotion, Sentiment, Tone, Speaker Separation

https://api.marsview.ai/v1/conversation/search/invideo
This route can be used to search through the audio transcript and the OCR from frames once the metadata for these is available. Searching on a particular fileId will return search results with status flags for speech_to_text and OCR indicating if they are indexed.
Request
Response
Request
Headers
appSecret
required
string
<sample-app-secret>
appId
required
string
<sample-app-Id>
Content-Type
optional
string
application/json
Body Parameters
numResults
optional
string
The Number of results to be shown per page. (Defaults to 25)
nextPageToken
optional
string
Token to access the next page of search results, leave it blank when accessing the first page
query
required
string
Query string to search inside the audio/video file.
fileID
required
string
File ID of the file on which search has to be performed
userId
required
string
userID of the account (email ID used to login to the account)
Response
200: OK
The JSON response status object and the results object. The status object is used to indicate if the metadata is generated. This has to be validated first by the end-user before accessing the results object for reliable search results
{
"query":"jQuery",
"status":{
"speech_to_text":true,
"ocr":true
}
"results":{
"speech_to_text":[
...
{
"start_time":12345.00,
"end_time":123346.00,
"transcript":"As I needed to extend jQuery validate to add this new national insurance number regex I am also including this as it may be useful for someone"
}
...
],
"ocr":[
...
{
"frame_id":1532,
"frame_offset":12929.00,
"OCR": ["JQuery" , "JS Summit" "2020"]
}
...
]
}
}

Response Object Fields

Fields

Description

start_time

Starting time of the chunk in milliseconds

end_time

Ending time of the chunk in milliseconds

transcript

The transcribed sentence from Marsview STT

frame_id

Frame ID offset from the starting of the video

frame_offset

Offset time in milliseconds from the starting of the video

ocr

List of OCR tags found in that particular frame

https://api.marsview.ai/v1/conversation/search/library
This route can be used to search through the audio transcript and the OCR from frames once the metadata for these are available. Searching on a particular userId will return search results with file_id
Request
Response
Request
Headers
appSecret
required
string
<sample-app-secret>
appId
required
string
<sample-app-Id>
Content-Type
optional
string
application/json
Body Parameters
numResults
optional
string
The Number of results to be shown per page. (Defaults to 25)
nextPageToken
optional
string
Token to access the next page of search results, leave it blank when accessing the first page
query
required
string
Query string to search inside the audio/video file.
userId
required
string
userID of the account (email ID used to login to the account)
Response
200: OK
The JSON response contains the results object with a list of files in that user_id that match the query.
"query":"jQuery",
"results":{
"speech_to_text":[
...
"file_id":"2744b249-233d-4cd2-b9ca-5fb61b20c646",
"file_id":"a6708572-f272-45a9-ba5e-22eaa418c693"
...
],
"ocr":[
...
"file_id":"2744b249-233d-4cd2-b9ca-5fb61b20c646",
"file_id":"a6708572-f272-45a9-ba5e-22eaa418c693"
...
]
}
}

Response Object Fields

Fields

Description

file_id

File ID of the video that matches with the query string.

‚Äč