Skip to content

simsage/libsimsage

Repository files navigation

Documentation for SimSage REST API

Documentation for API Endpoints

All URIs are relative to https://training.simsage.ai

Class Method HTTP request Description
AuthApi deleteGroup DELETE /api/auth/group/{organisationId}/{name} Delete Group
AuthApi deleteOrganisation DELETE /api/auth/organisation/{organisationId} Delete Organisation
AuthApi getGroups GET /api/auth/groups/{organisationId} Get Groups
AuthApi getOTT PUT /api/auth/ott/{organisationId} Get a one-time token.
AuthApi getUserOrganisationList GET /api/auth/user/organisations/{filter} Get a list of Organisations
AuthApi getUsersPaginated GET /api/auth/users-paginated/{organisationId}/{page}/{pageSize}/{filter} Get Users paginated
AuthApi groupEditInfo POST /api/auth/group-edit-info/{organisationId} Get Group edit information
AuthApi importUsersAndGroups PUT /api/auth/user/import Import users and groups.
AuthApi myRoles GET /api/auth/myroles/{organisationId} Get users application roles
AuthApi removeUserFromOrganisation DELETE /api/auth/organisation/user/{userId}/{organisationId} Remove User from Organisation
AuthApi resetPassword POST /api/auth/reset-password Perform a password-reset request.
AuthApi resetPasswordRequest POST /api/auth/reset-password-request Password Reset Request
AuthApi saveGroup PUT /api/auth/group Save Group
AuthApi signIn POST /api/auth/sign-in Sign In
AuthApi signInAdminUsingJWTMsal GET /api/auth/admin/authenticate/msal JWT MSal Sign In
AuthApi signInAdminUsingSessionId GET /api/auth/admin/authenticate/session-id session-id Sign-in
AuthApi signInDmsUsingJWTMsal GET /api/auth/dms/authenticate/msal/{organisationId} JWT MSal Sign In
AuthApi signInEvolveUsingJWTMsal GET /api/auth/evolve/authenticate/msal/{organisationId} JWT MSal Sign In
AuthApi signInSearchUsingJWTMsal GET /api/auth/search/authenticate/msal/{organisationId} JWT MSal Sign In
AuthApi signOut DELETE /api/auth/sign-out Sign Out
AuthApi updateOrganisation PUT /api/auth/organisation Save Organisation
AuthApi updateUser PUT /api/auth/user/{organisationId} Update or Create a user (save a user).
AuthApi version8 GET /api/auth/version Get Version
BackupApi backup POST /api/backup/backup/{organisationId}/{regime} create backup
BackupApi deleteBackup DELETE /api/backup/backup/{organisationId}/{backupId} remove backup
BackupApi getBackup GET /api/backup/{organisationId}/{backupId} get backup
BackupApi getBackupList GET /api/backup/backups/{organisationId} get backup list
BackupApi restoreFromText POST /api/backup/restore restore backup
ConversionApi previewVersion GET /api/conversion/preview-generator/version Get preview-generator Version
ConversionApi sttVersion GET /api/conversion/stt/version Get speech-to-text Version
ConversionApi version7 GET /api/conversion/version Get Version
CrawlerApi crawlerDeleteFolder POST /api/crawler/external/crawler/delete-folder Delete document folder
CrawlerApi crawlerDeleteUrl POST /api/crawler/external/crawler/delete-url Delete document
CrawlerApi crawlerExternalDocumentDelete PUT /api/crawler/external/document/delete Remove an External Document
CrawlerApi crawlerExternalDocumentFailed POST /api/crawler/external/document/recordfailure Upload External Document
CrawlerApi crawlerExternalDocumentUpload POST /api/crawler/external/document/upload Upload External Document
CrawlerApi crawlerExternalImageUpload POST /api/crawler/external/document/upload/image Upload External Image
CrawlerApi crawlerRenameFolder POST /api/crawler/external/crawler/rename-folder Rename document folder
CrawlerApi crawlerUpdateDeltaToken POST /api/crawler/external/crawler/delta-token Update delta token
CrawlerApi delete DELETE /api/crawler/crawler/{organisationId}/{kbId}/{sourceId} Delete source
CrawlerApi deleteDocuments DELETE /api/crawler/crawler/document/{organisationId}/{kbId}/{sourceId} Delete source's documents
CrawlerApi encryptedCommunications POST /api/crawler/external/secure/{seed} Secure Communication
CrawlerApi externalCrawler POST /api/crawler/external/crawler External Crawler
CrawlerApi externalCrawlerFinished POST /api/crawler/external/crawler/finish Stop External Crawler
CrawlerApi externalCrawlerStart POST /api/crawler/external/crawler/start Start External Crawler
CrawlerApi getCrawler GET /api/crawler/crawler/{organisationId}/{kbId}/{sourceId} Get source
CrawlerApi getFailedDocuments GET /api/crawler/faileddocs/{organisationId}/{kbId}/{sourceId}/{page}/{pageSize} Get source List
CrawlerApi getSourceList GET /api/crawler/crawlers/{organisationId}/{kbId} Get source List
CrawlerApi markCrawlAsDeltaReset POST /api/crawler/external/crawler/mark-as-reset Update delta token
CrawlerApi markFileAsSeen POST /api/crawler/external/crawler/mark-file-as-seen Mark file as seen
CrawlerApi oidcCode GET /api/crawler/dropbox-oidc-code/{oidcKey} OIDC code receiver
CrawlerApi processAllFiles POST /api/crawler/process-all-files Process all files of crawler/source
CrawlerApi processorSchema GET /api/crawler/processor_schema
CrawlerApi receiveExternalLogEntry POST /api/crawler/external/crawler/log External Crawler log-entry
CrawlerApi resetSourceDelta POST /api/crawler/crawler/reset-delta/{organisationId}/{kbId}/{sourceId} Reset Source delta-token
CrawlerApi sdcSchema GET /api/crawler/sdc_schema
CrawlerApi startCrawler POST /api/crawler/start Start crawler
CrawlerApi sync POST /api/crawler/syncgdrivegroups
CrawlerApi testCrawler GET /api/crawler/crawler/test/{organisationId}/{kbId}/{sourceId} Test Crawler
CrawlerApi updateCrawler POST /api/crawler/crawler Update Source
CrawlerApi version6 GET /api/crawler/version Version
DataprojectApi addComment POST /api/dataproject/comment Create Comment
DataprojectApi allTasks POST /api/dataproject/runningprojects get Running Projects
DataprojectApi changeTaskPhase POST /api/dataproject/changetaskphase Change Task Phase
DataprojectApi claimDocument POST /api/dataproject/claimdocument Claim sliced document
DataprojectApi crawlerStatus GET /api/dataproject/crawlerstatus/{organisationId}/{taskId} get Crawler Status
DataprojectApi documentsByTokens POST /api/dataproject/documentsbytokens Returns document list for tokens
DataprojectApi filteredComments POST /api/dataproject/filteredcomments Retrieve Comments
DataprojectApi getDocumentRedactionInfo GET /api/dataproject/docredactioninfo/{organisationId}/{sliceId}/{documentKey} Get Document Redaction info
DataprojectApi getProjectDefinition GET /api/dataproject/projectdefinition/{organisationId}/{taskId} get Project Definition
DataprojectApi getProjectReview GET /api/dataproject/projectreview/{organisationId}/{projectId} get Project Definition
DataprojectApi getProjectSlice GET /api/dataproject/projectslice/{organisationId}/{taskId} get project slice
DataprojectApi getSearchResultSummary GET /api/dataproject/searchresult/{organisationId}/{taskId} get Search Result Summary
DataprojectApi getSearchResultSummaryForReview GET /api/dataproject/searchresultreview/{organisationId}/{projectId} get Search Result Summary
DataprojectApi nextDocument POST /api/dataproject/nextdocument Document list for given slice and filters
DataprojectApi pdfBinary GET /api/dataproject/pdf/latest/{organisationId}/{kbId}/{url} Binary
DataprojectApi projectTypes GET /api/dataproject/projects/{organisationId} get Project Types
DataprojectApi reassignSliceDocument POST /api/dataproject/reassignslicedoc
DataprojectApi redactedDocument POST /api/dataproject/redacteddocument Get Redacted Document
DataprojectApi removeSliceDocument POST /api/dataproject/removeslicedoc
DataprojectApi resetEvolve POST /api/dataproject/reset/{organisationId} Reset Evolve Application
DataprojectApi saveProjectDefinition POST /api/dataproject/saveprojectdefinition Inserts/Updates a project definition
DataprojectApi setSliceConfig POST /api/dataproject/setsliceconfig Set Slice configuration
DataprojectApi slicedDocuments POST /api/dataproject/sliceddocuments Document list for given slice and filters
DataprojectApi startProject POST /api/dataproject/startproject
DataprojectApi updateDocumentStatus POST /api/dataproject/updatedocstatus Update document status
DataprojectApi updateRedactions POST /api/dataproject/updateredactions Update document redactions
DiscoveryApi allGdprProjects GET /api/discovery/gdprproject/{organisationId}/{kbId}/{page}/{pageSize}/{textFilter}/{statusFilter}/{sortColumn}/{sortDirection}
DiscoveryApi applyRedactions POST /api/discovery/applyredactions
DiscoveryApi createGdprProject POST /api/discovery/createproject
DiscoveryApi deleteProject DELETE /api/discovery/deleteproject
DiscoveryApi exportRedactedDoc POST /api/discovery/exportredacteddoc
DiscoveryApi getGdprDocument GET /api/discovery/gdprdocument/{organisationId}/{kbId}/{projectId}/{url}
DiscoveryApi getPagedProjectDocuments GET /api/discovery/projectdocument/{organisationId}/{kbId}/{projectId}/{page}/{pageSize}/{textFilter}/{typeFilter}/{statusFilter}/{sortColumn}/{sortDirection}
DiscoveryApi growthPerMonth GET /api/discovery/growth/{organisationId}/{kbId} growth
DiscoveryApi setdocumentredactions PUT /api/discovery/updategdprdocument
DiscoveryApi storageBySource GET /api/discovery/storage/{organisationId}/{kbId} storage
DiscoveryApi summaryByDocumentType GET /api/discovery/doctypesummary/{organisationId}/{kbId} storage
DiscoveryApi updateDocumentSet POST /api/discovery/updatedocumentset
DiscoveryApi version5 GET /api/discovery/version Version
DmsApi addFolder POST /api/dms/folder Add a new folder
DmsApi addSourceFolder POST /api/dms/source Add a new source-folder
DmsApi deleteAllNotes DELETE /api/dms/note/{organisationId}/{kbId}/{url} delete all Notes
DmsApi deleteBookmark DELETE /api/dms/bookmark/{organisationId}/{kbId}/{userId}/{url} Delete a Bookmark
DmsApi deleteDocumentOrFolder DELETE /api/dms/document/delete/{organisationId}/{kbId}/{isFolder}/{sourceId}/{url}/{folderId} Delete a document or a folder
DmsApi deleteNote DELETE /api/dms/note/{organisationId}/{kbId}/{url}/{noteId} Delete a Note
DmsApi deleteSourceFolder DELETE /api/dms/source/{organisationId}/{kbId}/{sourceId} Remove source-folder
DmsApi deleteSubscription DELETE /api/dms/subscription/{organisationId}/{kbId}/{userId}/{url} Delete a Subscription
DmsApi deleteUserSearch DELETE /api/dms/saved-search/{organisationId}/{kbId}/{userId}/{text}/{top} Delete a Saved Search
DmsApi document1 GET /api/dms/document/{organisationId}/{kbId}/{urlId} Get Document
DmsApi documentBinary GET /api/dms/binary/latest/{organisationId}/{kbId}/{url} Binary
DmsApi documentVersion GET /api/dms/binary/{organisationId}/{kbId}/{url}/{version} Get Binary Document
DmsApi filterFolders GET /api/dms/folder/filter/{organisationId}/{kbId}/{text} Filter Folders
DmsApi forceReleaseLock DELETE /api/dms/lock/release/{organisationId}/{kbId}/{userId}/{url} Force-release a lock
DmsApi getBookmarkList GET /api/dms/bookmark/{organisationId}/{kbId}/{userId} Get Bookmarks
DmsApi getDeletedDocuments GET /api/dms/deleted/{organisationId}/{kbId}/{filter} Deleted records with optional filter
DmsApi getDocumentAudit GET /api/dms/audit/{organisationId}/{kbId}/{year}/{month}/{url} Audit records for a document for a month
DmsApi getFolder GET /api/dms/folder/{organisationId}/{kbId}/{sourceId}/{folderId}/{prevUrl}/{pageSize} Get Folder Content
DmsApi getFullAudit GET /api/dms/audit/{organisationId}/{kbId}/{year}/{month} Audit records for a month
DmsApi getLockedList GET /api/dms/lock/{organisationId}/{kbId}/{userId} Get locked documents for user
DmsApi getNoteList GET /api/dms/note/{organisationId}/{kbId}/{url} Get Notes
DmsApi getSavedSearches GET /api/dms/saved-searches/{organisationId}/{kbId}/{userId}/{top} User's saved searches
DmsApi getSourceFolder GET /api/dms/source/{organisationId}/{kbId}/{sourceId} Get source-folder
DmsApi getSubscriptionList GET /api/dms/subscriptions/{organisationId}/{kbId}/{userId} Get Subscriptions
DmsApi getUserDashboard GET /api/dms/dashboard/{organisationId}/{kbId} User Dashboard
DmsApi getUserNotifications GET /api/dms/notifications/{organisationId}/{kbId}/{year}/{month} Get User Notifications
DmsApi lockDocument POST /api/dms/lock Document Lock
DmsApi releaseLock DELETE /api/dms/lock/{organisationId}/{kbId}/{userId}/{url} Release a lock
DmsApi restfulDMSClientQuery POST /api/dms/query DMS Client Query
DmsApi saveBookmark POST /api/dms/bookmark Save Bookmark
DmsApi saveHashTags POST /api/dms/hash-tag Save HashTag set for a document
DmsApi saveNote POST /api/dms/note Save Note
DmsApi saveSearch POST /api/dms/save-search Save Search
DmsApi saveSubscription POST /api/dms/subscription Save Subscription
DmsApi undeleteDocument DELETE /api/dms/un-delete/{organisationId}/{kbId}/{sourceId}/{url}/{filter} un-delete a record
DmsApi updateACLs POST /api/dms/acls Update an item's ACLs
DmsApi uploadDocument POST /api/dms/upload/document/{organisationId}/{kbId}/{sourceId}/{folderId}/{lastModified} Upload a Document
DocumentApi document GET /api/document/document/{organisationId}/{kbId}/{url} get Document
DocumentApi getParquetFile POST /api/document/parquet/{organisationId}/{kbId}/{dateTime} Download Parquet File
DocumentApi getParquetList GET /api/document/parquets/{organisationId}/{kbId}/{page}/{pageSize} Parquet available time list
DocumentApi getSpreadsheet POST /api/document/spreadsheet/{organisationId}/{kbId}/{dateTime} Inventory breakdown Spreadsheet
DocumentApi getStats1 GET /api/document/stats/frequencies/{organisationId}/{kbId}/{dateTime} Document Frequency Statistics
DocumentApi inventorizeDocuments POST /api/document/inventorize Document Inventory
DocumentApi inventorizeIndexes POST /api/document/inventorize-indexes Index Inventory
DocumentApi preview GET /api/document/preview/{organisationId}/{kbId}/{clientId}/{sessionId}/{urlId}/{page} get Preview
DocumentApi previewHtml POST /api/document/preview/html Preview HTML
DocumentApi queryFocussedSummarization POST /api/document/qfs Summarize Documents for Query
DocumentApi removeDocument DELETE /api/document/document/{organisationId}/{kbId}/{url}/{sourceId} Remove Document
DocumentApi removeParquetFile DELETE /api/document/parquet/{organisationId}/{kbId}/{dateTime} Delete Parquet File
DocumentApi summarizeDocument POST /api/document/summarize/document Summarize a document
DocumentApi version4 GET /api/document/version Version
KnowledgebaseApi exportKnowledgeBase POST /api/knowledgebase/export export Knowledge-base
KnowledgebaseApi getKnowledgeBase GET /api/knowledgebase/{organisationId}/{kbId} Get Knowledge-base
KnowledgebaseApi getKnowledgeBases GET /api/knowledgebase/{organisationId} Get Knowledge-bases
KnowledgebaseApi getSearchInfo GET /api/knowledgebase/search/info/{organisationId}/{clientId} Search Info
KnowledgebaseApi getSearchInfo2 GET /api/knowledgebase/search/info/{organisationId} Search Info [deprecated]
KnowledgebaseApi removeKnowledgeBase DELETE /api/knowledgebase/{organisationId}/{kbId} Delete Knowledge-base
KnowledgebaseApi updateKnowledgeBase PUT /api/knowledgebase/save Save Knowledge-base
KnowledgebaseApi version3 GET /api/knowledgebase/version Version
LanguageApi addDefaultSynSets PUT /api/language/default-syn-sets/{organisationId}/{kbId} Add all default SynSets
LanguageApi deleteAllSynonyms DELETE /api/language/delete-all-synonyms/{organisationId}/{kbId} Delete All Synonyms
LanguageApi deleteCategorization DELETE /api/language/categorization/{organisationId}/{kbId}/{categorizationLabel} remove categorization
LanguageApi deleteSemantic DELETE /api/language/delete-semantic/{organisationId}/{kbId}/{word}/{semantic} Delete Semantic
LanguageApi deleteSynSet DELETE /api/language/delete-syn-set/{organisationId}/{kbId}/{lemma} Delete SynSet
LanguageApi deleteSynonym DELETE /api/language/delete-synonym/{organisationId}/{kbId}/{id} Delete Synonym
LanguageApi findSynSets PUT /api/language/find-syn-sets Find SynSets
LanguageApi getCategorizationList GET /api/language/categorization/{organisationId}/{kbId}/{prevCategorizationLabel}/{pageSize} categorization list
LanguageApi getPaginated PUT /api/language/synonyms get Synonyms Paginated
LanguageApi getSemanticsPaginated PUT /api/language/semantics Semantics Paginated
LanguageApi optimizeIndexes PUT /api/language/optimize-indexes Optimize Indexes
LanguageApi optimizeIndexesAbort PUT /api/language/optimize-indexes-abort Abort Index Optimization
LanguageApi redactDocument GET /api/language/redact/{organisationId}/{kbId}/{url}/{entityCsv}/{wordCsv}/{allowWordsCsv} Redact Document
LanguageApi saveCategorization PUT /api/language/categorization save categorization
LanguageApi saveSemantic PUT /api/language/save-semantic/{organisationId}/{kbId} Save Semantic
LanguageApi saveSynSet PUT /api/language/save-syn-set/{organisationId}/{kbId} Save SynSet
LanguageApi saveSynonym PUT /api/language/save-synonym/{organisationId}/{kbId} Save Synonym
LanguageApi tuneLanguageGraph GET /api/language/tune-graph/{organisationId}/{kbId} Tune Graph
LanguageApi version2 GET /api/language/version Version
SemanticApi deleteTextToSearch DELETE /api/semantic/text-to-search/{organisationId}/{kbId}/{word} Delete text-to-search
SemanticApi documentQuestionAndAnswer POST /api/semantic/document-qa Document Q&A
SemanticApi getTextToSearchPaginated PUT /api/semantic/text-to-search Text to Search mappings
SemanticApi restfulClientQuery POST /api/semantic/query Client Query
SemanticApi saveTextToSearch PUT /api/semantic/text-to-search/{organisationId}/{kbId} Save a text-to-search item
SemanticApi shortSummary POST /api/semantic/short-summary Short summary
SemanticApi tryTextToSearchConversion PUT /api/semantic/text-to-search-try try converting text-to-search
SemanticApi version1 GET /api/semantic/version Version
StatsApi getIndexOptimizationReport GET /api/stats/report/{organisationId}/{kbId}/{id} get an optimization report
StatsApi getIndexOptimizationReports GET /api/stats/reports/{organisationId}/{kbId} get optimization report list
StatsApi getStats GET /api/stats/stats/{organisationId}/{kbId}/{year}/{month}/{top} Get usage Statistics
StatsApi simSageStatus PUT /api/stats/status/{organisationId} SimSage status
StatsApi systemLogs GET /api/stats/system-logs/{organisationId}/{service}/{numLines} System Logs
StatsApi version GET /api/stats/version Version

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

About

SimSage libraries for accessing the SimSAge API

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors