automata
Module automata
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_automata_1.5.1.png)
ballerinax/automata Ballerina library
Overview
This is a generated connector for Automata API v1.0.1 OpenAPI specification.
The Automata API provides the capability to identify the market intelligence.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Obtain tokens - Follow this guide.
Clients![](/images/permalink.svg)
automata: Client![](/images/permalink.svg)
This is a generated connector for Automata API v1.0.1 OpenAPI specification. The Automata API provides the capability to identify the market intelligence.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Obtain tokens by following this guide.
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.byautomata.io/" - URL of the target service
getSimilar![](/images/permalink.svg)
function getSimilar(string link, string page) returns SimilarCompanyResponse|error
Send a company website to receive a list of companies related to them.
Parameters
- link string - We'll provide information about related companies based on the site you provide. If a LinkedIn page is sent, we will try to identify the company related to the page. Ex. https://api.byautomata.io/similar?link=ibm.com
- page string (default "0") - Page number of search results. Ex. https://api.byautomata.io/similar?link=ibm.com&page=1
Return Type
- SimilarCompanyResponse|error - A successful operation
search![](/images/permalink.svg)
function search(string terms, string page) returns SearchResponse|error
Send search terms to receive the most relevant companies along with text snippets.
Parameters
- terms string - We provide information about related companies based on the search terms you provide. Separate search terms with commas. Ex. https://api.byautomata.io/search?link=cloud+computing,enterprise,security
- page string (default "0") - Page number of search results. Ex. https://api.byautomata.io/search?page=0&link=cloud+computing,enterprise,security
Return Type
- SearchResponse|error - A successful operation
searchSimilarText![](/images/permalink.svg)
function searchSimilarText() returns SimilarTextResponse|error
The /contentpro-similar-text endpoint accepts and arbitrary piece of text and returns similar articles and blogs written by companies.
Return Type
- SimilarTextResponse|error - A successful operation
searchContent![](/images/permalink.svg)
function searchContent(string terms) returns ContentSearchResponse|error
Send search terms to receive the most relevant articles and companies.
Parameters
- terms string - We provide information about related companies and articles based on the search terms you provide. Separate search terms with commas. Ex. https://api.byautomata.io/contentpro-search?terms=cloud+computing,enterprise,security
Return Type
- ContentSearchResponse|error - A successful operation
Records![](/images/permalink.svg)
automata: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - All Automata API endpoints require an API key distributed by Automata. Retrieve an API key at https://apis.byautomata.io for the /similar and /search endpoints. The ContentPro API endpoints are not included in the standard Market Intelligence API plans. Contact support@byautomata.io for access.
automata: Article![](/images/permalink.svg)
Fields
- title string? -
- pubdate string? -
- link string? -
automata: 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
automata: 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
automata: ContentProCompany![](/images/permalink.svg)
Fields
- companyName string? -
- website string? -
- employee string? -
- industry string? -
- description string? -
- linkedin string? -
- twitter string? -
automata: ContentProSnippets![](/images/permalink.svg)
Fields
- description string[]? -
- text string[]? -
- title string[]? -
automata: ContentSearchResponse![](/images/permalink.svg)
Fields
- data SimilartextresponseData[]? -
- count_remaining string? -
- calls_per_month string? -
- renewal_date string? -
automata: InputCompany![](/images/permalink.svg)
Fields
- companyName string? -
- country string? -
- website string? -
- employee string? -
- industry string? -
- linkedin string? -
- twitter string? -
automata: 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
automata: SearchResponse![](/images/permalink.svg)
Fields
- companies SimilarCompanySearch[]? -
- count_remaining string? -
- calls_per_month string? -
- renewal_date string? -
automata: SimilarCompany![](/images/permalink.svg)
Fields
- companyName string? -
- website string? -
- employee string? -
- industry string? -
- description string? -
- title string? -
- linkedin string? -
- twitter string? -
automata: SimilarCompanyResponse![](/images/permalink.svg)
Fields
- companies SimilarCompany[]? -
- input_company InputCompany? -
- count_remaining string? -
- calls_per_month string? -
- renewal_date string? -
automata: SimilarCompanySearch![](/images/permalink.svg)
Fields
- companyName string? -
- website string? -
- employee string? -
- industry string? -
- description string? -
- title string? -
- linkedin string? -
- twitter string? -
- snippets Snippet[]? -
automata: SimilarTextResponse![](/images/permalink.svg)
Fields
- data SimilartextresponseData[]? -
- count_remaining string? -
- calls_per_month string? -
- renewal_date string? -
automata: SimilartextresponseData![](/images/permalink.svg)
Fields
- article Article? -
- company ContentProCompany? -
- snippets ContentProSnippets? -
automata: Snippet![](/images/permalink.svg)
Fields
- description string[]? -
- text string[]? -
- title string[]? -
Import
import ballerinax/automata;
Metadata
Released date: over 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: 1
Current verison: 0
Weekly downloads
Keywords
Business Intelligence/Analytics
Cost/Paid
Contributors
Dependencies