elasticsearch-py の API リファレンス

elasticsearch-py (elastic/elasticsearch-py) の公開 API 344 件 —— クラス 172、関数 106、メソッド 66。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	172
関数	106
メソッド	66

API 一覧

classelasticsearch._async.client.AsyncElasticsearch

Elasticsearch low-level client.

method

elasticsearch._async.client.AsyncElasticsearch.cancel_reindex(*task_id:str, *error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None, *wait_for_completion:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

methodelasticsearch._async.client.AsyncElasticsearch.close() -> None

Closes the Transport and all internal connections

method

elasticsearch._async.client.AsyncElasticsearch.delete_by_query_rethrottle(*task_id:str, *requests_per_second:float, *error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._async.client.AsyncElasticsearch.get_script_context(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._async.client.AsyncElasticsearch.get_script_languages(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._async.client.AsyncElasticsearch.info(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._async.client.AsyncElasticsearch.list_reindex(*detailed:t.Optional[bool]=None, *error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._async.client.AsyncElasticsearch.update_by_query_rethrottle(*task_id:str, *requests_per_second:float, *error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._async.client.inference.InferenceClient.delete_region_policy(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._async.client.inference.InferenceClient.get_region_policy(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

classelasticsearch._sync.client.Elasticsearch

Elasticsearch low-level client.

method

elasticsearch._sync.client.Elasticsearch.cancel_reindex(*task_id:str, *error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None, *wait_for_completion:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

methodelasticsearch._sync.client.Elasticsearch.close() -> None

Closes the Transport and all internal connections

method

elasticsearch._sync.client.Elasticsearch.delete_by_query_rethrottle(*task_id:str, *requests_per_second:float, *error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._sync.client.Elasticsearch.get_script_context(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._sync.client.Elasticsearch.get_script_languages(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._sync.client.Elasticsearch.info(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._sync.client.Elasticsearch.list_reindex(*detailed:t.Optional[bool]=None, *error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._sync.client.Elasticsearch.update_by_query_rethrottle(*task_id:str, *requests_per_second:float, *error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._sync.client.inference.InferenceClient.delete_region_policy(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

method

elasticsearch._sync.client.inference.InferenceClient.get_region_policy(*error_trace:t.Optional[bool]=None, *filter_path:t.Optional[t.Union[str, t.Sequence[str]]]=None, *human:t.Optional[bool]=None, *pretty:t.Optional[bool]=None) -> ObjectApiResponse[t.Any]

funcelasticsearch._sync.client.utils.cloud_id_to_node_configs(cloud_id:str) -> List[NodeConfig]

Transforms an Elastic Cloud ID into a NodeConfig

funcelasticsearch._sync.client.utils.hosts_to_node_configs(hosts:_TYPE_HOSTS) -> List[NodeConfig]

Transforms the many formats of 'hosts' into NodeConfigs

funcelasticsearch._sync.client.utils.is_requests_http_auth(http_auth:Any) -> bool

Detect if an http_auth value is a custom Requests auth object

funcelasticsearch.compat.safe_thread(target:Callable[..., Any], *args:Any, **kwargs:Any) -> Iterator[Thread]

Run a thread within a context manager block.

method

elasticsearch.dsl._sync.document.Document.delete(using:Optional[UsingType]=None, index:Optional[str]=None, **kwargs:Any) -> None

Delete the instance in elasticsearch.

methodelasticsearch.dsl._sync.index.Index.close(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Closes the index in elasticsearch.

methodelasticsearch.dsl._sync.index.Index.create(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Creates the index in elasticsearch.

methodelasticsearch.dsl._sync.index.Index.delete(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Deletes the index in elasticsearch.

method

elasticsearch.dsl._sync.index.Index.delete_alias(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Delete specific alias.

methodelasticsearch.dsl._sync.index.Index.flush(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Performs a flush operation on the index.

methodelasticsearch.dsl._sync.index.Index.get_alias(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Retrieve a specified alias.

method

elasticsearch.dsl._sync.index.Index.get_settings(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Retrieve settings for the index.

methodelasticsearch.dsl._sync.index.Index.open(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Opens the index in elasticsearch.

methodelasticsearch.dsl._sync.index.Index.put_alias(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Create an alias for the index.

methodelasticsearch.dsl._sync.index.Index.refresh(using:Optional[UsingType]=None, **kwargs:Any) -> 'ObjectApiResponse[Any]'

Performs a refresh operation on the index.

classelasticsearch.dsl.aggs.Line

:arg point: (required) The name of the geo_point field.

classelasticsearch.dsl.aggs.Rate

Calculates a rate of documents or a field in each bucket.

methodelasticsearch.dsl.connections.Connections.add_connection(alias:str, conn:_T) -> None

Add a connection object, it will be passed through as-is.

methodelasticsearch.dsl.connections.Connections.remove_connection(alias:str) -> None

Remove connection from the registry.

classelasticsearch.dsl.document_base.InnerDoc

Common class for inner documents like Object or Nested

classelasticsearch.dsl.document_base.InstrumentedExpression

Proxy object for a ES|QL expression.

methodelasticsearch.dsl.document_base.InstrumentedExpression.is_null() -> 'InstrumentedExpression'

Compare the expression against NULL.

methodelasticsearch.dsl.document_base.InstrumentedExpression.like(*patterns:str) -> 'InstrumentedExpression'

Filter the expression using a string pattern.

methodelasticsearch.dsl.document_base.InstrumentedExpression.match(query:str) -> 'InstrumentedExpression'

Perform a match query on the field.

methodelasticsearch.dsl.document_base.InstrumentedExpression.rlike(*patterns:str) -> 'InstrumentedExpression'

Filter the expression using a regular expression.

classelasticsearch.dsl.document_base.InstrumentedField

Proxy object for a mapped document field.

classelasticsearch.dsl.document_base.Mapped

Class that represents the type of a mapped field.

classelasticsearch.dsl.faceted_search_base.Facet

A facet on faceted search.

methodelasticsearch.dsl.faceted_search_base.Facet.add_filter(filter_values:List[FilterValueType]) -> Optional[Query]

Construct a filter.

methodelasticsearch.dsl.faceted_search_base.Facet.get_aggregation() -> Agg[_R]

Return the aggregation object.

methodelasticsearch.dsl.faceted_search_base.Facet.get_metric(bucket:'BucketData[_R]') -> int

Return a metric, by default doc_count for a bucket.

methodelasticsearch.dsl.faceted_search_base.Facet.get_value(bucket:'BucketData[_R]') -> Any

return a value representing a bucket.

methodelasticsearch.dsl.faceted_search_base.Facet.get_value_filter(filter_value:FilterValueType) -> Query

Construct a filter for an individual value

methodelasticsearch.dsl.faceted_search_base.Facet.is_filtered(key:str, filter_values:List[FilterValueType]) -> bool

Is a filter active on the given key.

classelasticsearch.dsl.field.Alias

:arg path: :arg meta: Metadata about the field.

classelasticsearch.dsl.field.ConstantKeyword

:arg value: :arg meta: Metadata about the field.

classelasticsearch.dsl.field.CountedKeyword

:arg index: :arg meta: Metadata about the field.

classelasticsearch.dsl.field.DenseVector

:arg dims: Number of vector dimensions.

classelasticsearch.dsl.field.NumpyDenseVector

A dense vector field that uses numpy arrays.

classelasticsearch.dsl.field.Object

:arg doc_class: base doc class that handles mapping.

classelasticsearch.dsl.field.Percolator

:arg meta: Metadata about the field.

classelasticsearch.dsl.pydantic.AsyncBaseESModelMetaclass

Metaclass for the AsyncBaseESModel class.

classelasticsearch.dsl.pydantic.BaseESModelMetaclass

Metaclass for the BaseESModel class.

classelasticsearch.dsl.pydantic.ESMeta

Metadata items associated with Elasticsearch documents.

classelasticsearch.dsl.query.Common

:arg _field: The field to use in this query.

classelasticsearch.dsl.query.GeoPolygon

:arg _field: The field to use in this query.

classelasticsearch.dsl.query.Ids

Returns documents based on their IDs.

classelasticsearch.dsl.query.MatchAll

Matches all documents, giving them all a `_score` of 1.0.

classelasticsearch.dsl.query.MatchNone

Matches no documents.

classelasticsearch.dsl.query.Nested

Wraps another query to search nested fields.

classelasticsearch.dsl.query.Percolate

Matches queries stored in an index.

classelasticsearch.dsl.query.Script

Filters documents based on a provided script.

classelasticsearch.dsl.query.SpanContaining

Returns matches which enclose another span query.

classelasticsearch.dsl.query.SpanFirst

Matches spans near the beginning of a field.

classelasticsearch.dsl.query.SpanNear

Matches spans which are near one another.

classelasticsearch.dsl.query.SpanOr

Matches the union of its span clauses.

classelasticsearch.dsl.query.SpanTerm

Matches spans containing a term.

classelasticsearch.dsl.response.AggResponse

An Elasticsearch aggregation response.

classelasticsearch.dsl.response.Response

An Elasticsearch search response.

classelasticsearch.dsl.response.UpdateByQueryResponse

An Elasticsearch update by query response.

method

elasticsearch.dsl.search_base.Request.doc_type(*doc_type:Union[type, str], **kwargs:Callable[[AttrDict[Any]], Any]) -> Self

Set the type to search through.

methodelasticsearch.dsl.search_base.Request.extra(**kwargs:Any) -> Self

Add extra keys to the request body.

methodelasticsearch.dsl.search_base.Request.index(*index:Union[str, List[str], Tuple[str, ...]]) -> Self

Set the index for the search.

methodelasticsearch.dsl.search_base.Request.params(**kwargs:Any) -> Self

Specify query params to be used when executing the search.

methodelasticsearch.dsl.search_base.Request.using(client:AnyUsingType) -> Self

Associate the search request with an elasticsearch client.

classelasticsearch.dsl.types.AdjacencyMatrixBucket

:arg key: (required) :arg doc_count: (required)

classelasticsearch.dsl.types.AvgAggregate

:arg value: (required) The metric value.

classelasticsearch.dsl.types.CardinalityAggregate

:arg value: (required) :arg meta:

classelasticsearch.dsl.types.CartesianBoundsAggregate

:arg bounds: :arg meta:

classelasticsearch.dsl.types.CartesianCentroidAggregate

:arg count: (required) :arg location: :arg meta:

classelasticsearch.dsl.types.CartesianPoint

:arg x: (required) :arg y: (required)

classelasticsearch.dsl.types.ChangePointAggregate

:arg type: (required) :arg bucket: :arg meta:

classelasticsearch.dsl.types.ChangePointBucket

:arg key: (required) :arg doc_count: (required)

classelasticsearch.dsl.types.ChildrenAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.CompositeBucket

:arg key: (required) :arg doc_count: (required)

classelasticsearch.dsl.types.CustomCategorizeTextAnalyzer

:arg char_filter: :arg tokenizer: :arg filter:

classelasticsearch.dsl.types.DateRangeAggregate

Result of a `date_range` aggregation.

classelasticsearch.dsl.types.DerivativeAggregate

:arg value: (required) The metric value.

classelasticsearch.dsl.types.DfsProfile

:arg statistics: :arg knn:

classelasticsearch.dsl.types.Dip

:arg p_value: (required) :arg change_point: (required)

classelasticsearch.dsl.types.DistributionChange

:arg p_value: (required) :arg change_point: (required)

classelasticsearch.dsl.types.Embedding

:arg input: (required) :arg inference_id: :arg timeout:

classelasticsearch.dsl.types.EmptyObject

For empty Class assignments

classelasticsearch.dsl.types.ErrorCause

Cause and details about a request failure.

classelasticsearch.dsl.types.EwmaModelSettings

:arg alpha:

classelasticsearch.dsl.types.ExtendedBounds

:arg max: Maximum value for the bound.

classelasticsearch.dsl.types.FetchProfileDebug

:arg stored_fields: :arg fast_path:

classelasticsearch.dsl.types.FieldLookup

:arg id: (required) `id` of the document.

classelasticsearch.dsl.types.FilterAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.FiltersBucket

:arg doc_count: (required) :arg key:

classelasticsearch.dsl.types.GeoBoundsAggregate

:arg bounds: :arg meta:

classelasticsearch.dsl.types.GeoCentroidAggregate

:arg count: (required) :arg location: :arg meta:

classelasticsearch.dsl.types.GeoDistanceAggregate

Result of a `geo_distance` aggregation.

classelasticsearch.dsl.types.GeoDistanceSort

:arg _field: The field to use in this query.

classelasticsearch.dsl.types.GeoHashGridBucket

:arg key: (required) :arg doc_count: (required)

classelasticsearch.dsl.types.GeoHashLocation

:arg geohash: (required)

classelasticsearch.dsl.types.GeoHexGridBucket

:arg key: (required) :arg doc_count: (required)

classelasticsearch.dsl.types.GeoLine

A GeoJson GeoLine.

classelasticsearch.dsl.types.GeoLinePoint

:arg field: (required) The name of the geo_point field.

classelasticsearch.dsl.types.GeoPolygonPoints

:arg points: (required)

classelasticsearch.dsl.types.GeoTileGridBucket

:arg key: (required) :arg doc_count: (required)

classelasticsearch.dsl.types.GlobalAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.HdrPercentileRanksAggregate

:arg values: (required) :arg meta:

classelasticsearch.dsl.types.HdrPercentilesAggregate

:arg values: (required) :arg meta:

classelasticsearch.dsl.types.HoltLinearModelSettings

:arg alpha: :arg beta:

classelasticsearch.dsl.types.Indeterminable

:arg reason: (required)

classelasticsearch.dsl.types.InnerHitsResult

:arg hits: (required)

classelasticsearch.dsl.types.IntervalsAllOf

:arg intervals: (required) An array of rules to combine.

classelasticsearch.dsl.types.IntervalsAnyOf

:arg intervals: (required) An array of rules to match.

classelasticsearch.dsl.types.IntervalsFuzzy

:arg term: (required) The term to match.

classelasticsearch.dsl.types.IntervalsRange

:arg analyzer: Analyzer used to analyze the `prefix`.

classelasticsearch.dsl.types.IntervalsRegexp

:arg pattern: (required) Regex pattern.

classelasticsearch.dsl.types.IpRangeAggregationRange

:arg from: Start of the range.

classelasticsearch.dsl.types.IpRangeBucket

:arg doc_count: (required) :arg key: :arg from: :arg to:

classelasticsearch.dsl.types.LikeDocument

:arg doc: A document not present in the index.

classelasticsearch.dsl.types.MatrixStatsAggregate

:arg doc_count: (required) :arg fields: :arg meta:

classelasticsearch.dsl.types.MaxAggregate

:arg value: (required) The metric value.

classelasticsearch.dsl.types.MedianAbsoluteDeviationAggregate

:arg value: (required) The metric value.

classelasticsearch.dsl.types.MinAggregate

:arg value: (required) The metric value.

classelasticsearch.dsl.types.MissingAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.MultiTermLookup

:arg field: A field from which to retrieve terms.

classelasticsearch.dsl.types.NestedAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.NumericFielddata

:arg format: (required)

classelasticsearch.dsl.types.ParentAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.PercentilesBucketAggregate

:arg values: (required) :arg meta:

classelasticsearch.dsl.types.PinnedDoc

:arg _id: (required) The unique document ID.

classelasticsearch.dsl.types.RateAggregate

:arg value: (required) :arg value_as_string: :arg meta:

classelasticsearch.dsl.types.Retries

:arg bulk: (required) The number of bulk actions retried.

classelasticsearch.dsl.types.ReverseNestedAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.SamplerAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.ScoreSort

:arg order:

classelasticsearch.dsl.types.Script

:arg source: The script source.

classelasticsearch.dsl.types.ScriptField

:arg script: (required) :arg ignore_failure:

classelasticsearch.dsl.types.ScriptedHeuristic

:arg script: (required)

classelasticsearch.dsl.types.ScriptedMetricAggregate

:arg value: (required) :arg meta:

classelasticsearch.dsl.types.SemanticTextIndexOptions

:arg dense_vector: :arg sparse_vector:

classelasticsearch.dsl.types.ShapeFieldQuery

:arg indexed_shape: Queries using a pre-indexed shape.

classelasticsearch.dsl.types.SimpleValueAggregate

:arg value: (required) The metric value.

classelasticsearch.dsl.types.SortOptions

:arg _field: The field to use in this query.

classelasticsearch.dsl.types.SpanContainingQuery

:arg big: (required) Can be any span query.

classelasticsearch.dsl.types.SpanWithinQuery

:arg big: (required) Can be any span query.

classelasticsearch.dsl.types.Spike

:arg p_value: (required) :arg change_point: (required)

classelasticsearch.dsl.types.StatsAggregate

Statistics aggregation result.

classelasticsearch.dsl.types.StepChange

:arg p_value: (required) :arg change_point: (required)

classelasticsearch.dsl.types.StringRareTermsBucket

:arg key: (required) :arg doc_count: (required)

classelasticsearch.dsl.types.SumAggregate

Sum aggregation result.

classelasticsearch.dsl.types.TDigestPercentileRanksAggregate

:arg values: (required) :arg meta:

classelasticsearch.dsl.types.TDigestPercentilesAggregate

:arg values: (required) :arg meta:

classelasticsearch.dsl.types.TTestAggregate

:arg value: (required) :arg value_as_string: :arg meta:

classelasticsearch.dsl.types.TestPopulation

:arg field: (required) The field to aggregate.

classelasticsearch.dsl.types.TextIndexPrefixes

:arg max_chars: :arg min_chars:

classelasticsearch.dsl.types.TimeSeriesBucket

:arg key: (required) :arg doc_count: (required)

classelasticsearch.dsl.types.TopHitsAggregate

:arg hits: (required) :arg meta:

classelasticsearch.dsl.types.TopMetrics

:arg sort: (required) :arg metrics: (required)

classelasticsearch.dsl.types.TopMetricsAggregate

:arg top: (required) :arg meta:

classelasticsearch.dsl.types.TopMetricsValue

:arg field: (required) A field to return as a metric.

classelasticsearch.dsl.types.TotalHits

:arg relation: (required) :arg value: (required)

classelasticsearch.dsl.types.UnmappedSamplerAggregate

:arg doc_count: (required) :arg meta:

classelasticsearch.dsl.types.ValueCountAggregate

Value count aggregation result.

classelasticsearch.dsl.types.WeightedAvgAggregate

Weighted average aggregation result.

classelasticsearch.dsl.types.WktGeoBounds

:arg wkt: (required)

classelasticsearch.dsl.wrappers.AggregationRange

:arg from: Start of the range (inclusive).

classelasticsearch.esql.esql.ChangePoint

Implementation of the ``CHANGE POINT`` processing command.

methodelasticsearch.esql.esql.ChangePoint.as_(type_name:str, pvalue_name:str) -> 'ChangePoint'

Continuation of the ``CHANGE_POINT`` command.

methodelasticsearch.esql.esql.ChangePoint.on(key:FieldType) -> 'ChangePoint'

Continuation of the ``CHANGE_POINT`` command.

classelasticsearch.esql.esql.Completion

Implementation of the ``COMPLETION`` processing command.

methodelasticsearch.esql.esql.Completion.with_(inference_id:str) -> 'Completion'

Continuation of the ``COMPLETION`` command.

classelasticsearch.esql.esql.Dissect

Implementation of the ``DISSECT`` processing command.

methodelasticsearch.esql.esql.Dissect.append_separator(separator:str) -> 'Dissect'

Continuation of the ``DISSECT`` command.

classelasticsearch.esql.esql.Drop

Implementation of the ``DROP`` processing command.

methodelasticsearch.esql.esql.ESQLBase.drop(*columns:FieldType) -> 'Drop'

The ``DROP`` processing command removes one or more columns.

methodelasticsearch.esql.esql.ESQLBase.rename(**columns:FieldType) -> 'Rename'

The ``RENAME`` processing command renames one or more columns.

methodelasticsearch.esql.esql.ESQLBase.sample(probability:float) -> 'Sample'

The ``SAMPLE`` command samples a fraction of the table rows.

classelasticsearch.esql.esql.Enrich

Implementation of the ``ENRICH`` processing command.

methodelasticsearch.esql.esql.Enrich.on(match_field:FieldType) -> 'Enrich'

Continuation of the ``ENRICH`` command.

methodelasticsearch.esql.esql.Enrich.with_(*fields:FieldType, **named_fields:FieldType) -> 'Enrich'

Continuation of the ``ENRICH`` command.

classelasticsearch.esql.esql.Eval

Implementation of the ``EVAL`` processing command.

classelasticsearch.esql.esql.Fork

Implementation of the ``FORK`` processing command.

classelasticsearch.esql.esql.From

Implementation of the ``FROM`` source command.

methodelasticsearch.esql.esql.From.metadata(*fields:FieldType) -> 'From'

Continuation of the ``FROM`` and ``TS`` source commands.

classelasticsearch.esql.esql.Fuse

Implementation of the ``FUSE`` processing command.

classelasticsearch.esql.esql.Grok

Implementation of the ``GROK`` processing command.

classelasticsearch.esql.esql.InlineStats

Implementation of the ``INLINE STATS`` processing command.

classelasticsearch.esql.esql.Keep

Implementation of the ``KEEP`` processing command.

classelasticsearch.esql.esql.Limit

Implementation of the ``LIMIT`` processing command.

classelasticsearch.esql.esql.LookupJoin

Implementation of the ``LOOKUP JOIN`` processing command.

methodelasticsearch.esql.esql.LookupJoin.on(field:FieldType) -> 'LookupJoin'

Continuation of the ``LOOKUP JOIN`` command.

classelasticsearch.esql.esql.MetricsInfo

Implementation of the ``METRICS_INFO`` processing command.

classelasticsearch.esql.esql.Mmr

Implementation of the ``MMR`` processing command.

methodelasticsearch.esql.esql.Mmr.mmr_limit(max_number_of_rows:int) -> 'Mmr'

Continuation of the ``MMR`` command.

methodelasticsearch.esql.esql.Mmr.with_(lambda_:float) -> 'Mmr'

Continuation of the ``MMR`` command.

classelasticsearch.esql.esql.MvExpand

Implementation of the ``MV_EXPAND`` processing command.

classelasticsearch.esql.esql.Rename

Implementation of the ``RENAME`` processing command.

classelasticsearch.esql.esql.Rerank

Implementation of the ``RERANK`` processing command.

methodelasticsearch.esql.esql.Rerank.on(*fields:str) -> 'Rerank'

Continuation of the ``RERANK`` command.

methodelasticsearch.esql.esql.Rerank.with_(inference_id:str) -> 'Rerank'

Continuation of the ``RERANK`` command.

classelasticsearch.esql.esql.Row

Implementation of the ``ROW`` source command.

classelasticsearch.esql.esql.Sample

Implementation of the ``SAMPLE`` processing command.

classelasticsearch.esql.esql.Set

Implementation of the ``SET`` query directive.

classelasticsearch.esql.esql.Show

Implementation of the ``SHOW`` source command.

classelasticsearch.esql.esql.Sort

Implementation of the ``SORT`` processing command.

classelasticsearch.esql.esql.Stats

Implementation of the ``STATS`` processing command.

methodelasticsearch.esql.esql.Stats.by(*grouping_expressions:ExpressionType) -> 'Stats'

Continuation of the ``STATS`` and ``INLINE STATS`` commands.

classelasticsearch.esql.esql.TS

Implementation of the ``TS`` source command.

classelasticsearch.esql.esql.TsInfo

Implementation of the ``TS_INFO`` processing command.

classelasticsearch.esql.esql.UriParts

Implementation of the ``URI_PARTS`` processing command.

classelasticsearch.esql.esql.UserAgent

Implementation of the ``USER_AGENT`` processing command.

classelasticsearch.esql.esql.Where

Implementation of the ``WHERE`` processing command.

funcelasticsearch.esql.esql.and_(*expressions:InstrumentedExpression) -> 'InstrumentedExpression'

Combine two or more expressions with the AND operator.

funcelasticsearch.esql.esql.not_(expression:InstrumentedExpression) -> 'InstrumentedExpression'

Negate an expression.

funcelasticsearch.esql.esql.or_(*expressions:InstrumentedExpression) -> 'InstrumentedExpression'

Combine two or more expressions with the OR operator.

funcelasticsearch.esql.functions.abs(number:ExpressionType) -> InstrumentedExpression

Returns the absolute value.

funcelasticsearch.esql.functions.acosh(number:ExpressionType) -> InstrumentedExpression

Returns the inverse hyperbolic cosine of a number.

funcelasticsearch.esql.functions.asinh(number:ExpressionType) -> InstrumentedExpression

Returns the inverse hyperbolic sine of a number.

funcelasticsearch.esql.functions.atanh(number:ExpressionType) -> InstrumentedExpression

Returns the inverse hyperbolic tangent of a number.

funcelasticsearch.esql.functions.avg(number:ExpressionType) -> InstrumentedExpression

The average of a numeric field.

funcelasticsearch.esql.functions.bit_length(string:ExpressionType) -> InstrumentedExpression

Returns the bit length of a string.

funcelasticsearch.esql.functions.byte_length(string:ExpressionType) -> InstrumentedExpression

Returns the byte length of a string.

funcelasticsearch.esql.functions.case(*conditions:ExpressionType) -> InstrumentedExpression

Accepts pairs of conditions and values.

funcelasticsearch.esql.functions.cbrt(number:ExpressionType) -> InstrumentedExpression

Returns the cube root of a number.

funcelasticsearch.esql.functions.ceil(number:ExpressionType) -> InstrumentedExpression

Round a number up to the nearest integer.

funcelasticsearch.esql.functions.coalesce(first:ExpressionType, rest:ExpressionType) -> InstrumentedExpression

Returns the first of its arguments that is not null.

funcelasticsearch.esql.functions.concat(*strings:ExpressionType) -> InstrumentedExpression

Concatenates two or more strings.

funcelasticsearch.esql.functions.cos(angle:ExpressionType) -> InstrumentedExpression

Returns the cosine of an angle.

funcelasticsearch.esql.functions.cosh(number:ExpressionType) -> InstrumentedExpression

Returns the hyperbolic cosine of a number.

funcelasticsearch.esql.functions.count(field:ExpressionType) -> InstrumentedExpression

Returns the total number (count) of input values.

funcelasticsearch.esql.functions.count_distinct(field:ExpressionType, precision:ExpressionType) -> InstrumentedExpression

Returns the approximate number of distinct values.

funcelasticsearch.esql.functions.count_over_time(field:ExpressionType, window:ExpressionType=None) -> InstrumentedExpression

Calculates the count over time value of a field.

funcelasticsearch.esql.functions.e() -> InstrumentedExpression

Returns Euler’s number).

funcelasticsearch.esql.functions.floor(number:ExpressionType) -> InstrumentedExpression

Round a number down to the nearest integer.

funcelasticsearch.esql.functions.from_base64(string:ExpressionType) -> InstrumentedExpression

Decode a base64 string.

funcelasticsearch.esql.functions.greatest(first:ExpressionType, rest:ExpressionType) -> InstrumentedExpression

Returns the maximum value from multiple columns.

funcelasticsearch.esql.functions.hypot(number1:ExpressionType, number2:ExpressionType) -> InstrumentedExpression

Returns the hypotenuse of two numbers.

funcelasticsearch.esql.functions.idelta(field:ExpressionType, window:ExpressionType) -> InstrumentedExpression

Calculates the idelta of a gauge.

func

elasticsearch.esql.functions.ip_prefix(ip:ExpressionType, prefix_length_v4:ExpressionType, prefix_length_v6:ExpressionType) -> InstrumentedExpression

Truncates an IP to a given prefix length.

funcelasticsearch.esql.functions.irate(field:ExpressionType, window:ExpressionType) -> InstrumentedExpression

Calculates the irate of a counter field.

funcelasticsearch.esql.functions.kql(query:ExpressionType, options:ExpressionType=None) -> InstrumentedExpression

Performs a KQL query.

funcelasticsearch.esql.functions.least(first:ExpressionType, rest:ExpressionType) -> InstrumentedExpression

Returns the minimum value from multiple columns.

funcelasticsearch.esql.functions.length(string:ExpressionType) -> InstrumentedExpression

Returns the character length of a string.

funcelasticsearch.esql.functions.log(base:ExpressionType, number:ExpressionType) -> InstrumentedExpression

Returns the logarithm of a value to a base.

funcelasticsearch.esql.functions.log10(number:ExpressionType) -> InstrumentedExpression

Returns the logarithm of a value to base 10.

funcelasticsearch.esql.functions.ltrim(string:ExpressionType) -> InstrumentedExpression

Removes leading whitespaces from a string.

funcelasticsearch.esql.functions.max(field:ExpressionType) -> InstrumentedExpression

The maximum value of a field.

funcelasticsearch.esql.functions.max_over_time(field:ExpressionType, window:ExpressionType=None) -> InstrumentedExpression

Calculates the maximum over time value of a field.

funcelasticsearch.esql.functions.min(field:ExpressionType) -> InstrumentedExpression

The minimum value of a field.

funcelasticsearch.esql.functions.min_over_time(field:ExpressionType, window:ExpressionType=None) -> InstrumentedExpression

Calculates the minimum over time value of a field.

funcelasticsearch.esql.functions.mv_append(field1:ExpressionType, field2:ExpressionType) -> InstrumentedExpression

Concatenates values of two multi-value fields.

funcelasticsearch.esql.functions.mv_dedupe(field:ExpressionType) -> InstrumentedExpression

Remove duplicate values from a multivalued field.

funcelasticsearch.esql.functions.mv_sort(field:ExpressionType, order:ExpressionType) -> InstrumentedExpression

Sorts a multivalued field in lexicographical order.

funcelasticsearch.esql.functions.now() -> InstrumentedExpression

Returns current date and time.

func

elasticsearch.esql.functions.percentile_over_time(field:ExpressionType, percentile:ExpressionType) -> InstrumentedExpression

Calculates the percentile over time of a field.

funcelasticsearch.esql.functions.qstr(query:ExpressionType, options:ExpressionType=None) -> InstrumentedExpression

Performs a query string query.

funcelasticsearch.esql.functions.round_to(field:ExpressionType, points:ExpressionType) -> InstrumentedExpression

Rounds down to one of a list of fixed points.

funcelasticsearch.esql.functions.rtrim(string:ExpressionType) -> InstrumentedExpression

Removes trailing whitespaces from a string.

funcelasticsearch.esql.functions.sample(field:ExpressionType, limit:ExpressionType) -> InstrumentedExpression

Collects sample values for a field.

funcelasticsearch.esql.functions.score(query:ExpressionType) -> InstrumentedExpression

Scores an expression.

funcelasticsearch.esql.functions.sha1(input:ExpressionType) -> InstrumentedExpression

Computes the SHA1 hash of the input.

funcelasticsearch.esql.functions.sha256(input:ExpressionType) -> InstrumentedExpression

Computes the SHA256 hash of the input.

funcelasticsearch.esql.functions.signum(number:ExpressionType) -> InstrumentedExpression

Returns the sign of the given number.

funcelasticsearch.esql.functions.sin(angle:ExpressionType) -> InstrumentedExpression

Returns the sine of an angle.

funcelasticsearch.esql.functions.sinh(number:ExpressionType) -> InstrumentedExpression

Returns the hyperbolic sine of a number.

funcelasticsearch.esql.functions.space(number:ExpressionType) -> InstrumentedExpression

Returns a string made of `number` spaces.

funcelasticsearch.esql.functions.split(string:ExpressionType, delim:ExpressionType) -> InstrumentedExpression

Split a single valued string into multiple strings.

funcelasticsearch.esql.functions.sqrt(number:ExpressionType) -> InstrumentedExpression

Returns the square root of a number.

funcelasticsearch.esql.functions.st_distance(geom_a:ExpressionType, geom_b:ExpressionType) -> InstrumentedExpression

Computes the distance between two points.

funcelasticsearch.esql.functions.st_intersects(geom_a:ExpressionType, geom_b:ExpressionType) -> InstrumentedExpression

Returns true if two geometries intersect.

funcelasticsearch.esql.functions.st_isempty(geometry:ExpressionType) -> InstrumentedExpression

Returns true if the supplied geometry is empty.

funcelasticsearch.esql.functions.st_npoints(geometry:ExpressionType) -> InstrumentedExpression

Counts the number of points in the supplied geometry.

funcelasticsearch.esql.functions.st_x(point:ExpressionType) -> InstrumentedExpression

Extracts the `x` coordinate from the supplied point.

funcelasticsearch.esql.functions.st_y(point:ExpressionType) -> InstrumentedExpression

Extracts the `y` coordinate from the supplied point.

funcelasticsearch.esql.functions.std_dev(number:ExpressionType) -> InstrumentedExpression

The population standard deviation of a numeric field.

funcelasticsearch.esql.functions.sum(number:ExpressionType) -> InstrumentedExpression

The sum of a numeric expression.

funcelasticsearch.esql.functions.sum_over_time(field:ExpressionType, window:ExpressionType=None) -> InstrumentedExpression

Calculates the sum over time value of a field.

funcelasticsearch.esql.functions.tan(angle:ExpressionType) -> InstrumentedExpression

Returns the tangent of an angle.

funcelasticsearch.esql.functions.tanh(number:ExpressionType) -> InstrumentedExpression

Returns the hyperbolic tangent of a number.

funcelasticsearch.esql.functions.term(field:ExpressionType, query:ExpressionType) -> InstrumentedExpression

Performs a Term query on the specified field.

funcelasticsearch.esql.functions.to_aggregate_metric_double(number:ExpressionType) -> InstrumentedExpression

Encode a numeric to an aggregate_metric_double.

funcelasticsearch.esql.functions.to_base64(string:ExpressionType) -> InstrumentedExpression

Encode a string to a base64 string.

funcelasticsearch.esql.functions.to_boolean(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a boolean value.

funcelasticsearch.esql.functions.to_cartesianpoint(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a `cartesian_point` value.

funcelasticsearch.esql.functions.to_cartesianshape(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a `cartesian_shape` value.

funcelasticsearch.esql.functions.to_dateperiod(field:ExpressionType) -> InstrumentedExpression

Converts an input value into a `date_period` value.

funcelasticsearch.esql.functions.to_datetime(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a date value.

funcelasticsearch.esql.functions.to_degrees(number:ExpressionType) -> InstrumentedExpression

Converts a number in radians to degrees).

funcelasticsearch.esql.functions.to_double(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a double value.

funcelasticsearch.esql.functions.to_geohash(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a `geohash` value.

funcelasticsearch.esql.functions.to_geohex(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a `geohex` value.

funcelasticsearch.esql.functions.to_geopoint(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a `geo_point` value.

funcelasticsearch.esql.functions.to_geoshape(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a `geo_shape` value.

funcelasticsearch.esql.functions.to_geotile(field:ExpressionType) -> InstrumentedExpression

Converts an input value to a `geotile` value.

funcelasticsearch.esql.functions.to_integer(field:ExpressionType, base:ExpressionType=None) -> InstrumentedExpression

Converts an input value to an integer value.

funcelasticsearch.esql.functions.to_ip(field:ExpressionType, options:ExpressionType=None) -> InstrumentedExpression

Converts an input string to an IP value.

funcelasticsearch.esql.functions.to_long(field:ExpressionType, base:ExpressionType=None) -> InstrumentedExpression

Converts the input value to a long.

funcelasticsearch.esql.functions.to_radians(number:ExpressionType) -> InstrumentedExpression

Converts a number in degrees) to radians.

funcelasticsearch.esql.functions.to_string(field:ExpressionType) -> InstrumentedExpression

Converts an input value into a string.

funcelasticsearch.esql.functions.to_timeduration(field:ExpressionType) -> InstrumentedExpression

Converts an input value into a `time_duration` value.

funcelasticsearch.esql.functions.to_unsigned_long(field:ExpressionType) -> InstrumentedExpression

Converts an input value to an unsigned long value.

funcelasticsearch.esql.functions.to_version(field:ExpressionType) -> InstrumentedExpression

Converts an input string to a version value.

func

elasticsearch.esql.functions.top(field:ExpressionType, limit:ExpressionType, order:ExpressionType, output_field:ExpressionType=None) -> InstrumentedExpression

Collects the top values for a field.

funcelasticsearch.esql.functions.trim(string:ExpressionType) -> InstrumentedExpression

Removes leading and trailing whitespaces from a string.

funcelasticsearch.esql.functions.url_encode(string:ExpressionType) -> InstrumentedExpression

URL-encodes the input.

funcelasticsearch.esql.functions.url_encode_component(string:ExpressionType) -> InstrumentedExpression

URL-encodes the input.

funcelasticsearch.esql.functions.v_l1_norm(left:ExpressionType, right:ExpressionType) -> InstrumentedExpression

Calculates the l1 norm between two dense_vectors.

funcelasticsearch.esql.functions.v_l2_norm(left:ExpressionType, right:ExpressionType) -> InstrumentedExpression

Calculates the l2 norm between two dense_vectors.

funcelasticsearch.esql.functions.v_magnitude(input:ExpressionType) -> InstrumentedExpression

Calculates the magnitude of a dense_vector.

funcelasticsearch.esql.functions.values(field:ExpressionType) -> InstrumentedExpression

Returns unique (deduplicated) values as a multivalued field.

funcelasticsearch.esql.functions.variance(number:ExpressionType) -> InstrumentedExpression

The population variance of a numeric field.

funcelasticsearch.esql.functions.weighted_avg(number:ExpressionType, weight:ExpressionType) -> InstrumentedExpression

The weighted average of a numeric expression.

methodelasticsearch.exceptions.ApiError.error() -> str

Backwards-compatible way to access ``self.message``

methodelasticsearch.exceptions.ApiError.info() -> Any

Backwards-compatible way to access ``self.body``

classelasticsearch.exceptions.AuthenticationException

Exception representing a 401 status code.

classelasticsearch.exceptions.AuthorizationException

Exception representing a 403 status code.

classelasticsearch.exceptions.BadRequestError

Exception representing a 400 status code.

classelasticsearch.exceptions.ConflictError

Exception representing a 409 status code.

classelasticsearch.exceptions.GeneralAvailabilityWarning

Warning that is raised when a feature is not yet GA.

classelasticsearch.exceptions.NotFoundError

Exception representing a 404 status code.

classelasticsearch.helpers.vectorstore._async.strategies.AsyncDenseVectorStrategy

K-nearest-neighbors retrieval.

classelasticsearch.helpers.vectorstore._sync.strategies.DenseVectorStrategy

K-nearest-neighbors retrieval.

classelasticsearch.serializer.PyArrowSerializer

PyArrow serializer for deserializing Arrow Stream data.

classutils.dsl-generator.ElasticsearchSchema

Operations related to the Elasticsearch schema.

funcutils.dsl-generator.add_not_set(type_)

Add DefaultType to a Python type hint.

funcutils.dsl-generator.generate_types_py(schema, filename)

Generate types.py

この情報について

掲載しているシグネチャは elastic/elasticsearch-py の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る