1.0.1 • Published 1 year ago

tpf-conceptnet-datasource v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

Linked Data Fragments Server - TPF ConceptNet Datasources

npm version

This module contains a Conceptnet datasource for the Linked Data Fragments server. It allows Conceptnet to be used as a data proxy.

This package is a Linked Data Fragments Server module.

Usage in @ldf/server

This package exposes the following config entries:

  • ConceptNetDatasource: A ConceptNet based datasource that requires at least one endpoint field. Should be used as @type value.
  • endpoint: Refers to a ConceptNet endpoint capable of receiving and processing requests. Should be used as key in a ConceptNetDatasource.
  • baseUri: Refers to a base URI that will be prefixed to the results. Should be used as key in a ConceptNetDatasource.
  • languages: Refers to filtering the results by some langagues. Default []. Should be used as key in a ConceptNetDatasource.

Example:

{
  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@ldf/server/^3.0.0/components/context.jsonld",
  "@id": "urn:ldf-server:my",
  "import": "preset-qpf:config-defaults.json",

  "datasources": [
    {
      "@id": "urn:ldf-server:myConceptNetDatasource",
      "@type": "ConceptNetDatasource",
      "datasourceTitle": "My TPF Conceptnet source",
      "description": "My TPF ConceptNet datasource",
      "datasourcePath": "myconceptnet",
      "endpoint": "https://api.conceptnet.io/query", 
      "baseUri": "http://conceptnet.io",
      "languages": ["en"]
    }
  ]
}

Usage in other packages

When this module is used in a package other than @ldf/server, then the ConceptNet context https://linkedsoftwaredependencies.org/contexts/tpf-conceptnet-datasource.jsonld must be imported.

For example:

{
  "@context": [
    "https://linkedsoftwaredependencies.org/bundles/npm/@ldf/core/^3.0.0/components/context.jsonld",
    "https://linkedsoftwaredependencies.org/bundles/npm/@ldf/preset-qpf/^3.0.0/components/context.jsonld",
    "https://linkedsoftwaredependencies.org/bundles/npm/tpf-conceptnet-datasource/^1.0.0/components/context.jsonld",
  ],
  // Same as above...
}

Contributing

See CONTRIBUTING.

License

This module is released under the MIT license.