{"products":[{"product":"Comprehend","productId":"A26","version":"1.1.0","resultLevel":"Speaker","resultSetSummary":[{"paragraph":["104 number values for each noted speaker in the analyzed file, representing 26 unique audio features.","Range: unbounded (different value ranges for each audio feature) ","Includes:"]},{"list":["Mean of features 1 - 26 during prepared remarks","Mean of features 1 - 26 during Q&A","SD of features 1 - 26 during prepared remarks","SD of features 1 - 26 during Q&A"]}],"resultStructure":[{"list":["features","person_id","name"]}]},{"product":"Comprehend ATST","productId":"A26_ATST","version":"1.1.0","resultLevel":"Statement","resultSetSummary":[{"paragraph":["104 number values for each statement in the analyzed file, representing 26 unique audio features.","Range: unbounded (different value ranges for each audio feature)","Includes:"]},{"list":["Mean of features 1 - 26 during prepared remarks","Mean of features 1 - 26 during Q&A","SD of features 1 - 26 during prepared remarks","SD of features 1 - 26 during Q&A"]}],"resultStructure":[{"list":["features","statement_id","name"]}]},{"product":"Tonal Sentiment","productId":"TONAL_SENTIMENT","version":"1.1.0","resultLevel":"Speaker","resultSetSummary":[{"paragraph":["A single value for each noted speaker, ranging from 0 through 5, reflecting total sentiment score of the speaker in the analyzed file."]}],"resultStructure":[{"list":["features","person_id","name"]}]},{"product":"Tonal Sentiment","productId":"TONAL_SENTIMENT","version":"2.1.0","resultLevel":"Speaker","resultSetSummary":[{"paragraph":["A single value for each noted speaker, ranging from -5 through 5, reflecting total sentiment score of the speaker in the analyzed file."]}],"resultStructure":[{"list":["features","person_id","name"]}]},{"product":"Tonal Sentiment ATST","productId":"TONAL_SENTIMENT_ATST","version":"1.1.0","resultLevel":"Statement","resultSetSummary":[{"paragraph":["A single value for each statement, ranging from 0 through 5, reflecting the tonal sentiment score for that individual statement."]}],"resultStructure":[{"list":["features","statement_id","name"]}]},{"product":"Tonal Sentiment ATST","productId":"TONAL_SENTIMENT_ATST","version":"2.1.0","resultLevel":"Statement","resultSetSummary":[{"paragraph":["A single value for each statement, ranging from -5 through 5, reflecting the total sentiment score for that individual statement."]}],"resultStructure":[{"list":["features","statement_id","name"]}]}],"entities":[{"title":"Tasks","description":["A task is the container that organises the request for any of our products. Each task should include a list of products. Products are the types of analysis than can be requested to be performed on audio","Creating a task requires an API Key. API keys are attached to the request header of each call.","After a Task is created, the response body would include 2 (two) upload URLs - one for uploading the Audio file, and the other for uploading the descriptor file.","Once the supporting documents have been uploaded, results are retrieved by polling the results endpoint for each product."],"object":{"taskId":"SlaBZqMHY4vmZV3Hvp9V","customerId":"MkVgHVo9g4sZlR7pr3IP","title":"AAPL - Q1 2021 Earnings Call","status":"CREATED","analysisProducts":[{"product":"A26","version":"1.0.1","resultId":null}],"audioConfigs":[{"configId":"342zBTVl5KKFkFJt7ops","audio":{"type":"EARNINGS_CALL","fileType":"MP3","fileName":"apple-q1-2021-earnings-call-audio","uploadStatus":"REQUIRED","uploadUrl":"https://storage.googleapis.com/mercury-api-dev-task-files-upload/SlaBZqMHY4vmZV3Hvp9V/342zBTVl5KKFkFJt7ops-AUDIO-EARNINGS_CALL.mp3?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cloud-function-storage-signing%40mercury-api-dev.iam.gserviceaccount.com%2F20210602%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20210602T193729Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=content-type%3Bhost&X-Goog-Signature=3dcfb85e0302200faf25eed55a718d9c53fd248d1d5c45e12e3f310a2b6ad7532fc6f83724bcd984e6e0ad0884d2ddca87672e147189e566050b9880189dc43fbf130adfc5ef87e6d89f1f904df86d3374c4a3c0b828de46ee55e7b7fee6b9f3d5836a789714d1a9dfbe7d7acb4146771121e88389cd54e67887dcac2fe136e9588bc17ddbda41062dd9e7169a75a6b1e1d34db5c0d3fc8af41bf62f54db67a60ed8b5ec23378f6b5d11ece3eee0c064143e87a50711bcc7dda62d91b1450081c3b0eef28f2bbb0612f0cae63adc6692fee1d27fb598c82b8a16203c1c83a111a18957aa9f9ebe1d73e78bdc98739277aeb85b916901e25dfac44bf01f7fb6c6"},"descriptor":{"type":"AUDIO_INDEX","fileType":"JSON","fileName":"apple-q1-2021-earnings-call-transcript","uploadStatus":"REQUIRED","uploadUrl":"https://storage.googleapis.com/mercury-api-dev-task-files-upload/SlaBZqMHY4vmZV3Hvp9V/342zBTVl5KKFkFJt7ops-DESCRIPTOR-AUDIO_INDEX.json?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cloud-function-storage-signing%40mercury-api-dev.iam.gserviceaccount.com%2F20210602%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20210602T193729Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=content-type%3Bhost&X-Goog-Signature=06ec9e667ab5845a39ce8718217eb22e2166e3997c855711bb84b7c965479a2781fb84416819cf3209b36cd89ef38eed1bf4d386ae740c6ba7fb8f5e8b313923e020d8faf0f9fcc0001f7cfc26064444f769af23687ddeb5cb9373f99fa17f7ea84db9b669a1f57514ddba97b1a3c6d35a292636f1936b60d5a4473431787f3eed0e40c79be41fb125d38a2804467d838e3018c8a86d604e2f95e4b968dbd211de1f1109847c1e4f483f5b85e4b2a8c84ec7ea0a638f4fce10b625ba12187391de8eed832849bffdca8c25b1637323df8434ad76903225b1cd9cae3cb5e5b7fe7e1f6be00f4d1060d9b344b3253ee51d2075a2556f8f34e240ad02e0dc214902"}}],"createdTime":"2021-06-02T19:37:29.731380","updatedTime":null,"runTime":null,"tags":[]},"steps":["Authentication","Create a task","Upload audio","Upload descriptor file","Get Task","Get Results"],"endpoints":[{"url":"","title":"Create a task","description":["Create a task to request products. Each task must have only one audio file, you may request multiple products and multiple versions of a product per task."],"attributes":[{"attribute":"title","type":"String","description":"Your title for the analysis request"},{"attribute":"analysisProducts","type":"Array of Objects","description":"The Helios products that are being requested for analysis"},{"attribute":"analysisProducts[].product","type":"String","description":"Helios analysis product name"},{"attribute":"analysisProducts[].version","type":"String","description":"Helios analysis product version number"},{"attribute":"audioConfigs","type":"Array of Objects","description":"Describes the audio being submitted for analysis"},{"attribute":"audioConfigs[].audio","type":"Object","description":"Contains the audio file details"},{"attribute":"audioConfigs[].audio.fileName","type":"String","description":"Name of the audio file"},{"attribute":"audioConfigs[].audio.fileType","type":"String","description":"Audio file type (e.g. MP3)"},{"attribute":"audioConfigs[].audio.type","type":"String","description":"Description of the nature of the audio file (e.g. earnings call)"},{"attribute":"audioConfigs[].descriptor","type":"Object","description":"Contains the descriptor file details"},{"attribute":"audioConfigs[].descriptor.fileName","type":"String","description":"Name of the descriptor file"},{"attribute":"audioConfigs[].descriptor.fileType","type":"String","description":"Descriptor file type (e.g. JSON)"},{"attribute":"audioConfigs[].descriptor.type","type":"String","description":"Type of descriptor file (audio index or transcript)"},{"attribute":"Response Attributes","type":"DIVIDER","description":""},{"attribute":"taskId","type":"UUID","description":"A unique identifier generated by Helios for the analysis requested"},{"attribute":"customerId","type":"UUID","description":"Customer identifier"},{"attribute":"status","type":"String","description":"Status of the analysis request"},{"attribute":"analysisProduct[].resultId","type":"UUID","description":"A unique identifier generated by Helios for a result set produced for an analysis request"},{"attribute":"audioConfigs[].configId","type":"UUID","description":"Attributes associated with the audio submitted for analysis"},{"attribute":"audioConfigs[].audio.uploadStatus","type":"String","description":"Status of the audio file upload"},{"attribute":"audioConfigs[].audio.uploadUrl","type":"String","description":"Signed URL to use for audio file upload"},{"attribute":"audioConfigs[].descriptor.uploadStatus","type":"String","description":"Status of the descriptor file upload"},{"attribute":"audioConfigs[].descriptor.uploadUrl","type":"String","description":"Signed URL to use for the descriptor file upload"},{"attribute":"createdTime","type":"UTC Date","description":"Creation date/time for the analysis task"},{"attribute":"updatedTime","type":"UTC Date","description":"Update date/time for the analysis task"},{"attribute":"runTime","type":"UTC Date","description":"The date/time when the audio analysis was performed"},{"attribute":"tags","type":"Array of String","description":"Echo of any customer provided metadata tag"}],"requestBody":{},"responseBody":{"taskId":"SlaBZqMHY4vmZV3Hvp9V","customerId":"MkVgHVo9g4sZlR7pr3IP","title":"AAPL - Q1 2021 Earnings Call","status":"CREATED","analysisProducts":[{"product":"A26","version":"1.0.1","resultId":null}],"audioConfigs":[{"configId":"342zBTVl5KKFkFJt7ops","audio":{"type":"EARNINGS_CALL","fileType":"MP3","fileName":"apple-q1-2021-earnings-call-audio","uploadStatus":"REQUIRED","uploadUrl":"https://storage.googleapis.com/mercury-api-dev-task-files-upload/SlaBZqMHY4vmZV3Hvp9V/342zBTVl5KKFkFJt7ops-AUDIO-EARNINGS_CALL.mp3?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cloud-function-storage-signing%40mercury-api-dev.iam.gserviceaccount.com%2F20210602%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20210602T193729Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=content-type%3Bhost&X-Goog-Signature=3dcfb85e0302200faf25eed55a718d9c53fd248d1d5c45e12e3f310a2b6ad7532fc6f83724bcd984e6e0ad0884d2ddca87672e147189e566050b9880189dc43fbf130adfc5ef87e6d89f1f904df86d3374c4a3c0b828de46ee55e7b7fee6b9f3d5836a789714d1a9dfbe7d7acb4146771121e88389cd54e67887dcac2fe136e9588bc17ddbda41062dd9e7169a75a6b1e1d34db5c0d3fc8af41bf62f54db67a60ed8b5ec23378f6b5d11ece3eee0c064143e87a50711bcc7dda62d91b1450081c3b0eef28f2bbb0612f0cae63adc6692fee1d27fb598c82b8a16203c1c83a111a18957aa9f9ebe1d73e78bdc98739277aeb85b916901e25dfac44bf01f7fb6c6"},"descriptor":{"type":"AUDIO_INDEX","fileType":"JSON","fileName":"apple-q1-2021-earnings-call-transcript","uploadStatus":"REQUIRED","uploadUrl":"https://storage.googleapis.com/mercury-api-dev-task-files-upload/SlaBZqMHY4vmZV3Hvp9V/342zBTVl5KKFkFJt7ops-DESCRIPTOR-AUDIO_INDEX.json?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cloud-function-storage-signing%40mercury-api-dev.iam.gserviceaccount.com%2F20210602%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20210602T193729Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=content-type%3Bhost&X-Goog-Signature=06ec9e667ab5845a39ce8718217eb22e2166e3997c855711bb84b7c965479a2781fb84416819cf3209b36cd89ef38eed1bf4d386ae740c6ba7fb8f5e8b313923e020d8faf0f9fcc0001f7cfc26064444f769af23687ddeb5cb9373f99fa17f7ea84db9b669a1f57514ddba97b1a3c6d35a292636f1936b60d5a4473431787f3eed0e40c79be41fb125d38a2804467d838e3018c8a86d604e2f95e4b968dbd211de1f1109847c1e4f483f5b85e4b2a8c84ec7ea0a638f4fce10b625ba12187391de8eed832849bffdca8c25b1637323df8434ad76903225b1cd9cae3cb5e5b7fe7e1f6be00f4d1060d9b344b3253ee51d2075a2556f8f34e240ad02e0dc214902"}}],"createdTime":"2021-06-02T19:37:29.731380","updatedTime":null,"runTime":null,"tags":[]},"code":[{"lang":"curl","snippet":"curl --request POST 'https://mercury.api.helioslife.ventures/v1/tasks' \\\n  --header 'x-api-key: [YOUR_API_KEY]' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"title\": \"AAPL - Q1 2021 Earnings Call\",\n  \"analysisProducts\": [\n    {\n      \"product\": \"A26\",\n      \"version\": \"1.0.1\"\n    }\n  ],\n  \"audioConfigs\": [\n    {\n      \"audio\": {\n        \"fileName\": \"apple-q1-2021-earnings-call-audio\",\n        \"fileType\": \"MP3\",\n        \"type\": \"EARNINGS_CALL\"\n      },\n      \"descriptor\": {\n        \"fileName\": \"apple-q1-2021-earnings-call-transcript\",\n        \"fileType\": \"JSON\",\n        \"type\": \"AUDIO_INDEX\"\n      }\n    }\n  ],\n  \"tags\": [\n    {\n      \"name\": \"hello\",\n      \"value\": \"world\"\n    }\n  ]\n}' \\\n  --compressed"}]},{"url":"","title":"Upload audio","description":["Audio files are uploaded to tasks via `audioUploadURL` endpoint that was returned when the Task was created.","After the audio file has been uploaded, the `audioUploaded` & `audioFileName` fields will be appended.","We are currently limiting audio file types to `.mp3`. If you would like submit another file type please email us at support@helioslife.enterprises"],"attributes":[],"requestBody":{},"responseBody":200,"code":[{"lang":"curl","snippet":"curl --location --request POST '[UPLOAD_URL]' \\\n--header 'x-api-key: [YOUR_API_KEY]' \\\n--header 'Content-Type: audio/mpeg' \\\n--data-binary '@/path/to/file.MP3'"}]},{"url":"","title":"Upload descriptor file","description":["Uploading the descriptor file follows the same workflow as uploading the audio file. Descriptor files are uploaded to tasks via `descriptorUploadURL` endpoint that was returned when the Task was created.","After the descriptor file has been uploaded, the `descriptorUploaded` & `descriptorFileName` fields will be appended.","We are currently limiting audio file types to `.json`. If you would like submit another file type please email us at support@helioslife.enterprises"],"attributes":[],"altAttributes":{"title":"Transcript descriptor file attributes","description":"The transcript file uploaded should include these fields. The file type must be .json. It should be structured as follows:","attributes":[{"attribute":"speaker","type":"String","description":"The speaker name"},{"attribute":"section","type":"String","description":"The section of the audio event associated with the statement (e.g. prepared remarks or question and answer period)"},{"attribute":"statement","type":"String","description":"The text of the statement (if providing full transcript)"},{"attribute":"type","type":"String","description":"Categorization of statement: “calibration” or “analysis”"},{"attribute":"start","type":"Number","description":"Start time of statement (in seconds, from file start)"},{"attribute":"stop","type":"Number","description":"Stop time of statement (in seconds, from file start)"}]},"requestBody":{},"responseBody":200,"code":[{"lang":"curl","snippet":"curl --location --request POST '[UPLOAD_URL]' \\\n--header 'x-api-key: [YOUR_API_KEY]' \\\n--header 'Content-Type: application/json' \\\n--data-binary '@/path/to/file.json'"}]},{"url":"","title":"Get Task","description":["After attaching the audio & descriptor files to the tasks, when the results are ready, the result ID is attached to the `task` object","Use the attached resultId to retrieve the results."],"attributes":[],"requestBody":{},"responseBody":{},"code":[{"lang":"curl","snippet":"curl --location --request GET 'https://mercury.api.helioslife.ventures/v1/tasks/:taskId' \\\n--header 'x-api-key: AIzaSyB9YFBM3lCbNPXotwaETCprSmikw64BT04'"}]},{"url":"","title":"Get Results","description":["Use the resultId attached to the task object to retrieve the results.","The analysis results can take up to a few hours depending on the product requested."],"attributes":[{"attribute":"id","type":"UUID","description":"Result id for the analysis"},{"attribute":"task_id","type":"UUID","description":"Task id associated with the analysis"},{"attribute":"title","type":"String","description":"The title given to the analysis"},{"attribute":"url","type":"String","description":"URL for the result dataset"},{"attribute":"audio","type":"String","description":"URL for the audio file submitted"},{"attribute":"descriptor","type":"String","description":"URL for the descriptor file submitted"},{"attribute":"entity","type":"Object","description":"Entity description fields"},{"attribute":"entity.name","type":"String","description":"Entity name"},{"attribute":"entity.type","type":"String","description":"Entity type"},{"attribute":"entity.ticker","type":"String","description":"Entity ticker symbol"},{"attribute":"event","type":"Object","description":"Event description fields"},{"attribute":"event.id","type":"UUID","description":"Event id"},{"attribute":"event.title","type":"String","description":"Event title"},{"attribute":"event.type","type":"String","description":"Event type"},{"attribute":"event.time","type":"Date UTC","description":"Event time"},{"attribute":"publishedTime","type":"Date UTC","description":"Date/time of result set publishing"},{"attribute":"qualityMetric","type":"Number","description":"Helios indicator of audio file quality"},{"attribute":"meta","type":"Object","description":"Metadata object"},{"attribute":"meta.ticker","type":"String","description":"Ticker symbol"},{"attribute":"meta.region","type":"String","description":"Region"},{"attribute":"meta.audio","type":"Array of Strings","description":"Type of audio provided"},{"attribute":"meta.descriptoe","type":"String","description":"Type of descriptor file"},{"attribute":"meta.product","type":"String","description":"Helios product name"},{"attribute":"meta.productVersion","type":"String","description":"Helios product version number"},{"attribute":"results","type":"Array of Objects","description":"Result set object"},{"attribute":"results[].speaker","type":"String","description":"Speaker name"},{"attribute":"results[].section","type":"String","description":"Audio event section"},{"attribute":"results[].statement","type":"String","description":"Statement text"},{"attribute":"results[].type","type":"String","description":"Statement type"},{"attribute":"results[].start","type":"String*","description":"Statement start time"},{"attribute":"results[].stop","type":"String*","description":"Statement end time"},{"attribute":"results[].duration","type":"Number","description":"Statement duration"},{"attribute":"results[].features","type":"Array of Numbers","description":"Analysis result data"}],"requestBody":{},"responseBody":{"id":"507f1f77bcf86cd799439015","task_id":"507f1f77bcf86cd799439011","title":"AAPL - Q3 2021 Earnings Call","url":"//api/results/507f1f77bcf86cd799439011/a26/1.0.1","audio":"//storage/audio/earnings_call/507f1f77bcf86cd799439011/507f1f77bcf86cd799439012.mp3","descriptor":"//storage/descriptor/transcript/507f1f77bcf86cd799439011/507f1f77bcf86cd799439013.csv","entity":{"name":"Apple, Inc.","type":"PUB","ticker":"AAPL"},"event":{"id":1201665040,"title":"AAPL - Q3 2021 Earnings Call","type":"E","time":"2021-04-06T13:30:00+00:00"},"publishedTime":"2021-04-06T17:10:02.458994+00:00","qualityMetric":100,"meta":{"ticker":"AAPL","region":"US","audio":["MP3"],"descriptor":"TRANSCRIPT","product":"A26","productVersio":"1.0.1"},"results":[{"speaker":"Timothy D. Cook","section":"PREPARED_REMARKS","statement":"Thanks, Tejas, and good afternoon, and thanks for joining the call today. Back in April, I said we were in the most challenging environment in which Apple as a company...","type":"CALIBRATION","start":"0:5:31","stop":"0:19:29","duration":4882,"features":[-39.368287]},{"speaker":"Shannon Siemsen Cross","section":"Q_A","time":"0:12:07","statement":"Tim, can you talk a bit more about China? And in terms of linearity, I think, Luca, you'd mentioned that...","type":"ANALYSIS","features":[1.338388,1.838388,3.728226]}]},"code":[{"lang":"curl","snippet":"curl --location --request GET 'https://mercury.api.helioslife.ventures/v1/results/:resultId' \\\n--header 'x-api-key: [YOUR_API_KEY]'"}]}]}]}