visiblethread
Module visiblethread
API
Definitions
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_visiblethread_1.5.1.png)
ballerinax/visiblethread Ballerina library
Overview
This is a generated connector from VisibleThread API v1.0 OpenAPI specification.
The VisibleThread API provides services for analyzing or searching documents and web pages.
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![](/images/permalink.svg)
visiblethread: Client![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function getDocs() returns DocumentListSummary[]|error
Get your list of documents
Return Type
- DocumentListSummary[]|error - Successful response
getDocById![](/images/permalink.svg)
function getDocById(int docId) returns DocumentResponseDetailed|error
Get 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![](/images/permalink.svg)
Get your list of dictionaries
getSearchResults![](/images/permalink.svg)
Get your list of searches
runSearch![](/images/permalink.svg)
Run a search
Parameters
- payload Search - Run a search on document docId using dictionarydictId
getSearchResultsById![](/images/permalink.svg)
function getSearchResultsById(int docId, int dictionaryId, boolean matchingOnly) returns Response|error
Gets 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![](/images/permalink.svg)
function getScans() returns ScanResponseSummary[]|error
Get your list of scans
Return Type
- ScanResponseSummary[]|error - Successful response
runScan![](/images/permalink.svg)
function runScan(NewScan payload) returns NewScanResponse|error
Run a new scan
Parameters
- payload NewScan - Scan title and webUrls to analyze
Return Type
- NewScanResponse|error - Successful response
getScanById![](/images/permalink.svg)
function getScanById(int scanId) returns ScanResponseDetailed|error
Get data from a previously run scan
Parameters
- scanId int - Id of scan to fetch
Return Type
- ScanResponseDetailed|error - scan response
getScanUrlById![](/images/permalink.svg)
function getScanUrlById(int scanId, int urlId) returns WebUrlDetail|error
Gets data for a particular scan/webUrl
Return Type
- WebUrlDetail|error - scan response
Records![](/images/permalink.svg)
visiblethread: AdverbsInner![](/images/permalink.svg)
Fields
- 'start int? -
- end int? -
- text string? -
visiblethread: Analysis![](/images/permalink.svg)
Fields
- title string? -
- stats Stats? -
visiblethread: ApiKeysConfig![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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-forwarded
header
- 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![](/images/permalink.svg)
Fields
- id int? -
- name string? -
visiblethread: DocumentResponseDetailed![](/images/permalink.svg)
Fields
- id int? -
- started string? -
- eta string? -
- completed string? -
- title string? -
- stats Stats? -
- scanSettings NewdocumentresponseScansettings? -
- paragraphs DocumentresponsedetailedParagraphs[]? -
visiblethread: DocumentresponsedetailedParagraphs![](/images/permalink.svg)
Fields
- text string? -
- paragraphIndex int? -
- paragraphCounter int? -
- stats DocumentresponsedetailedStats? -
visiblethread: DocumentresponsedetailedStats![](/images/permalink.svg)
Fields
- longSentences LongSentences[]? -
- passives Passives[]? -
- veryLongSentences VeryLongSentences[]? -
- hiddenVerbs HiddenVerbs[]? -
- adverbs Adverbs[]? -
visiblethread: DocumentResponseNotReady![](/images/permalink.svg)
Fields
- id int? -
- started string? -
- eta string? -
visiblethread: HiddenverbsInner![](/images/permalink.svg)
Fields
- 'start int? -
- end int? -
- noun string? -
- text string? -
visiblethread: LongsentencesInner![](/images/permalink.svg)
Fields
- 'start int? -
- end int? -
- wordCount int? -
visiblethread: NewDocumentResponse![](/images/permalink.svg)
Fields
- docId int -
- task string -
- scanSettings NewdocumentresponseScansettings -
visiblethread: NewdocumentresponseScansettings![](/images/permalink.svg)
Fields
- longSentenceWordCount int? -
- veryLongSentenceWordCount int? -
visiblethread: NewScan![](/images/permalink.svg)
Fields
- title string -
- webUrls NewscanWeburls[] -
- scanSettings NewscanScansettings? -
visiblethread: NewScanResponse![](/images/permalink.svg)
Fields
- id int -
- title string -
- webUrls NewscanresponseWeburls[] -
visiblethread: NewscanresponseWeburls![](/images/permalink.svg)
Fields
- url string -
- id int -
visiblethread: NewscanScansettings![](/images/permalink.svg)
Fields
- longSentenceWordCount int? -
- veryLongSentenceWordCount int? -
visiblethread: NewscanWeburls![](/images/permalink.svg)
Fields
- url string -
visiblethread: PassivesInner![](/images/permalink.svg)
Fields
- 'start int? -
- end int? -
- verb string? -
- passivePiece string? -
visiblethread: ProxyConfig![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- title string -
- webUrls WebUrl[] -
- stats Stats -
visiblethread: ScanResponseDetailed![](/images/permalink.svg)
Fields
- id int? -
- started string? -
- eta string? -
- completed string? -
- scan ScanDetailed? -
visiblethread: ScanResponseSummary![](/images/permalink.svg)
Fields
- id int? -
- started string? -
- eta string? -
- completed string? -
- scan ScanSummary? -
visiblethread: ScanSummary![](/images/permalink.svg)
Fields
- title string -
- webUrls WebUrlHeader[] -
visiblethread: Search![](/images/permalink.svg)
Fields
- docId int -
- dictId int -
visiblethread: Stats![](/images/permalink.svg)
Fields
- avgSentenceLength int? -
- fleschReadingLevel int? -
- wordCount int? -
- sentenceCount int? -
- longSentenceCount int? -
- fleschKincaidGradeLevel float? -
- passiveSentenceCount int? -
visiblethread: VerylongsentencesInner![](/images/permalink.svg)
Fields
- 'start int? -
- end int? -
- wordCount int? -
visiblethread: WebResponseNotReady![](/images/permalink.svg)
Fields
- id int? -
- started string? -
- eta string? -
visiblethread: WebUrl![](/images/permalink.svg)
Fields
- Fields Included from *WebUrlHeader
- analysis Analysis -
visiblethread: WebUrlDetail![](/images/permalink.svg)
Fields
- title string -
- url string -
- stats Stats -
- paragraphs DocumentresponsedetailedParagraphs[]? -
visiblethread: WebUrlHeader![](/images/permalink.svg)
Fields
- id int -
- url string -
Import
import ballerinax/visiblethread;
Metadata
Released date: about 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Business Intelligence/Language Analysis
Cost/Paid
Contributors
Dependencies