Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

servlet(config): add search configuration endpoint #7641

Merged

Conversation

david-leifker
Copy link
Collaborator

@david-leifker david-leifker commented Mar 20, 2023

Create an endpoint in GMS which will return a csv of the search weights for each entity. Useful for debugging search rankings. A few rows are shown below. The endpoint is exposed on GMS as http://localhost:8080/config/search/export?format=csv or the frontend as http://localhost:8080/api/gms/config/search/export?format=csv

entity query_category match_category query_type field_name field_weight search_analyzer case_insensitive query_boost raw
dataset relevancy fulltext SimpleQueryStringBuilder urn 10.0 keyword TRUE 1.0 {  "simple_query_string" : {    "query" : "*",    "fields" : [      "urn^10.0",      "editedDescription^1.0",      "fieldPaths^1.0",      "typeNames^1.0",      "customProperties^1.0",      "qualifiedName^10.0",      "fieldLabels^0.2",      "fieldDescriptions^0.1",      "name^10.0",      "description^1.0",      "editedFieldDescriptions^0.1",      "id^10.0"    ],    "analyzer" : "keyword",    "flags" : -1,    "default_operator" : "and",    "analyze_wildcard" : false,    "auto_generate_synonyms_phrase_query" : true,    "fuzzy_prefix_length" : 0,    "fuzzy_max_expansions" : 50,    "fuzzy_transpositions" : true,    "boost" : 1.0  }}
dataset relevancy fulltext SimpleQueryStringBuilder editedDescription 1.0 keyword TRUE 1.0 {  "simple_query_string" : {    "query" : "*",    "fields" : [      "urn^10.0",      "editedDescription^1.0",      "fieldPaths^1.0",      "typeNames^1.0",      "customProperties^1.0",      "qualifiedName^10.0",      "fieldLabels^0.2",      "fieldDescriptions^0.1",      "name^10.0",      "description^1.0",      "editedFieldDescriptions^0.1",      "id^10.0"    ],    "analyzer" : "keyword",    "flags" : -1,    "default_operator" : "and",    "analyze_wildcard" : false,    "auto_generate_synonyms_phrase_query" : true,    "fuzzy_prefix_length" : 0,    "fuzzy_max_expansions" : 50,    "fuzzy_transpositions" : true,    "boost" : 1.0  }}
dataset relevancy fulltext SimpleQueryStringBuilder fieldPaths 1.0 keyword TRUE 1.0 {  "simple_query_string" : {    "query" : "*",    "fields" : [      "urn^10.0",      "editedDescription^1.0",      "fieldPaths^1.0",      "typeNames^1.0",      "customProperties^1.0",      "qualifiedName^10.0",      "fieldLabels^0.2",      "fieldDescriptions^0.1",      "name^10.0",      "description^1.0",      "editedFieldDescriptions^0.1",      "id^10.0"    ],    "analyzer" : "keyword",    "flags" : -1,    "default_operator" : "and",    "analyze_wildcard" : false,    "auto_generate_synonyms_phrase_query" : true,    "fuzzy_prefix_length" : 0,    "fuzzy_max_expansions" : 50,    "fuzzy_transpositions" : true,    "boost" : 1.0  }}
dataset relevancy fulltext SimpleQueryStringBuilder typeNames 1.0 keyword TRUE 1.0 {  "simple_query_string" : {    "query" : "*",    "fields" : [      "urn^10.0",      "editedDescription^1.0",      "fieldPaths^1.0",      "typeNames^1.0",      "customProperties^1.0",      "qualifiedName^10.0",      "fieldLabels^0.2",      "fieldDescriptions^0.1",      "name^10.0",      "description^1.0",      "editedFieldDescriptions^0.1",      "id^10.0"    ],    "analyzer" : "keyword",    "flags" : -1,    "default_operator" : "and",    "analyze_wildcard" : false,    "auto_generate_synonyms_phrase_query" : true,    "fuzzy_prefix_length" : 0,    "fuzzy_max_expansions" : 50,    "fuzzy_transpositions" : true,    "boost" : 1.0  }}
dataset relevancy fulltext SimpleQueryStringBuilder customProperties 1.0 keyword TRUE 1.0 {  "simple_query_string" : {    "query" : "*",    "fields" : [      "urn^10.0",      "editedDescription^1.0",      "fieldPaths^1.0",      "typeNames^1.0",      "customProperties^1.0",      "qualifiedName^10.0",      "fieldLabels^0.2",      "fieldDescriptions^0.1",      "name^10.0",      "description^1.0",      "editedFieldDescriptions^0.1",      "id^10.0"    ],    "analyzer" : "keyword",    "flags" : -1,    "default_operator" : "and",    "analyze_wildcard" : false,    "auto_generate_synonyms_phrase_query" : true,    "fuzzy_prefix_length" : 0,    "fuzzy_max_expansions" : 50,    "fuzzy_transpositions" : true,    "boost" : 1.0  }}

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions github-actions bot added the devops PR or Issue related to DataHub backend & deployment label Mar 20, 2023
@david-leifker david-leifker marked this pull request as draft March 20, 2023 15:50
@david-leifker
Copy link
Collaborator Author

Pending review of where and how the endpoint should be exposed

@vercel
Copy link

vercel bot commented Apr 4, 2023

Deployment failed with the following error:

The provided GitHub repository does not contain the requested branch or commit reference. Please ensure the repository is not empty.

Copy link
Contributor

@shirshanka shirshanka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@david-leifker david-leifker merged commit 1831b89 into datahub-project:master Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops PR or Issue related to DataHub backend & deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants