Code Monkey home page Code Monkey logo

mydig-webservice's Introduction

myDIG Web Service

Configuration File

Fields

Attribute Possible Values Explanation
name alphanumeric and underscore the name of a field, cannot be changed
description text A description of the field
screen_label text The text to display the field in DIG
screen_label_plural text Label when a field contains multiple values
icon see below The icon to decorate the field in DIG
color see below The color used to display the field in DIG
show_as_link entity, text Specifies the appearance of the field: entity shows a link that opens an entity page, text (default) shows the value as a text string (no link)
show_in_facets false, true When true, the field appears in the facets section
show_in_result title, description, detail, header, no Location where the field appears in the results page: title what does this do?, description what does this do?, detail in the accordion, header in the search tile, no not present in the results page
show_in_search false, true When true, the field appears in the query form
glossaries array of glossary names The names of glossaries used to extrace values for the field
search_importance Integer, range(1, 10) High numbers make results matching in a field push documents up in the ranking
type date, email, hyphenated, image, location, phone, string, username Affects the appearance as well as search behavior: date value must be in ISO format, email, hyphenated, image, location must have a DIG key with lat and long, phone, string the default, username
use_in_network_search false, true support network creation using the values from a field
predefined_extractor one of social_media, review_id, posting_date, phone, email, address, TLD, none specifies a default extractor to use for a field
rule_extractor_enabled false, true When true, use the custom rule extractor for this field, if one is defined

Docker image for myDIG

Build image

docker build -t uscisii2/mydig_ws:1.0.0 .

Run container

docker run -p 9879:9879 -p 9880:9880 \
-v $(pwd)/ws/config_docker.py:/app/mydig-webservice/ws/config.py \
-v $(pwd)/../mydig-projects:/shared_data/projects \
uscisii2/mydig_ws:1.0.0

Run container (development)

docker run -it -p 9879:9879 -p 9880:9880 \
--network digetlengine_dig_net \
-v $(pwd):/app/mydig-webservice \
-v $(pwd)/ws/config_docker.py:/app/mydig-webservice/ws/config.py \
-v $(pwd)/../mydig-projects:/shared_data/projects \
uscisii2/mydig_ws:1.0.0 /bin/bash

Search API

Search API document

mydig-webservice's People

Contributors

adityasundaram avatar greatyyx avatar gsharayu avatar jasonslepicka avatar lastmansleeping avatar rqs avatar saggu avatar shrev avatar szeke avatar

Watchers

avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.