Ballerina library

automata

Module automata

OverviewPrerequisites

API

Client

Definitions

ApiKeysConfig
Article
ClientHttp1Settings
ConnectionConfig
ContentProCompany
ContentProSnippets
ContentSearchResponse
InputCompany
ProxyConfig
SearchResponse
SimilarCompany
SimilarCompanyResponse
SimilarCompanySearch
SimilarTextResponse
SimilartextresponseData
Snippet

ballerinax/automata Ballerina library

1.5.1

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:

  1. Obtain tokens - Follow this guide.

Clients

automata: Client

Isolated

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

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)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://api.byautomata.io/" - URL of the target service

getSimilar

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

searchSimilarText

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

searchContent

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

Records

automata: ApiKeysConfig

Closed record

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

Fields

automata: 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

automata: 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

automata: ContentProCompany

Fields

automata: ContentProSnippets

Fields

automata: ContentSearchResponse

Fields

automata: InputCompany

Fields

automata: 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

automata: SearchResponse

Fields

automata: SimilarCompany

Fields

automata: SimilarCompanyResponse

Fields

automata: SimilarCompanySearch

Fields

automata: SimilarTextResponse

Fields

automata: SimilartextresponseData

Fields

automata: Snippet

Fields

Import

import ballerinax/automata;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/Analytics

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