Ballerina library

visiblethread

Module visiblethread

OverviewPrerequisites

API

Client

Definitions

AdverbsInner
Analysis
ApiKeysConfig
ClientHttp1Settings
ConnectionConfig
DocumentListSummary
DocumentResponseDetailed
DocumentresponsedetailedParagraphs
DocumentresponsedetailedStats
DocumentResponseNotReady
HiddenverbsInner
LongsentencesInner
NewDocumentResponse
NewdocumentresponseScansettings
NewScan
NewScanResponse
NewscanresponseWeburls
NewscanScansettings
NewscanWeburls
PassivesInner
ProxyConfig
ScanDetailed
ScanResponseDetailed
ScanResponseSummary
ScanSummary
SearchStats
VerylongsentencesInner
WebResponseNotReady
WebUrl
WebUrlDetail
WebUrlHeader

ballerinax/visiblethread Ballerina library

1.5.1

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:

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)
  • 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[]|error

Get your list of documents

Return Type

getDocById

Isolated FunctionRemote Function
function getDocById(int docId) returns DocumentResponseDetailed|error

Get data from a previously submitted document

Parameters
  • docId int - Id of document to fetch
Return Type

getDictionaries

Isolated FunctionRemote Function
function getDictionaries() returns Response|error

Get your list of dictionaries

Return Type

getSearchResults

Isolated FunctionRemote Function
function getSearchResults() returns Response|error

Get your list of searches

Return Type

runSearch

Isolated FunctionRemote Function
function runSearch(Search payload) returns string|error

Run a search

Parameters
  • payload Search - Run a search on document docId using dictionarydictId
Return Type

getSearchResultsById

Isolated FunctionRemote Function
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
Return Type

getScans

Isolated FunctionRemote Function
function getScans() returns ScanResponseSummary[]|error

Get your list of scans

Return Type

runScan

Isolated FunctionRemote Function
function runScan(NewScan payload) returns NewScanResponse|error

Run a new scan

Parameters
  • payload NewScan - Scan title and webUrls to analyze
Return Type

getScanById

Isolated FunctionRemote Function
function getScanById(int scanId) returns ScanResponseDetailed|error

Get data from a previously run scan

Parameters
  • scanId int - Id of scan to fetch
Return Type

getScanUrlById

Isolated FunctionRemote Function
function getScanUrlById(int scanId, int urlId) returns WebUrlDetail|error

Gets data for a particular scan/webUrl

Parameters
  • scanId int - Id of scan
  • urlId int - Id of url to fetch
Return Type

Records

visiblethread: AdverbsInner

Fields

visiblethread: Analysis

Fields

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

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
  • 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
  • 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
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

visiblethread: DocumentListSummary

Fields

visiblethread: DocumentResponseDetailed

Fields

visiblethread: DocumentresponsedetailedParagraphs

Fields
  • paragraphIndex int? -
  • paragraphCounter int? -

visiblethread: DocumentresponsedetailedStats

Fields
  • longSentences LongSentences[]? -
  • passives Passives[]? -
  • veryLongSentences VeryLongSentences[]? -
  • hiddenVerbs HiddenVerbs[]? -
  • adverbs Adverbs[]? -

visiblethread: DocumentResponseNotReady

Fields

visiblethread: HiddenverbsInner

Fields

visiblethread: LongsentencesInner

Fields
  • wordCount int? -

visiblethread: NewDocumentResponse

Fields

visiblethread: NewdocumentresponseScansettings

Fields
  • longSentenceWordCount int? -
  • veryLongSentenceWordCount int? -

visiblethread: NewScan

Fields

visiblethread: NewScanResponse

Fields

visiblethread: NewscanresponseWeburls

Fields

visiblethread: NewscanScansettings

Fields
  • longSentenceWordCount int? -
  • veryLongSentenceWordCount int? -

visiblethread: NewscanWeburls

Fields

visiblethread: PassivesInner

Fields

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

visiblethread: ScanResponseDetailed

Fields

visiblethread: ScanResponseSummary

Fields

visiblethread: ScanSummary

Fields
Fields

visiblethread: Stats

Fields
  • avgSentenceLength int? -
  • fleschReadingLevel int? -
  • wordCount int? -
  • sentenceCount int? -
  • longSentenceCount int? -
  • fleschKincaidGradeLevel float? -
  • passiveSentenceCount int? -

visiblethread: VerylongsentencesInner

Fields
  • wordCount int? -

visiblethread: WebResponseNotReady

Fields

visiblethread: WebUrl

Fields

visiblethread: WebUrlDetail

Fields

visiblethread: WebUrlHeader

Fields

Import

import ballerinax/visiblethread;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 0

Weekly downloads

Source repository

Keywords

Business Intelligence/Language Analysis

Cost/Paid

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC