index.yaml

# This yaml file been updated for Sentient.io API Documentation v4.0.0 Beta
# Latest update : 2021-Feb-4
# For adding new microservices, please follow the format below:

#-------------------------------------------------
#
# /// - microservice category have to be lower case,
# ///the category name will be exactely same as the folder name
# Category (voice / computer vision / nlp / etc.):
#       /// - microservice SHOULD be same as the file name, except, don't need the version number
#       microservice_name:
#           /// - This will be the title appeared in the side navigation
#           /// - Use the same title from info.title inside the microservice yaml file
#           title: "Some Title"
#           /// - Versions will contain version number and file name for each version
#            versions:
#               v1.0: "yaml_file_name_goes_here_v1.0.yaml"
#               0.1.0: "yaml_file_name_goes_here_0.1.0.yaml"
#
#-------------------------------------------------

# For Sentient.io API documentation maintenance:
# There is a yamlPath variable contains the path of where the yaml file is stored
# The final yaml link will be a combination of {{yamlPath + / + category + / + verions['v1.0']}}

voice:
  automatic_speech_recognition_eng:
    title: Automatic Speech Recognition ENG
    versions:
      3.0.0: 'automatic_speech_recognition_eng_v3.yaml'
      2.0.0: 'automatic_speech_recognition_eng.yaml'
      1.2.0: 'automatic_speech_recognition_eng_v1.2.yaml'   
  automatic_speech_recognition_chi:
    title: Automatic Speech Recognition CHI
    versions:
      2.0.0: 'automatic_speech_recognition_chi.yaml'
      1.0.0: 'automatic_speech_recognition_chi_1.0.yaml'
  automatic_speech_recognition_eng_large_file:
    title: Automatic Speech Recognition ENG (Large File)
    versions:
      0.1.0: 'automatic_speech_recognition_eng_large_file.yaml'      
  online_automatic_speech_recognition_eng:
    title: Online Automatic Speech Recognition ENG
    versions:
      0.1.1: 'online_automatic_speech_recognition_eng.yaml'
  online_command_automatic_speech_recognition_eng:
    title: Online Command Automatic Speech Recognition ENG
    versions:
      0.1.0: 'online_command_automatic_speech_recognition_eng.yaml'
  text-to-speech_eng:
    title: Text-To-Speech ENG
    versions:
      1.4.0: 'text-to-speech_eng.yaml'
  text-to-speech_chi:
    title: Text-To-Speech CHI
    versions:
      0.1.0: 'text_to_speech_chi.yaml'
  text-to-speech_jp:
    title: Text-To-Speech JP
    versions:
      0.1.0: 'text_to_speech_jp.yaml'      
  # asr_with_voice_activity_detection_eng:
  #   title: ASR with Voice Activity Detection ENG
  #   versions:
  #     1.2.1: 'asr_with_voice_activity_detection_eng.yaml'     
  voice_activity_detection_eng:
    title: Voice Activity Detection ENG
    versions:
      1.0.1: 'voice_activity_detection_eng.yaml'          
  speaker_diarization:
    title: Speaker Diarization
    versions:
      0.1.0: 'speaker_diarization.yaml'   
  speaker_diarization_large_file:
    title: Speaker Diarization (Large File)
    versions:
      0.1.0: 'speaker_diarization_large_file.yaml'      
  automatic_speech_recognition_chi_large_file:
    title: Automatic Speech Recognition CHI (Large File)
    versions:
      0.1.2: 'automatic_speech_recognition_chi_large_file.yaml'      
  speaker_emotion_recognition:
    title: Speaker Emotion Recognition
    versions:
      0.2.0: 'speaker_emotion_recognition.yaml'
  speech_enhancement:
    title: Speech Enhancement
    versions:
      0.1.0: 'speech_enhancement.yaml'
