Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.08 KB

README.md

File metadata and controls

57 lines (36 loc) · 2.08 KB
Raw

Azure Digital Twins Ontology Index

This repository contains a web API which attempts to suggest DTMI models and ontologies for the Azure Digital Twins platform.

Getting Started

In order to run this application locally you will need to populate the following properties in the appsettings.json or appsetttings.Development.json file:

"GitHubToken":"[A GITHUB PAT TOKEN]", "SearchToken":"[A SEARCH TOKEN FROM YOUR AZURE COGNITIVE SEARCH]", "SearchEndpoint":"[THE URL FOR YOUR AZURE COGNITIVE SEARCH]", "WellKnown" { "Ontologies":"[The Github Repository containing the wellknown, (ones which won't be found by search) ontologies in the format owner/repo comma seperated]", }

Deployment

To Deploy the API to Azure you must first follow the steps in the deployment directory.

Once this is done you can deploy the API Container to Azure using the steps below.

  1. Login to your azure container registry

    docker login yourregistry.azurecr.io

  2. Build the API Container

    docker build -f Dockerfile -t yourregistry.azurecr.io/ontology-browser-api:latest .

    Note: Make sure you have navigated to the api directory before running this command.

  3. Push the image to the container registry

    docker push yourregistry.azurecr.io/ontology-browser-api:latest

  4. Set GitHub PAT Token

    Navigate to the Azure App Service for the api, and open the "Configuration" blade. In here you'll find a setting called "GitHubToken" which is a personal access token for your GitHub account. Put in your own PAT Token from GitHub, You can generate a token here.

  5. To access the API, navigate to the following URL:

    https://your-api.azurewebsites.net/swagger

Once deployed the API initiates an ontology index and indexes all ontologies found on Github in the Azure Cognitive Search. This may take a minute or two - you can see the state of the indexes by navigating to the following URL:

```cmd
https://your-api.azurewebsites.net/indexState
```