Skip to content

Commit

Permalink
[DOCS] Fixes issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Aug 3, 2023
1 parent 6d6ab72 commit 4275b93
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 16 deletions.
29 changes: 24 additions & 5 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ get-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch
grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html
put-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-pipeline-api.html
simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html

search-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-search.html
delete-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html
get-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-license.html
Expand Down Expand Up @@ -349,6 +350,7 @@ modules-node,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mo
search-aggregations-bucket-count-ks-test-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html
search-aggregations-bucket-correlation-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-correlation-aggregation.html
search-aggregations-bucket-categorize-text-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html
search-aggregations-bucket-significantterms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html
search-aggregations-pipeline-bucket-path,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#buckets-path-syntax
ml-feature-importance,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-feature-importance.html
analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html
Expand Down
13 changes: 6 additions & 7 deletions specification/graph/_types/ExploreControls.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,26 @@ import { Duration } from '@_types/Time'

export class ExploreControls {
/**
* To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
* To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
* You can do this by selecting a single-value field and setting a maximum number of documents per value for that field.
*/
sample_diversity?: SampleDiversity
/**
* Each hop considers a sample of the best-matching documents on each shard.
* Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
* Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
* Each hop considers a sample of the best-matching documents on each shard.
* Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
* Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
* Very large sample sizes can dilute the quality of the results and increase execution times.
* @server_default 100
*/
sample_size?: integer
/**
* The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
* This timeout is honored on a best-effort basis.
* The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
* This timeout is honored on a best-effort basis.
* Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field.
*/
timeout?: Duration
/**
* Filters associated terms so only those that are significantly associated with your query are included.
* @server_default True
* @doc_id search-aggregations-bucket-significantterms-aggregation
*/
use_significance: boolean
Expand Down
6 changes: 3 additions & 3 deletions specification/graph/_types/Hop.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ import { VertexDefinition } from './Vertex'

export class Hop {
/**
* Specifies or more fields from which you want to extract terms that are associated with the specified vertices.
* Specifies one or more fields from which you want to extract terms that are associated with the specified vertices.
*/
connections?: Hop
/**
* A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.
* An optional guiding query that constrains the Graph API as it explores connected terms.
*/
query: QueryContainer
/**
* Specifies one or more fields that contain the terms you want to include in the graph as vertices.
* Contains the fields you are interested in.
*/
vertices: VertexDefinition[]
}
2 changes: 1 addition & 1 deletion specification/graph/_types/Vertex.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export class VertexDefinition {
*/
include?: VertexInclude[]
/**
* Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
* Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
* This setting acts as a certainty threshold.
* @server_default 3
*/
Expand Down

0 comments on commit 4275b93

Please sign in to comment.