nlp:
  inverse_text_normalisation_eng:
    title: Inverse Text Normalisation ENG
    versions:
      2.1.0: 'inverse_text_normalisation_eng.yaml'
  named-entity_recognition_eng:
    title: Named-Entity Recognition ENG
    versions:
      2.0.0: 'named-entity_recognition_eng.yaml'
      1.0.0: 'named-entity_recognition_eng_v1.0.yaml'
  sentence_paraphrase:
    title: Sentence Paraphrase
    versions:
      0.1.0: 'sentence_paraphrase.yaml'
  sentence_ranking:
    title: Sentence Ranking
    versions:
      0.1.0: 'sentence_ranking.yaml'      
  page_profiler_eng:
    title: Page Profiler ENG
    versions:
      2.1.1: 'page_profiler_eng.yaml'
  page_profiler_jp:
    title: Page Profiler JP
    versions:
      1.1.0: 'page_profiler_jp.yaml'
  page_profiler_thai:
    title: Page Profiler THAI
    versions:
      1.1.0: 'page_profiler_thai.yaml'
  taxonomy_matcher_eng:
    title: Taxonomy Matcher ENG
    versions:
      1.0.1: 'taxonomy_matcher_eng.yaml'
  word_sense_disambiguation_eng:
    title: Word Sense Disambiguation ENG
    versions:
      1.0.0: 'word_sense_disambiguation_eng.yaml'
  named-entity_recognition_jp:
    title: Named-Entity Recognition JP
    versions:
      2.0.0: 'named-entity_recognition_jp.yaml'
      1.0.0: 'named-entity_recognition_jp_v1.0.yaml'
  named-entity_recognition_thai:
    title: Named Entity Recognition THAI
    versions:
      2.0.0: 'named-entity_recognition_thai.yaml'
      1.0.0: 'named-entity_recognition_thai_v1.0.yaml'
  script_alignment:
    title: Script Alignment
    versions:
      1.0.0: 'script_alignment.yaml'
  word_scoring_and_suggestions:
    title: Word Scoring and Suggestions
    versions:
      0.1.0: 'word_scoring_and_suggestions.yaml'
  text_summarization:
    title: Text Summarization
    versions:
      1.0.0: 'text_summarization.yaml'
      0.2.0: 'text_summarization_v0.2.yaml' 
  text_summarization_large_file:
    title: Text Summarization (Large File)
    versions:
      0.1.0: 'text_summarization_large_file.yaml'        
  sentiment_analysis_and_sarcasm_detection:
    title: Sentiment Analysis and Sarcasm Detection
    versions:
      0.1.1: 'sentiment_analysis_and_sarcasm_detection.yaml'       
  gptj6b_text_generator:
    title: GPT-J 6B Text Generator
    versions:
      0.1.0: 'gptj6b_text_generator.yaml'      
computer vision:
  few_shots_object_detection:
    title: Few Shots Object Detection
    versions:
      v0.1.1: few_shots_object_detection.yaml
  image_text_similarity:
    title: Image Text Similarity
    versions:
      0.1.0: 'image_text_similarity.yaml'
  object_detection:
    title: Object Detection
    versions:
      1.2.0: 'object_detection.yaml'
  face_recognition:
    title: Face Recognition
    versions:
      1.0.1: 'face_recognition.yaml' 
  people_counting:
    title: People Counting
    versions:
      1.0.1: 'people_counting.yaml'
      0.1.0: 'people_counting_v0.1.yaml' 
  people_counting_large_file:
    title: People Counting (Large File)
    versions:
      0.1.0: 'people_counting_large_file.yaml'      
  person_reidentification:
    title: Person Reidentification
    versions:
      0.1.0: 'person_reidentification.yaml'
  # landmark_detection:
  #   title: Landmark Detection
  #   versions:
  #     1.0.0: 'landmark_detection.yaml'      
  landmark_recognition_sg:
    title: Landmark Detection (SG)
    versions:
      1.0.0: 'landmark_recognition_sg.yaml'
  landmark_recognition_jp:
    title: Landmark Detection (JP)
    versions:
      1.0.0: 'landmark_recognition_jp.yaml'
  demographics_classification:
    title: Demographics Classification
    versions:
      0.1.0: 'demographics_classification.yaml'
  thumbnail_generation:
    title: Thumbnail Generation
    versions:
      0.2.1: 'thumbnail_generation.yaml'      
  thumbnail_generation_large_file:
    title: Thumbnail Generation (Large File)
    versions:
      0.1.0: 'thumbnail_generation_large_file.yaml'      
  invoice_scanner:
    title: Invoice Scanner
    versions:
      0.2.0: 'invoice_scanner.yaml'
  receipt_scanner:
    title: Receipt Scanner
    versions:
      0.2.0: 'receipt_scanner.yaml'       
