symblai/symbl-docs

Symbl.ai open sources its documentation into a GitHub repository for you as a developer to actively develop through pull requests.

symbl-docs's Issues

enableSpeakerDiarization & diarizationSpeakerCount

Expected content

For our Async URL APIs (Audio & Video) enableSpeakerDiarization & diarizationSpeakerCount should ideally be passed in request body.

Also, for Async File (Audio & Video ) enableSpeakerDiarization & diarizationSpeakerCount should be passed in Query Parameter. We should include them in the main parameter list. Right now, we have 2 separate list due to which people think it is separate. All Query Parameters should be listed at one place.

Actual content

Write now Query parameter is written on all of them.

Link to page:

Code example parameter name incorrect

Expected content

code example should have:

{ "languages": ["ja-JP"] }

Actual content

https://docs.symbl.ai/docs/telephony-api/api-reference#supported-languages

Link to page:

Trackers Description for Async API is incorrect

Expected content

String type is incorrect. It's a list. Also, the description is incorrect too.

Actual content

Link to page:

Update Trackers API (GET /mangage/trackers)

There is a missing segment in the documentation for the GET Tracker section.

GET Tracker should describe:

1. How to get an individual tracker (ie. GET /manage/tracker/:id)

This is included already.

2. How to get all trackers (ie. GET /manage/trackers)

This needs to be added in. I have confirmed on Postman that 'get all trackers' is active.

Issues in sample codes of Audio API- Python SDK

Ref : https://docs.symbl.ai/docs/python-sdk/async-audio

in this page

In sample code of Async Audio API and Appending Audio URL API including comment section, we are accessing functions of Conversation class without get_ prefix.(expected get_topics() etc)

2. we haven't included conversation_id into append Audio API's code.

[Docs Update]: async-api/overview/audio/post-audio-url.md

Contact Details

No response

Description

param variable in not defined in async-api/overview/audio/post-audio-url.md

[Bug]: In https://github.com/symblai/symbl-docs/blob/develop/what-is-symbl.md, in this the links under Symbl’s Key Capabilities are not working like the link of sentiment analysis (eg : https://github.com/symblai/symbl-docs/blob/develop/docs/concepts/speech-to-text)

Contact Details

[email protected]

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

No response

Expected Behavior

No response

Steps To Reproduce

No response

Environment

- OS:
- Node:
- npm:

What browsers are you seeing the problem on?

No response

Anything else?

No response

Request for Use of Github templates for issues

GitHub have rolled out new issue forms for public repository.
https://github.blog/changelog/2021-06-23-issues-forms-beta-for-public-repositories/
Please check this out.
If maintainers can give some suggestions then I can make some templates for opening issues for this repository.
Thank you

Grammatical error in readme file

Expected content

Actual content

Link to page:

customEntities examples are incorrect or missing

Expected content

Note: We need to give examples of custom entities in all Async APIs. Also, for custom entities, the parameter is entities for all APIs.

Async Text API

{ "messages": [ { "payload": { "content": "Hello. So this is a live demo that we are trying to give very we are going to show how the platform detects various insights can do transcription in real-time and also the different topics of discussions, which would be generated after the call is over, and they will be an email that will be sent to the inbox. So that is the idea. So I am going to do a quick conversation.", "contentType": "text/plain" }, "from": { "name": "John", "userId": "[email protected]" } } ], "detectEntities": true, "entities": [ { "customType": "identify_org", "text": "platform" } ] }

Async Audio File API/Video API (POST/PUT)
Note: These parameters go in Query Paramater.

"detectEntities": true, "entities": [ { "customType": "identify_people", "text": "wife" }, { "customType": "identify_colour", "text": "blue" } ]

Async Audio URL API/Video URL API (POST/PUT)
Note: These parameters go in the request body.

"detectEntities": true, "entities": [ { "customType": "identify_people", "text": "wife" }, { "customType": "identify_colour", "text": "blue" } ]

Sample Response in Entities API
{ "type": "custom", "customType": "identify_colour", "value": "blue", "text": "blue", "messageRefs": [ { "id": "4592265554034688", "text": "What color did you want the New Yorker in blue?", "offset": 42 } ] }

Actual content

Link to page:
All Async APIs
https://docs.symbl.ai/docs/async-api/overview/audio/post-audio

Trackers and Analytics UI

Expected content

Can we add an image and demo URL on top so users can test it out for themselves.

Actual content

Link to page:

Async File Python Code - Needs Update

In the async file submission python code snippet, there are multiple areas where a boolean is expected in the params eg. 'detectPhrases': True,

The way the code snippet is currently written, when the params object is passed in the API request, it is still in the form of a Python dictionary object. Before sending in the request this object needs to be encoded so that the API reads the boolean values as a true boolean.

For example if params = {'detectPhrases': True} then the request:
response = requests.request("POST", url, headers=headers, data=payload, params=params) will return a status 400. The resulting params will be in the form https://api.symbl.ai/v1/process/video?detectPhrases=True

In this example the capitol 'True' will not be accepted by the API and return a status 400.

The correct param format needs to be in the form https://api.symbl.ai/v1/process/video?detectPhrases=true

In order to make this request in python the params object needs to be encoded properly. For example params = json.dumps(params), or in the request response = requests.request("POST", url, headers=headers, data=payload, params=json.dumps(params))

Remove examples from Action Items

Please remove these(2 marked in the image below) examples from the Action Items concept pages and add new examples at their place.

Why remove the currently marked example? Ans: They don't work as Action Items now.

Why add new examples in its place? Ans: So, the customers have wide range of examples to understand.

Link to page:

Change the length for Async Time

Expected content

As of this writing, the API accepts files that are 4 hours or less in duration.

Actual content

As of this writing, the API accepts files that are 2 hours or less in duration.

Link to page:

https://docs.symbl.ai/docs/faq#what-is-the-maximum-length-of-meeting-duration-the-async-api-support

Issues in the code snippets of Video API - Python SDK

Ref : https://docs.symbl.ai/docs/python-sdk/async-video

In Appending Video API including comment section, we have accessed methods of conversation object without get_ prefix before using each insights. (expected get_members(),get_topics(),get_questions(), etc )

Demo Meeting link is down

Expected content

Actual content

Link to page:

[Docs Update]: async-api/overview/audio/put-audio-url.md

Description

param variable is not defined in async-api/overview/audio/put-audio-url.md

Tidy up endpoint URL (GET Tracker)

There is a superfluous & character that should be removed.
Link - https://docs.symbl.ai/docs/management-api/trackers/get-tracker
Before - GET https://api.symbl.ai/v1/manage/trackers?&name={trackerName}
After - GET https://api.symbl.ai/v1/manage/trackers?name={trackerName}

Both path strings work fine, but the endpoint description should be tidy.

In Text API the parameter `webhookUrl` works with request body.

Expected content

Text API only supports parameters in the Request Body.

The webhookUrl works with request body. It needs to be moved to the respective section.

Actual content

Link to page:
https://docs.symbl.ai/docs/async-api/overview/text/post-text

NameError in Text API

We are using dictionary without defining/initialize it before the use

Link:
https://docs.symbl.ai/docs/python-sdk/async-api
in above link #Append text API code

It will generate NameError

end } curly bracket is missing in docs. Can we change this to example api call for cURL tab?

https://docs.symbl.ai/docs/conversation-api/update-members

end } curly bracket is missing in docs. Can we change this to example api call for cURL tab?

curl --location --request PUT "https://api.symbl.ai/v1/conversations/$CONVERATION_ID/members/$MEMBER_ID" 
 --header 'Content-Type: application/json'
 --header "Authorization: Bearer $AUTH_TOKEN" 
 --data-raw '{
    "id": "'$MEMBER_ID'",
    "email": "[email protected]",
    "name": "John"
}'

[Docs Update]: Rewriting the process of setting up docs locally using HTTPS with detailed steps

Contact Details

[email protected]

Description

Async APIs is missing examples for the parameters

Expected content

1. "customEntities": [{"entityName": "entityValue"}]

2. trackers = [{ "name": "COVID-19", "vocabulary": [ "social distancing", "cover your face with mask", "vaccination" ] }]

Actual content

customEntities example is not given in Async APIs
trackers example is not given in Async APIs

Link to page:

`Id` in members is missing from response

https://docs.symbl.ai/docs/conversation-api/conversation-data#response

[Docs Update]: Not able to run the project on local

Contact Details

[email protected]

Description

I followed the documentation i.e. cloned the repo and cd into the directory and then ran yarn for installing all of the packages and then yarn start for running the project on local but there's no package.json file present. I guess, i have to cd further into any directory and then do yarn start.
Please help and then correct the documentation as well.

[Docs Update]: remove `$` from Readme

Contact Details

[email protected]

Description

Since the commands are to be copied by the user, using $ before each one doesn't make sense and for somebody new to using commands can cause errors.

Adds logo

Dark Theme is not working in some section

Contact Details

[email protected]

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

The Dark Mode Theme is not working properly in some section, which causes difficulty in reading some text.

Environment

- OS: Windows 10
- Node:
- npm:

What browsers are you seeing the problem on?

Chrome

Anything else?

No response

Missing attribute in Conversation API

In this page : Conversation data API

id is missing in member's dictionary of response

Response is missing for Telephony API Code Snippets

Expected content

Actual content

Link to page:

https://docs.symbl.ai/docs/telephony/

Corrections in - Python SDK

Ref : https://docs.symbl.ai/docs/python-sdk/conversation-api

We have used get_ prefix before using each insight in code snippets and supported function.(expected only members(),topics(),questions(), etc)

Ref - https://docs.symbl.ai/docs/python-sdk/python-sdk-reference#conversation-object

current - In Ref we have used get_ prefix bef describing each method

Expected - Conversation class has methods defined as message(), topics() etc

Same for Conversation object

Query params and request body missing "enableAllTrackers" value

As per the following link, we must have "enableAllTrackers" Parameter as a query parameter in some APIs and also as a request body param in some APIs

https://docs.symbl.ai/docs/management-api/trackers/overview

[Docs Update]: Speakers zoom integration sdk link does not work

Contact Details

No response

Description

symbl-docs/docs/conversation-api/api-reference/speakers.md

Line 25 in 180fbb8

[available.](https://github.com/symblai/speaker-events-converter)

This url returns 404

Sample Response has empty responses

In https://docs.symbl.ai/docs/conversation-api/action-items sample response, entities are returned as empty throughout. Action Items are our unique feature, and the example should illustrate the full-extent of it or it won’t be clear to new people.

Expected content/Solution

Replace with an example response that either has all response parameters, or no empty response parameters.

Link to page: https://docs.symbl.ai/docs/conversation-api/action-items

Readability for Trackers API Async Request

Expected content

https: //api.symbl.ai/v1/process/audio?trackers=[ { "name": "COVID-19", "vocabulary": [ "social distancing", "cover your face with mask", "vaccination" ] } ]

Actual content

https://api.symbl.ai/v1/process/audio?trackers=[{"name":"COVID-19", "vocabulary":["social distancing", "cover your face with mask", "vaccination"]}]

Link to page:

Remove `entities` from Topics and Question API

Expected content

We need to remove entities from Topics and Questions API.

Actual content

Link to page:

[Docs]: Versioning of Docs

Contact Details

[email protected]

Anything else?

Use: Document versioning will help to keep documentation in sync with project releases.

Docusaurus provides this feature very functionality, which is being used in this project.

Ref: https://docusaurus.io/docs/versioning

Conversation API Introduction Page not updated with all new APIs

Expected content

New API content should be present on the conversation API introduction page.

Actual content

Link to page:

https://docs.symbl.ai/docs/conversation-api/introduction/

Fix: Summarization Endpoint

Requested Change

The base url for Async Video URL API should be the same as the other endpoints.

Link to page: https://docs.symbl.ai/docs/concepts/summarization

confidenceThreshold =< 0.5 <=1.0.

Expected content

Confidence threshold should should =< 0.5 <=1.0. in the documentation. Basically, it can be 0.5 or bigger and less than or equal to 1.0.

Note @Pema if you try to put 0.3 it will tell you to increase it <=0.5 to <=1.0
In all APIs.

Actual content

Link to page:

`speechRecognition` description is incorrect.

Expected content

Actual content

The description for this incorrect. We wrote speaker object definition in it.

Link to page:
https://docs.symbl.ai/docs/streaming-api/api-reference#config