Module visiblethread
ballerinax/visiblethread Ballerina library
1.5.2
Overview
The VisibleThread API v1.0 connector(https://api.visiblethread.com/example/index.html) OpenAPI specification.
The VisibleThread API provides services for analyzing or searching documents and web pages.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Visible Thread account
- Obtain API key by contacting support@visiblethread.com
Clients
visiblethread: Client
Isolated
This is a generated connector for VisibleThread API v1.0 OpenAPI specification. The VisibleThread API provides services for analyzing or searching documents and web pages.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Contact support@visiblethread.com to request an API key.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.visiblethread.com/api/v1" - URL of the target service
getDocs
Isolated FunctionRemote Function
function getDocs() returns DocumentListSummary[]|errorGet your list of documents
Return Type
- DocumentListSummary[]|error - Successful response
getDocById
Isolated FunctionRemote Function
function getDocById(int docId) returns DocumentResponseDetailed|errorGet data from a previously submitted document
Parameters
- docId int - Id of document to fetch
Return Type
- DocumentResponseDetailed|error - document response contained readability details for the document
getDictionaries
Isolated FunctionRemote Function
Get your list of dictionaries
getSearchResults
Isolated FunctionRemote Function
Get your list of searches
runSearch
Isolated FunctionRemote Function
Run a search
Parameters
- payload Search - Run a search on document docId using dictionarydictId
getSearchResultsById
Isolated FunctionRemote Function
function getSearchResultsById(int docId, int dictionaryId, boolean matchingOnly) returns Response|errorGets search results for a particular document/dictionary
Parameters
- docId int - Id of document
- dictionaryId int - Id of dictionary
- matchingOnly boolean - Only returning paragraphs containing a match
getScans
Isolated FunctionRemote Function
function getScans() returns ScanResponseSummary[]|errorGet your list of scans
Return Type
- ScanResponseSummary[]|error - Successful response
runScan
Isolated FunctionRemote Function
function runScan(NewScan payload) returns NewScanResponse|errorRun a new scan
Parameters
- payload NewScan - Scan title and webUrls to analyze
Return Type
- NewScanResponse|error - Successful response
getScanById
Isolated FunctionRemote Function
function getScanById(int scanId) returns ScanResponseDetailed|errorGet data from a previously run scan
Parameters
- scanId int - Id of scan to fetch
Return Type
- ScanResponseDetailed|error - scan response
getScanUrlById
Isolated FunctionRemote Function
function getScanUrlById(int scanId, int urlId) returns WebUrlDetail|errorGets data for a particular scan/webUrl
Return Type
- WebUrlDetail|error - scan response
Records
visiblethread: AdverbsInner
Fields
- 'start? int -
- end? int -
- text? string -
visiblethread: Analysis
Fields
- title? string -
- stats? Stats -
visiblethread: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- apiKey string - All requests on the VisibleThread API needs to include an API key. The API key can be provided as part of the query string or as a request header. The name of the API key needs to be
apiKey
visiblethread: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
visiblethread: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
visiblethread: DocumentListSummary
Fields
- id? int -
- name? string -
visiblethread: DocumentResponseDetailed
Fields
- id? int -
- started? string -
- eta? string -
- completed? string -
- title? string -
- stats? Stats -
- scanSettings? NewdocumentresponseScansettings -
- paragraphs? DocumentresponsedetailedParagraphs[] -
visiblethread: DocumentresponsedetailedParagraphs
Fields
- text? string -
- paragraphIndex? int -
- paragraphCounter? int -
- stats? DocumentresponsedetailedStats -
visiblethread: DocumentresponsedetailedStats
Fields
- longSentences? LongSentences[] -
- passives? Passives[] -
- veryLongSentences? VeryLongSentences[] -
- adverbs? Adverbs[] -
visiblethread: DocumentResponseNotReady
Fields
- id? int -
- started? string -
- eta? string -
visiblethread: HiddenverbsInner
Fields
- 'start? int -
- end? int -
- noun? string -
- text? string -
visiblethread: LongsentencesInner
Fields
- 'start? int -
- end? int -
- wordCount? int -
visiblethread: NewDocumentResponse
Fields
- docId int -
- task string -
- scanSettings NewdocumentresponseScansettings -
visiblethread: NewdocumentresponseScansettings
Fields
- longSentenceWordCount? int -
- veryLongSentenceWordCount? int -
visiblethread: NewScan
Fields
- title string -
- webUrls NewscanWeburls[] -
- scanSettings? NewscanScansettings -
visiblethread: NewScanResponse
Fields
- id int -
- title string -
- webUrls NewscanresponseWeburls[] -
visiblethread: NewscanresponseWeburls
Fields
- url string -
- id int -
visiblethread: NewscanScansettings
Fields
- longSentenceWordCount? int -
- veryLongSentenceWordCount? int -
visiblethread: NewscanWeburls
Fields
- url string -
visiblethread: PassivesInner
Fields
- 'start? int -
- end? int -
- verb? string -
- passivePiece? string -
visiblethread: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
visiblethread: ScanDetailed
Fields
- title string -
- webUrls WebUrl[] -
- stats Stats -
visiblethread: ScanResponseDetailed
Fields
- id? int -
- started? string -
- eta? string -
- completed? string -
- scan? ScanDetailed -
visiblethread: ScanResponseSummary
Fields
- id? int -
- started? string -
- eta? string -
- completed? string -
- scan? ScanSummary -
visiblethread: ScanSummary
Fields
- title string -
- webUrls WebUrlHeader[] -
visiblethread: Search
Fields
- docId int -
- dictId int -
visiblethread: Stats
Fields
- avgSentenceLength? int -
- fleschReadingLevel? int -
- wordCount? int -
- sentenceCount? int -
- longSentenceCount? int -
- fleschKincaidGradeLevel? float -
- passiveSentenceCount? int -
visiblethread: VerylongsentencesInner
Fields
- 'start? int -
- end? int -
- wordCount? int -
visiblethread: WebResponseNotReady
Fields
- id? int -
- started? string -
- eta? string -
visiblethread: WebUrl
Fields
- Fields Included from *WebUrlHeader
- analysis Analysis -
visiblethread: WebUrlDetail
Fields
- title string -
- url string -
- stats Stats -
- paragraphs? DocumentresponsedetailedParagraphs[] -
visiblethread: WebUrlHeader
Fields
- id int -
- url string -
Array types
visiblethread: DocumentListSummaryArr
DocumentListSummaryArr
visiblethread: ScanResponseSummaryArr
ScanResponseSummaryArr
visiblethread: Passives
Passives
visiblethread: HiddenVerbs
HiddenVerbs
visiblethread: LongSentences
LongSentences
visiblethread: VeryLongSentences
VeryLongSentences
visiblethread: Adverbs
Adverbs