utility:
  video-to-audio_converter:
    title: Video-To-Audio Convertor
    versions:
      1.0.0: 'video-to-audio_converter.yaml'
      0.1.0: 'video-to-audio_converter_v0.1.yaml'
  web_scraper:
    title: Web Scraper
    versions:
      2.0.0: 'web_scraper.yaml'
      1.1.1: 'web_scraper_v1.yaml'
  document_convertor_eng:
    title: Document Convertor ENG
    versions:
      2.0.0: 'document_conversion_eng.yaml'
      1.0.0: 'document_conversion_eng_v1.0.yaml'
  pdf_extractor:
    title: PDF Extractor
    versions:
      2.0.0: 'pdf_extractor.yaml'
      1.0.0: 'pdf_extractor_v1.yaml'
  pki_key_generator:
    title: PKI Key Generator
    versions:
      1.0.0: 'pki_key_generator.yaml'
      0.1.0: 'pki_key_generator_v0.1.yaml'
  encryption_using_pki_key:
    title: Encryption using PKI Key
    versions:
      1.0.0: 'encryption_using_pki_key.yaml'
      0.1.0: 'encryption_using_pki_key_v0.1.yaml'
  decryption_using_pki_key:
    title: Decryption using PKI Key
    versions:
      1.0.0: 'decryption_for_pki_key.yaml'
      0.1.0: 'decryption_for_pki_key_v0.1.yaml'
  wikipedia:
    title: Wikipedia Retrieval
    versions:
      2.0.1: 'wikipedia_retrieval.yaml'
      1.0.0: 'wikipedia_v1.yaml'
  json-csv_convertor:
    title: JSON-CSV Convertor
    versions:
      2.1.0: 'json-csv_convertor.yaml'
      1.0.0: 'json-csv_convertor_1.yaml'
  csv-json_convertor:
    title: CSV-JSON Convertor
    versions:
      2.1.0: 'csv-json_convertor.yaml'
      1.0.0: 'csv-json_convertor_1.yaml'
  audio_processing_utility:
    title: Audio Format Convertor
    versions:
      1.0.0: 'audio_processing_utility.yaml'
      0.1.1: 'audio_processing_utility_v0.1.yaml'
  video-to-image_convertor:
    title: Video-to-Image Convertor
    versions:
      1.0.0: 'video-to-image_convertor.yaml'
      0.1.0: 'video-to-image_convertor_v0.1.yaml'
  newspaper_article_scraper:
    title: Newspaper Article Scraper
    versions:
      1.0.0: 'newspaper_article_scraper.yaml'
      0.1.0: 'newspaper_article_scraper_v0.1.yaml'
  urls_retrieval:
    title: URLs Retrieval
    versions:
      0.2.1: 'urls_retrieval.yaml'
  base64_file_encode:
    title: Base64 Encoder
    versions:
      1.0.0: 'base64_file_encode.yaml'
      0.1.0: 'base64_file_encode_v0.1.yaml'
  base64_file_decode:
    title: Base64 Decoder
    versions:
      1.0.0: 'base64_file_decode.yaml'    
  get_ip:
    title: Get IP
    versions:
      0.2.0: 'get_ip.yaml'
  date_resolution:
    title: Date Resolution
    versions:
      0.3.0: 'date_resolution.yaml'       
data:
  commercial_directories_hdb_sg:
    title: HDB Commercial Directories (SG)
    versions:
      1.0.0: 'commercial_directories_hdb_sg.yaml'
  hdb_upgrading_programmes:
    title: HDB Upgrading Programmes (SG)
    versions:
      0.1.0: 'hdb_upgrading_programmes.yaml'
  hdb_covered_linkways:
    title: HDB Covered Linkways (SG)
    versions:
      0.1.0: 'hdb_covered_linkways.yaml'
  hdb_town_estates_boundaries:
    title: HDB Town and Estates Boundaries (SG)
    versions:
      0.1.0: 'hdb_town_estates_boundaries.yaml'
  hdb_land_ownership:
    title: HDB Land Ownership (SG)
    versions:
      0.1.0: 'hdb_land_ownership.yaml'
  hdb_social_communal:
    title: HDB Social Communal Facilities (SG)
    versions:
      0.1.0: 'hdb_social_communal.yaml'
  hdb_building_outlines:
    title: HDB Building Outlines (SG)
    versions:
      0.1.0: 'hdb_building_outlines.yaml'
  building_addresses_hdb_sg:
    title: HDB Block Coordinates (SG)
    versions:
      1.0.0: 'building_addresses_hdb_sg.yaml'
  residential_sales_and_rental_hdb_sg:
    title: HDB Residential Occupancy Status (SG)
    versions:
      1.0.0: 'residential_sales_and_rental_hdb_sg.yaml'
  carpark_hdb_sg:
    title: HDB Carpark Locations (SG)
    versions:
      1.0.0: 'carpark_hdb_sg.yaml'
  demographics_hdb_sg:
    title: HDB Demographics (SG)
    versions:
      1.0.0: 'demographics_hdb_sg.yaml'
  flat_ownership_hdb_sg:
    title: HDB Flat Ownership Duration (SG)
    versions:
      1.0.0: 'flat_ownership_hdb_sg.yaml'
  season_parking_availability_hdb_sg:
    title: HDB Season Parking Availability (SG)
    versions:
      1.0.0: 'season_parking_availability_hdb_sg.yaml'
  directory_of_singapore_startups:
    title: Directory of Singapore Startups
    versions:
      1.0.0: 'directory_of_singapore_startups.yaml'
  fitness_stations_and_playgrounds_hdb_sg:
    title: HDB Fitness Stations and Playgrounds (SG)
    versions:
      2.0.0: 'fitness_stations_and_playgrounds_hdb_sg.yaml'
      1.0.0: 'fitness_stations_and_playgrounds_hdb_sg_v1.yaml'
  amenities_lamp_posts_hdb_sg:
    title: HDB Lamp Posts Locations (SG)
    versions:
      2.0.0: 'amenities_lamp_posts_hdb_sg.yaml'
      1.0.0: 'amenities_lamp_posts_hdb_sg_v1.yaml'
  amenities_hardcourts_hdb_sg:
    title: HDB Hardcourts Locations (SG)
    versions:
      2.0.0: 'amenities_hardcourts_hdb_sg.yaml'
      1.0.0: 'amenities_hardcourts_hdb_sg_v1.yaml'
  amenities_shelters_hdb_sg:
    title: HDB Shelters Locations (SG)
    versions:
      2.0.0: 'amenities_shelters_hdb_sg.yaml'
      1.0.0: 'amenities_shelters_hdb_sg_v1.yaml'
  d&b_business_check_plus_sg:
    title: D&B Business Check Plus (SG)
    versions:
      1.0.0: 'd&b_business_check_plus_sg.yaml'
  d&b_basic_individual_search_sg:
    title: D&B Basic Individual Search (SG)
    versions:
      1.0.0: 'd&b_basic_individual_search_sg.yaml'
      0.1.0: 'd&b_basic_individual_search_sg_v0.1.yaml'
  d&b_business_check_sg:
    title: D&B Business Check (SG)
    versions:
      1.0.0: 'd&b_business_check_sg.yaml'
  d&b_brief_financial_information_sg:
    title: D&B Brief Financial Information (SG)
    versions:
      1.0.0: 'd&b_brief_financial_information_sg.yaml'
  hdb_amenities_score:
    title: HDB Amenities Score
    versions:
      0.1.0: 'hdb_amenities_score.yaml'
  trajectory_clustering:
    title: Trajectory Clustering
    versions:
      0.1.0: 'trajectory_clustering.yaml'
  train_stations_sg:
    title: Train Stations (SG)
    versions:
      0.1.0: 'train_stations_sg.yaml' 
analytics:
  content_interest_profile:
    title: Content Interest Profile
    versions:
      0.1.0: 'content_interest_profile.yaml'
  recommendation_engine:
    title: Recommendation Engine
    versions:
      0.1.0: 'recommendation_engine.yaml'
