{"id":18723804,"url":"https://github.com/hscells/elasticsearch-similarity-plugin-stub","last_synced_at":"2025-08-03T16:38:11.010Z","repository":{"id":90190197,"uuid":"87512718","full_name":"hscells/elasticsearch-similarity-plugin-stub","owner":"hscells","description":"Template for adding a new similarity measure to elasticsearch ","archived":false,"fork":false,"pushed_at":"2017-04-09T23:52:29.000Z","size":53,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-28T12:43:22.617Z","etag":null,"topics":["elasticsearch","elasticsearch-plugin","similarity"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hscells.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-07T06:29:23.000Z","updated_at":"2021-07-13T11:45:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"d643bb13-334d-4fcd-bf6f-6b10bdce818b","html_url":"https://github.com/hscells/elasticsearch-similarity-plugin-stub","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hscells%2Felasticsearch-similarity-plugin-stub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hscells%2Felasticsearch-similarity-plugin-stub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hscells%2Felasticsearch-similarity-plugin-stub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hscells%2Felasticsearch-similarity-plugin-stub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hscells","download_url":"https://codeload.github.com/hscells/elasticsearch-similarity-plugin-stub/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239590627,"owners_count":19664524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elasticsearch","elasticsearch-plugin","similarity"],"created_at":"2024-11-07T13:51:39.562Z","updated_at":"2025-02-19T03:28:18.966Z","avatar_url":"https://github.com/hscells.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Elasticsearch Plugin Stub\n\nThese project files document how to create a custom similarity scoring plugin for elasticsearch.\n\nFirst of all, you need to define an `ES_PATH` environment variable. If you installed elasticsearch through \n`brew`, you can find this out using `brew list elasticsearch`:\n\n```bash\nexport ES_PATH=/usr/local/Cellar/elasticsearch/5.3.0\n```\n\nNext, you may wish to rename the package from `com.github.hscells.customsimilarity` to something more \nappropriate. You should also rename the classes from `MyCustomSimilarity...` to something more\nappropriate. This isn't necessary but is recommended. Finally, to set the name of your similarity\nplugin when you use it in the elasticsearch api, change the `SIMILARITY_NAME` field in the plugin class\n(the class that extends `Plugin`).\n\nAt this stage, you should be all set to install the plugin to elasticsearch. A `gradle` task is provided\nto do this. It will build and copy the files to wherever `ES_PATH` is set. To run this `gradle` task, in\nthe same directory as this readme file, run:\n\n```bash\n./gradlew installPlugin\n```\n\nFor elasticsearch to register the plugin as installed, you need to **restart** elasticsearch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhscells%2Felasticsearch-similarity-plugin-stub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhscells%2Felasticsearch-similarity-plugin-stub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhscells%2Felasticsearch-similarity-plugin-stub/lists"}