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

[Mappings editor] add descriptions for data types #54817

Conversation

alisonelizabeth
Copy link
Contributor

This PR adds descriptions for keyword, dense_vector, completion, token_count, alias, search_as_you_type, and flattened data types.

Screenshots

Screen Shot 2020-01-14 at 3 44 54 PM

Screen Shot 2020-01-14 at 3 45 19 PM

Screen Shot 2020-01-14 at 3 45 31 PM

Screen Shot 2020-01-14 at 3 45 49 PM

Screen Shot 2020-01-14 at 3 46 21 PM

Screen Shot 2020-01-14 at 3 47 36 PM

Screen Shot 2020-01-14 at 3 51 33 PM

@alisonelizabeth alisonelizabeth added Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more release_note:skip Skip the PR/issue when compiling release notes Feature:Mappings Editor Index mappings editor UI labels Jan 14, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/es-ui (Team:Elasticsearch UI)

@cjcenizal cjcenizal mentioned this pull request Jan 14, 2020
30 tasks
Copy link
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

Alias fields accept an alternative name for a field. You can use aliases in search requests.

Alias fields accept an alternative name for a field, which you can use in search requests.


Can this field be renamed Autocomplete or Word completion instead?

Not sure what the last half of the second sentence means

Completion suggester fields support autocomplete. This data type enables fast lookups, but is costly to build and store in memory.

Completion suggester fields support autocomplete, which enables fast lookups, but is costly to build and store in memory.


Dense vector fields store vectors of float values. This data type is useful for document scoring.

Dense vector fields store vectors of float values, useful for document scoring.


Flattened fields map a field as a single object. This data type is useful for indexing objects with a large or unknown number of unique keys. Flattened fields support basic queries only.

Flattened fields map a field as a single object and are useful for indexing objects with a large or unknown number of unique keys. Flattened fields support basic queries only.


Search-as-you-type fields break strings into subfields for search suggestions. This data type supports both prefix and infix completion.

Question: Is "infix" a typo? Should it be in command font? Or is there another word you can use?


Token count fields accept string values and indexes the number of tokens in the string.


Keyword fields support searching for an exact value and are useful for filtering, sorting, and aggregations. To index full-text content, such as an email body, use the text data type.

Keyword fields support searching for an exact value and are useful for filtering, sorting, and aggregations.

Is the last sentence needed?


@cjcenizal
Copy link
Contributor

Merging this now to expedite other PRs. I'll address Gail's feedback in a separate PR.

@cjcenizal cjcenizal merged commit 0e1b76f into elastic:feature/mappings-editor Jan 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Mappings Editor Index mappings editor UI release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants