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

Document larasearch/config.php's analyzer => larasearch_{analyzer}_index correspondance #30

Open
myselfhimself opened this issue Oct 12, 2014 · 4 comments

Comments

@myselfhimself
Copy link
Contributor

Hello,

it would be nice to write in README.md and config.php how analyzers configuration (name <=> implementation) works. Namely, that analyzers listed with a short name in config.php's elasticsearch.analyzers array, have their corresponding definition in elasticsearch.defaults.index.settings.analysis.analyzer.larasearch_{analyzer name}_index entries.

This would help people creating their own analyzers and understand what's corresponding to the analyzers short names they may write in the public $__es_config; array.

I have spent maybe 2 hours before finding that out... : /

Though, the lib is cool thanks!

@iverberk
Copy link
Owner

I'm sorry that you had a bad experience figuring out how the analysers work. The documentation as it is now reflects the most basic things that a user of the library need to know to get started. As you've found out it lacks in-depth explanations of the inner workings. I just wrote it all down in one go so that people could start using the library. I think the Github wiki is probably better suited to documentation of Larasearch instead of a long readme file. This week I'm on holiday but when I get back I'll start working on a documentation wiki and explain some of the more advanced concepts for people who want to tweak the inner workings.

Thanks for you feedback again.

@myselfhimself
Copy link
Contributor Author

Hello Ivo,

Open-sourcing a projects takes a lot of time and effort. I understand you
and thank you for all your good work.
I know for now, that I have to take a deeper look at the code for advanced
features.
Have a very good holiday!

Jonathan-David

On Mon, Oct 13, 2014 at 10:05 AM, iverberk [email protected] wrote:

I'm sorry that you had a bad experience figuring out how the analysers
work. The documentation as it is now reflects the most basic things that a
user of the library need to know to get started. As you've found out it
lacks in-depth explanations of the inner workings. I just wrote it all down
in one go so that people could start using the library. I think the Github
wiki is probably better suited to documentation of Larasearch instead of a
long readme file. This week I'm on holiday but when I get back I'll start
working on a documentation wiki and explain some of the more advanced
concepts for people who want to tweak the inner workings.

Thanks for you feedback again.


Reply to this email directly or view it on GitHub
#30 (comment).

@leo4all
Copy link

leo4all commented Jun 11, 2015

I don't know, the code looks pretty nice, but this lack of a demo or better documentation falls short our expectations,
It's not a requirement to create a free package to everyone use, but its really hard to understand a package when it's build this way, first one had to understand the platform and then try to figure it out how the package works.
I had a hard time with analyzer = mapping issue, I set up everything correctly after hours on this, but I every search I made it had to be the exact match string.

public static $__es_config = [
    'autocomplete' => ['title'],
    'suggest' => ['title'],
    'word_start' => ['title']
];

Anyways thanks your package hope you being kind to provide more info
PD:Sorry my english.
@iverberk

@fuess
Copy link

fuess commented Aug 4, 2015

I would really like to see some more in-depth documentation about this too. I can't get 'suggest' to work, but have no idea where to start debugging.
The options array is empty in the response.
When I manually do:

curl -XPOST 'localhost:9200/index_name/_suggest' -d '{
    "my-suggestion" : {
        "text" : "search_term_with_typo",
        "term" : {
            "field" : "description"
        }
    }
}'

The response option array is also empty.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants