symblai / symbl-docs Goto Github PK
View Code? Open in Web Editor NEWSymbl.ai open sources its documentation into a GitHub repository for you as a developer to actively develop through pull requests.
Symbl.ai open sources its documentation into a GitHub repository for you as a developer to actively develop through pull requests.
param variable is not defined in async-api/overview/audio/put-audio-url.md
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
In this page : Conversation data API
id
is missing in member's dictionary of response
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.
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
Text API only supports parameters in the Request Body.
The webhookUrl
works with request body. It needs to be moved to the respective section.
Link to page:
https://docs.symbl.ai/docs/async-api/overview/text/post-text
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))
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
New API content should be present on the conversation API introduction page.
Link to page:
"customEntities": [{"entityName": "entityValue"}]
trackers = [{ "name": "COVID-19", "vocabulary": [ "social distancing", "cover your face with mask", "vaccination" ] }]
customEntities example is not given in Async APIs
trackers example is not given in Async APIs
Link to page:
The Dark Mode Theme is not working properly in some section, which causes difficulty in reading some text.
- OS: Windows 10
- Node:
- npm:
Chrome
No response
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.
We need to remove entities
from Topics and Questions API.
Link to page:
No response
code example should have:
{ "languages": ["ja-JP"] }
https://docs.symbl.ai/docs/telephony-api/api-reference#supported-languages
Link to page:
https: //api.symbl.ai/v1/process/audio?trackers=[ { "name": "COVID-19", "vocabulary": [ "social distancing", "cover your face with mask", "vaccination" ] } ]
https://api.symbl.ai/v1/process/audio?trackers=[{"name":"COVID-19", "vocabulary":["social distancing", "cover your face with mask", "vaccination"]}]
Link to page:
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)
conversation_id
into append Audio API's code.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 } ] }
Link to page:
All Async APIs
https://docs.symbl.ai/docs/async-api/overview/audio/post-audio
No response
param variable in not defined in async-api/overview/audio/post-audio-url.md
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.
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.
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"
}'
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.
Write now Query parameter is written on all of them.
Link to page:
No response
No response
No response
- OS:
- Node:
- npm:
No response
No response
Link to page:
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
As of this writing, the API accepts files that are 4 hours or less in duration.
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
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 )
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.
Link to page:
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
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.
Link to page:
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:
There is a missing segment in the documentation for the GET Tracker
section.
GET Tracker
should describe:
GET /manage/tracker/:id
)This is included already.
GET /manage/trackers
)This needs to be added in. I have confirmed on Postman that 'get all trackers' is active.
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
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
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.