platform functions:
  org_info:
    title: View Organizational Info
    urlkey: org_info
    versions:
      0.1.0: 'org_info.yaml'
  update_org:
    title: Edit Organizational Info
    urlkey: update_org
    versions:
      0.1.0: 'update_org.yaml'
  user_list:
    title: User List
    urlkey: user_list
    versions:
      0.1.0: 'user_list.yaml'
  user_info:
    title: View User Details
    urlkey: user_info
    versions:
      0.1.0: 'user_info.yaml'
  activate_user:
    title: Activate Users
    urlkey: activate_user
    versions:
      0.1.0: 'activate_user.yaml'
  add_user_to_group:
    title: Add Group To User
    urlkey: add_user_to_group
    versions:
      0.1.0: 'add_user_to_group.yaml'
  delete_user_info:
    title: Delete User
    urlkey: delete_user_info
    versions:
      0.1.0: 'delete_user_info.yaml'
  refresh_api_key:
    title: Refresh API Key
    urlkey: refresh_api_key
    versions:
      0.1.0: 'refresh_api_key.yaml'
  add_user:
    title: Add User
    urlkey: add_user
    versions:
      0.1.0: 'add_user.yaml'
  update_user_info:
    title: Edit User
    urlkey: update_user_info
    versions:
      0.1.0: 'update_user_info.yaml'
  group_info:
    title: View Group Details
    urlkey: group_info
    versions:
      0.1.0: 'group_info.yaml'
  org_group_list:
    title: Group List
    urlkey: org_group_list
    versions:
      0.1.0: 'org_group_list.yaml'
  
  subscribed_microservices:
    title: Subscribed Microservices
    urlkey: subscribed_microservices
    versions:
      0.1.0: 'subscribed_microservices.yaml'
  api_metering:
    title: API Metering
    urlkey: api_metering
    versions:
      0.1.0: 'api_metering.yaml'
  api_metering_error_details:
    title: API Metering Error Details
    urlkey: api_metering_error_details
    versions:
      0.1.0: 'api_metering_error_details.yaml'
  add_function_to_group:
    title: Add Function To Group
    urlkey: add_function_to_group
    versions:
      0.1.0: 'add_function_to_group.yaml'
  remove_function_from_group:
    title: Remove Function From Group
    urlkey: remove_function_from_group
    versions:
      0.1.0: 'remove_function_from_group.yaml'
  subscription:
    title: Subscribe To Microservice
    urlkey: subscription
    versions:
      0.1.0: 'subscription.yaml'
  unsubscription:
    title: Unsubscribe From Microservice
    urlkey: unsubscription
    versions:
      0.1.0: 'unsubscription.yaml'
  add_user_to_function:
    title: Add User To Function
    urlkey: add_user_to_function
    versions:
      0.1.0: 'add_user_to_function.yaml'
  remove_user_from_function:
    title: Remove User From Function
    urlkey: remove_user_from_function
    versions:
      0.1.0: 'remove_user_from_function.yaml'
  delete_group:
    title: Delete Group
    urlkey: delete_group
    versions:
      0.1.0: 'delete_group.yaml'
  get_deleted_user_list:
    title: List Deleted Users
    urlkey: get_deleted_user_list
    versions:
      0.1.0: 'get_deleted_user_list.yaml'
#   get_function_list:
#     title: List Functions
#     urlkey: get_function_list
#     versions:
#       0.1.0: 'get_function_list.yaml' 
  get_org_assign_functions:
    title: Assigned Functions
    urlkey: get_org_assign_functions
    versions:
      0.1.0: 'get_org_assign_functions.yaml'
  microservices_list:
    title: Microservices List
    urlkey: microservices_list
    versions:
      0.1.0: 'microservices_list.yaml'
  update_password:
    title: Update Password
    urlkey: update_password
    versions:
      0.1.0: 'update_password.yaml'
  add_group:
    title: Add Group
    urlkey: add_group
    versions:
      0.1.0: 'add_group.yaml'
  remove_group_from_user:
    title: Remove Group From User
    urlkey: remove_group_from_user
    versions:
      0.1.0: 'remove_group_from_user.yaml'