Namespace OpenSearch.Client

Classes

Descriptor for AddAgenticMemory

AdjacencyMatrixAggregationDescriptor<T>

AgenticContextResponseProcessor

AgenticContextResponseProcessorDescriptor

AgenticQueryTranslatorRequestProcessor

AgenticQueryTranslatorRequestProcessorDescriptor

AggregateDictionary

Contains aggregates that are returned by OpenSearch. In OSC, Aggregation always refers to an aggregation request to OpenSearch and an Aggregate describes an aggregation response.

AggregationContainerDescriptor<T>

AggregationDictionary

Describes aggregations that we would like to execute on OpenSearch.

In OSC Aggregation always refers to an aggregation sent to OpenSearch and an Aggregate describes an aggregation returned from OpenSearch.

AliasExistsDescriptor

Descriptor for AliasExists

<p>https://docs.opensearch.org/latest/</p>

AliasExistsRequest

Request for AliasExists

<p>https://docs.opensearch.org/latest/</p>

AliasPointingToIndexExtensions

AllocateClusterRerouteCommandBase

AllocateClusterRerouteCommandDescriptorBase<TDescriptor, TInterface>

AllocateEmptyPrimaryRerouteCommand

AllocateEmptyPrimaryRerouteCommandDescriptor

AllocateReplicaClusterRerouteCommand

AllocateReplicaClusterRerouteCommandDescriptor

AllocateStalePrimaryRerouteCommand

AllocateStalePrimaryRerouteCommandDescriptor

AllocationAttributesDescriptor

AllocationAwarenessSettingsDescriptor

AllocationFilteringSettingsDescriptor

AlternativeEnumMemberAttribute

Similar to EnumMemberAttribute, but allows an alternative string value to be specified for an enum field value.

AnalyzeDescriptor

Descriptor for Analyze

<p>https://docs.opensearch.org/latest/api-reference/analyze-apis/perform-text-analysis/</p>

AnalyzeRequest

Request for Analyze

<p>https://docs.opensearch.org/latest/api-reference/analyze-apis/perform-text-analysis/</p>

AnalyzeTokenFilters

A list of string references to stored token filters and/or inline token filter definitions

AnalyzerDescriptorBase<TAnalyzer, TAnalyzerInterface>

ArbitraryBodyHttpRequestBase<TParams>

ArbitraryBodyHttpRequestDescriptorBase<TSelf, TParams, TInterface>

ArbitraryHttpRequestBase<TParams>

ArbitraryHttpRequestDescriptorBase<TSelf, TParams, TInterface>

AsciiFoldingTokenFilterDescriptor

Attachment

An attachment indexed with an ingest pipeline using the ingest-attachment plugin. Convenience class for working with attachment fields.

The ingest attachment plugin lets OpenSearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika. You can use the ingest attachment plugin as a replacement for the mapper attachment plugin.

AttachmentProcessorDescriptor<T>

AutoDateHistogramAggregate

AutoDateHistogramAggregation

AutoDateHistogramAggregationDescriptor<T>

AutoExpandReplicas

AverageAggregation

AverageAggregationDescriptor<T>

AverageBucketAggregation

AverageBucketAggregationDescriptor

AzureRepository

AzureRepositoryDescriptor

A snapshot repository that stores snapshots in an Azure storage account

Requires the repository-azure plugin to be installed on the cluster

AzureRepositorySettings

AzureRepositorySettingsDescriptor

BM25Similarity

BM25SimilarityDescriptor

BinaryAttribute

BinaryProperty

BinaryPropertyDescriptor<T>

BlockedIndex

BlockingSubscribeExtensions

BoolQuery

BoolQueryDescriptor<T>

BooleanAttribute

BooleanProperty

BooleanPropertyDescriptor<T>

BoostingQuery

BoostingQueryDescriptor<T>

BoundingBox

BoundingBoxDescriptor

BreakerStats

BucketAggregate

Intermediate Aggregation response, transformed to a more specific aggregation response when requested.

BucketAggregateBase

BucketAggregationBase

BucketAggregationDescriptorBase<TBucketAggregation, TBucketAggregationInterface, T>

BucketBase

BucketScriptAggregation

BucketScriptAggregationDescriptor

BucketSelectorAggregation

BucketSelectorAggregationDescriptor

BucketSortAggregation

A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation. Zero or more sort fields may be specified together with the corresponding sort order. Each bucket may be sorted based on its _key, _count or its sub-aggregations. In addition, parameters from and size may be set in order to truncate the result buckets.

BucketSortAggregationDescriptor<T>

Buckets

BucketsDescriptor

BulkAliasDescriptor

Descriptor for BulkAlias

<p>https://docs.opensearch.org/latest/api-reference/index-apis/alias/</p>

BulkAliasRequest

Request for BulkAlias

<p>https://docs.opensearch.org/latest/api-reference/index-apis/alias/</p>

BulkAliasResponse

BulkAllDescriptor<T>

BulkAllObservable<T>

BulkAllObserver

BulkAllRequest<T>

BulkAllResponse

BulkCreateDescriptor<T>

BulkCreateOperation<T>

BulkCreateResponseItem

BulkDeleteDescriptor<T>

BulkDeleteOperation<T>

BulkDeleteResponseItem

BulkDescriptor

Descriptor for Bulk

<p>https://docs.opensearch.org/latest/api-reference/document-apis/bulk/</p>

BulkIndexByScrollFailure

BulkIndexDescriptor<T>

BulkIndexOperation<T>

BulkIndexResponseItem

BulkOperationBase

BulkOperationDescriptorBase<TDescriptor, TInterface>

BulkOperationsCollection<TOperation>

This class is used by Operations which needs thread safe adding Add(T) as well as expose an equivalent of AddRange(IEnumerable<T>). Because operations from OpenSearch are executed in order none of the types in System.Collection.Concurrent can't be used for this. We need to preserve insert order and exposed indexed index because Items is ordered and lines up with Operations allowing one to zip the two together.

BulkRequest

Request for Bulk

<p>https://docs.opensearch.org/latest/api-reference/document-apis/bulk/</p>

BulkResponse

BulkResponseItemBase

An item within a bulk response

BulkStreamDescriptor

Descriptor for BulkStream

<p>https://docs.opensearch.org/latest/api-reference/document-apis/bulk-streaming/</p>

BulkStreamRequest

Request for BulkStream

<p>https://docs.opensearch.org/latest/api-reference/document-apis/bulk-streaming/</p>

BulkStreamResponse

BulkUpdateDescriptor<TDocument, TPartialDocument>

BulkUpdateOperation<TDocument, TPartialDocument>

BulkUpdateResponseItem

ByteBuffer

ByteBufferDescriptor

BytesProcessor

Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.

BytesProcessorDescriptor<T>

CancelClusterRerouteCommand

CancelClusterRerouteCommandDescriptor

CancelTasksDescriptor

Descriptor for Cancel

<p>https://docs.opensearch.org/latest/api-reference/tasks/cancel-tasks/</p>

CancelTasksRequest

Request for Cancel

<p>https://docs.opensearch.org/latest/api-reference/tasks/cancel-tasks/</p>

CancelTasksResponse

CardinalityAggregation

CardinalityAggregationDescriptor<T>

CartesianPoint

Represents a point in the cartesian plane.

CatAliasesDescriptor

Descriptor for Aliases

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-aliases/</p>

CatAliasesRecord

CatAliasesRequest

Request for Aliases

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-aliases/</p>

CatAllPitSegmentsDescriptor

Descriptor for AllPitSegments

<p>https://docs.opensearch.org/latest/search-plugins/point-in-time-api/</p>

CatAllPitSegmentsRecord

CatAllPitSegmentsRequest

Request for AllPitSegments

<p>https://docs.opensearch.org/latest/search-plugins/point-in-time-api/</p>

CatAllocationDescriptor

Descriptor for Allocation

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-allocation/</p>

CatAllocationRecord

CatAllocationRequest

Request for Allocation

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-allocation/</p>

CatClusterManagerDescriptor

Descriptor for ClusterManager

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-cluster_manager/</p>

CatClusterManagerRecord

See docs here

CatClusterManagerRequest

Request for ClusterManager

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-cluster_manager/</p>

CatCountDescriptor

Descriptor for Count

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-count/</p>

CatCountRecord

CatCountRequest

Request for Count

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-count/</p>

CatFielddataDescriptor

Descriptor for Fielddata

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-field-data/</p>

CatFielddataRecord

CatFielddataRequest

Request for Fielddata

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-field-data/</p>

CatHealthDescriptor

Descriptor for Health

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-health/</p>

CatHealthRecord

CatHealthRequest

Request for Health

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-health/</p>

CatHelpDescriptor

Descriptor for Help

<p>https://docs.opensearch.org/latest/api-reference/cat/index/</p>

CatHelpRecord

CatHelpRequest

Request for Help

<p>https://docs.opensearch.org/latest/api-reference/cat/index/</p>

CatIndicesDescriptor

Descriptor for Indices

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-indices/</p>

CatIndicesRecord

CatIndicesRequest

Request for Indices

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-indices/</p>

CatMasterDescriptor

Descriptor for Master

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-cluster_manager/</p>

CatMasterRecord

See docs here

CatMasterRequest

Request for Master

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-cluster_manager/</p>

CatNodeAttributesDescriptor

Descriptor for NodeAttributes

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-nodeattrs/</p>

CatNodeAttributesRecord

CatNodeAttributesRequest

Request for NodeAttributes

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-nodeattrs/</p>

CatNodesDescriptor

Descriptor for Nodes

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-nodes/</p>

CatNodesRecord

CatNodesRequest

Request for Nodes

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-nodes/</p>

CatPendingTasksDescriptor

Descriptor for PendingTasks

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-pending-tasks/</p>

CatPendingTasksRecord

CatPendingTasksRequest

Request for PendingTasks

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-pending-tasks/</p>

CatPitSegmentsDescriptor

Descriptor for PitSegments

<p>https://docs.opensearch.org/latest/search-plugins/point-in-time-api/</p>

CatPitSegmentsRecord

CatPitSegmentsRequest

Request for PitSegments

<p>https://docs.opensearch.org/latest/search-plugins/point-in-time-api/</p>

CatPluginsDescriptor

Descriptor for Plugins

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-plugins/</p>

CatPluginsRecord

CatPluginsRequest

Request for Plugins

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-plugins/</p>

CatRecoveryDescriptor

Descriptor for Recovery

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-plugins/</p>

CatRecoveryRecord

CatRecoveryRequest

Request for Recovery

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-plugins/</p>

CatRepositoriesDescriptor

Descriptor for Repositories

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-repositories/</p>

CatRepositoriesRecord

CatRepositoriesRequest

Request for Repositories

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-repositories/</p>

CatResponse<TCatRecord>

CatSegmentReplicationDescriptor

Descriptor for SegmentReplication

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-segment-replication/</p>

CatSegmentReplicationRecord

CatSegmentReplicationRequest

Request for SegmentReplication

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-segment-replication/</p>

CatSegmentsDescriptor

Descriptor for Segments

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-segments/</p>

CatSegmentsRecord

CatSegmentsRequest

Request for Segments

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-segments/</p>

CatShardsDescriptor

Descriptor for Shards

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-shards/</p>

CatShardsRecord

CatShardsRequest

Request for Shards

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-shards/</p>

CatSnapshotsDescriptor

Descriptor for Snapshots

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-snapshots/</p>

CatSnapshotsRecord

CatSnapshotsRequest

Request for Snapshots

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-snapshots/</p>

CatTasksDescriptor

Descriptor for Tasks

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-tasks/</p>

CatTasksRecord

CatTasksRequest

Request for Tasks

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-tasks/</p>

CatTemplatesDescriptor

Descriptor for Templates

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-templates/</p>

CatTemplatesRecord

CatTemplatesRequest

Request for Templates

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-templates/</p>

CatThreadPoolDescriptor

Descriptor for ThreadPool

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-thread-pool/</p>

CatThreadPoolRecord

CatThreadPoolRequest

Request for ThreadPool

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-thread-pool/</p>

CategorySuggestContext

CategorySuggestContextDescriptor<T>

CharFilterBase

CharFilterDescriptorBase<TCharFilter, TCharFilterInterface>

CharFilterDetail

CharFilters

CharFiltersDescriptor

CharGroupTokenizer

A tokenizer that breaks text into terms whenever it encounters a character which is in a defined set. It is mostly useful for cases where a simple custom tokenization is desired, and the overhead of use of PatternTokenizer is not acceptable.

CharGroupTokenizerDescriptor

ChiSquareHeuristic

ChiSquareHeuristicDescriptor

Children

ChildrenAggregation

ChildrenAggregationDescriptor<T>

ChunkModelDescriptor

Descriptor for ChunkModel

ChunkModelRequest

Request for ChunkModel

ChunkModelResponse

CircleGeoShape

CircuitBreakerSettings

CircuitBreakerSettingsDescriptor

CleanupRepositoryDescriptor

Descriptor for CleanupRepository

<p>https://docs.opensearch.org/latest/</p>

CleanupRepositoryRequest

Request for CleanupRepository

<p>https://docs.opensearch.org/latest/</p>

CleanupRepositoryResponse

CleanupRepositoryResults

ClearCacheDescriptor

Descriptor for ClearCache

<p>https://docs.opensearch.org/latest/api-reference/index-apis/clear-index-cache/</p>

ClearCacheRequest

Request for ClearCache

<p>https://docs.opensearch.org/latest/api-reference/index-apis/clear-index-cache/</p>

ClearCacheResponse

ClearScrollDescriptor

Descriptor for ClearScroll

<p>https://docs.opensearch.org/latest/api-reference/scroll/</p>

ClearScrollRequest

Request for ClearScroll

<p>https://docs.opensearch.org/latest/api-reference/scroll/</p>

ClearScrollResponse

ClientConfig

ClientConfigDescriptor

CloneIndexDescriptor

A request to the clone index API

CloneIndexRequest

A request to the clone index API

CloneIndexResponse

CloneSnapshotDescriptor

Descriptor for Clone

<p>https://docs.opensearch.org/latest/</p>

CloneSnapshotRequest

Request for Clone

<p>https://docs.opensearch.org/latest/</p>

CloneSnapshotResponse

CloseIndexDescriptor

Descriptor for Close

<p>https://docs.opensearch.org/latest/api-reference/index-apis/close-index/</p>

CloseIndexRequest

Request for Close

<p>https://docs.opensearch.org/latest/api-reference/index-apis/close-index/</p>

CloseIndexResponse

CloseIndexResult

CloseShardResult

ClrPropertyMappingBase<TDocument>

ClrTypeMapping

ClrTypeMappingDescriptor

ClrTypeMappingDescriptor<TDocument>

ClrTypeMapping<TDocument>

ClusterAllocationExplainDescriptor

Descriptor for AllocationExplain

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/cluster-allocation/</p>

ClusterAllocationExplainRequest

Request for AllocationExplain

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/cluster-allocation/</p>

ClusterAllocationExplainResponse

ClusterFileSystem

ClusterGetSettingsDescriptor

Descriptor for GetSettings

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/cluster-settings/</p>

ClusterGetSettingsRequest

Request for GetSettings

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/cluster-settings/</p>

ClusterGetSettingsResponse

ClusterHealthDescriptor

Descriptor for Health

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/cluster-health/</p>

ClusterHealthRequest

Request for Health

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/cluster-health/</p>

ClusterHealthResponse

ClusterIndicesShardsIndexStats

ClusterIndicesShardsStats

ClusterIndicesStats

ClusterIngestStats

ClusterJvm

ClusterJvmMemory

ClusterJvmVersion

ClusterModuleSettings

ClusterModuleSettingsDescriptor

ClusterNetworkTypes

ClusterNodeCount

ClusterNodesStats

ClusterOperatingSystemName

ClusterOperatingSystemPrettyName

ClusterOperatingSystemStats

ClusterPendingTasksDescriptor

Descriptor for PendingTasks

<p>https://docs.opensearch.org/latest/</p>

ClusterPendingTasksRequest

Request for PendingTasks

<p>https://docs.opensearch.org/latest/</p>

ClusterPendingTasksResponse

ClusterProcess

ClusterProcessCpu

ClusterProcessOpenFileDescriptors

ClusterProcessorStats

ClusterPutSettingsDescriptor

Descriptor for PutSettings

<p>https://docs.opensearch.org/latest/api-reference/cluster-settings/</p>

ClusterPutSettingsRequest

Request for PutSettings

<p>https://docs.opensearch.org/latest/api-reference/cluster-settings/</p>

ClusterPutSettingsResponse

ClusterRerouteDecision

ClusterRerouteDescriptor

Descriptor for Reroute

<p>https://docs.opensearch.org/latest/</p>

ClusterRerouteExplanation

ClusterRerouteParameters

ClusterRerouteRequest

Request for Reroute

<p>https://docs.opensearch.org/latest/</p>

ClusterRerouteResponse

ClusterShardMetrics

ClusterStateDescriptor

Descriptor for State

<p>https://docs.opensearch.org/latest/</p>

ClusterStateRequest

Request for State

<p>https://docs.opensearch.org/latest/</p>

ClusterStateResponse

ClusterStatistics

ClusterStatsDescriptor

Descriptor for Stats

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/cluster-stats/</p>

ClusterStatsRequest

Request for Stats

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/cluster-stats/</p>

ClusterStatsResponse

CollapseResponseProcessor

CollapseResponseProcessorDescriptor

Collector

ColumnMeta

ColumnMetaDescriptor

CombinedFieldsQuery

The combined_fields query supports searching multiple text fields as if their contents had been indexed into one combined field. The query analyzes the provided text before performing a search, and it scores documents using a term-centric approach that treats the matched fields as a single field.

All queried fields must have the same search analyzer. Only text fields are supported.

CombinedFieldsQueryDescriptor<T>

All queried fields must have the same search analyzer. Only text fields are supported.

CommonGramsTokenFilter

CommonGramsTokenFilterDescriptor

CompactNodeInfo

CompletionAttribute

CompletionField

A field mapped as an ICompletionProperty. Convenience class to use when indexing completion fields.

CompletionProperty

CompletionPropertyDescriptor<T>

CompletionStats

CompletionSuggester

The completion suggester provides auto-complete/search-as-you-type functionality. This is a navigational feature to guide users to relevant results as they are typing, improving search precision. It is not meant for spell correction or did-you-mean functionality like the term or phrase suggesters.

CompletionSuggesterDescriptor<T>

ComponentTemplate

ComponentTemplateExistsDescriptor

Descriptor for ComponentTemplateExists

<p>https://docs.opensearch.org/latest/</p>

ComponentTemplateExistsRequest

Request for ComponentTemplateExists

<p>https://docs.opensearch.org/latest/</p>

ComposableIndexTemplate

ComposableIndexTemplateExistsDescriptor

Descriptor for ComposableTemplateExists

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/</p>

ComposableIndexTemplateExistsRequest

Request for ComposableTemplateExists

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/</p>

CompositeAggregation

A multi-bucket aggregation that creates composite buckets from different sources.

CompositeAggregationDescriptor<T>

A multi-bucket aggregation that creates composite buckets from different sources.

CompositeAggregationSourceBase

CompositeAggregationSourceDescriptorBase<TDescriptor, TInterface, T>

A values source for ICompositeAggregation

CompositeAggregationSourcesDescriptor<T>

A values source for ICompositeAggregation

CompositeBucket

A bucket with a composite key

CompositeBucketAggregate

Aggregation response of CompositeAggregation

CompositeKey

A key for a CompositeBucket

CompoundWordTokenFilterBase

CompoundWordTokenFilterDescriptorBase<TCompound, TCompoundInterface>

ConditionTokenFilter

The conditional token filter takes a predicate script and a list of subfilters, and only applies the subfilters to the current token if it matches the predicate.

ConditionTokenFilterDescriptor

The conditional token filter takes a predicate script and a list of subfilters, and only applies the subfilters to the current token if it matches the predicate.

ConditionlessQueryDescriptor<T>

ConnectionSettings

Provides the connection settings for OpenSearchClient

ConstantScoreQuery

ConstantScoreQueryDescriptor<T>

Content

ContentDescriptor

Context

ContextScriptStats

ConvertProcessor

ConvertProcessorDescriptor<T>

CoordinatedRequestObserverBase<T>

CorePropertyBase

Core properties of a mapping for a property type to a document field in OpenSearch

CorePropertyDescriptorBase<TDescriptor, TInterface, T>

Core properties of a mapping for a property type to a document field in OpenSearch

CountDescriptor<TDocument>

Descriptor for Count

<p>https://docs.opensearch.org/latest/api-reference/count/</p>

CountRequest

Request for Count

<p>https://docs.opensearch.org/latest/api-reference/count/</p>

CountRequest<TDocument>

CountResponse

CreateConnectorDescriptor

Descriptor for CreateConnector

CreateConnectorRequest

Request for CreateConnector

CreateConnectorResponse

CreateControllerDescriptor

Descriptor for CreateController

CreateControllerRequest

Request for CreateController

CreateControllerResponse

CreateDescriptor<TDocument>

Descriptor for Create

<p>https://docs.opensearch.org/latest/api-reference/document-apis/index-document/</p>

CreateIndexDescriptor

Descriptor for Create

<p>https://docs.opensearch.org/latest/api-reference/index-apis/create-index/</p>

CreateIndexRequest

Request for Create

<p>https://docs.opensearch.org/latest/api-reference/index-apis/create-index/</p>

CreateIndexResponse

CreateMemoryContainerDescriptor

Descriptor for CreateMemoryContainer

CreateMemoryContainerRequest

Request for CreateMemoryContainer

CreateMemoryContainerResponse

CreateMemoryContainerSessionDescriptor

Descriptor for CreateMemoryContainerSession

CreateMemoryContainerSessionRequest

Request for CreateMemoryContainerSession

CreateMemoryContainerSessionResponse

CreateMemoryDescriptor

Descriptor for CreateMemory

CreateMemoryRequest

Request for CreateMemory

CreateMemoryResponse

CreateMessageDescriptor

Descriptor for CreateMessage

CreateMessageRequest

Request for CreateMessage

CreateMessageResponse

CreateModelMetaDescriptor

Descriptor for CreateModelMeta

CreateModelMetaRequest

Request for CreateModelMeta

CreateModelMetaResponse

CreatePitDescriptor

Descriptor for CreatePit

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#create-a-pit</p>

CreatePitRequest

Request for CreatePit

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#create-a-pit</p>

CreatePitResponse

CreateRepositoryDescriptor

Creates a snapshot repository

CreateRepositoryRequest

Creates a snapshot repository

CreateRepositoryResponse

CreateRequest<TDocument>

Request for Create

<p>https://docs.opensearch.org/latest/api-reference/document-apis/index-document/</p>

CreateResponse

Credential

CredentialDescriptor

CsvProcessor

Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.

CsvProcessorDescriptor<T>

Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.

CumulativeSumAggregation

CumulativeSumAggregationDescriptor

CurrentNode

CustomAnalyzer

CustomAnalyzerDescriptor

CustomNormalizer

CustomNormalizerDescriptor

CustomSimilarity

CustomSimilarityDescriptor

DFISimilarity

DFISimilarityDescriptor

DFRSimilarity

DFRSimilarityDescriptor

DataAsMap

DataAsMapDescriptor

DataStreamTemplate

DataStreamTemplateDescriptor

DateAttribute

DateFormat

DateHistogramAggregation

DateHistogramAggregationDescriptor<T>

DateHistogramBucket

DateHistogramCompositeAggregationSource

A values source that can be applied on date values to build fixed size interval over the values. The interval parameter defines a date/time expression that determines how values should be transformed. For instance an interval set to month will translate any values to its closest month interval..

DateHistogramCompositeAggregationSourceDescriptor<T>

DateIndexNameProcessor

DateIndexNameProcessorDescriptor<T>

DateMath

DateMathExpression

DateMathOperationExtensions

DateMathTime

A time representation for use within DateMath expressions.

DateMathTimeUnitExtensions

DateNanosAttribute

DateNanosProperty

DateNanosPropertyDescriptor<T>

DateProcessor

DateProcessorDescriptor<T>

DateProperty

DatePropertyDescriptor<T>

DateRange

DateRangeAggregation

DateRangeAggregationDescriptor<T>

DateRangeAttribute

DateRangeExpression

DateRangeExpressionDescriptor

DateRangeProperty

A range of date values represented as unsigned 64-bit integer milliseconds elapsed since system epoch.

DateRangePropertyDescriptor<T>

A range of date values represented as unsigned 64-bit integer milliseconds elapsed since system epoch.

DateRangeQuery

DateRangeQueryDescriptor<T>

DecayFunctionBase<TOrigin, TScale>

DecayFunctionDescriptorBase<TDescriptor, TOrigin, TScale, T>

DeleteAgentDescriptor

Descriptor for DeleteAgent

DeleteAgentRequest

Request for DeleteAgent

DeleteAgentResponse

DeleteAgenticMemoryDescriptor

Descriptor for DeleteAgenticMemory

DeleteAgenticMemoryQueryDescriptor

Descriptor for DeleteAgenticMemoryQuery

DeleteAgenticMemoryQueryRequest

Request for DeleteAgenticMemoryQuery

DeleteAgenticMemoryQueryResponse

DeleteAgenticMemoryRequest

Request for DeleteAgenticMemory

DeleteAgenticMemoryResponse

DeleteAliasDescriptor

Descriptor for DeleteAlias

<p>https://docs.opensearch.org/latest/api-reference/alias/delete-alias/</p>

DeleteAliasRequest

Request for DeleteAlias

<p>https://docs.opensearch.org/latest/api-reference/alias/delete-alias/</p>

DeleteAliasResponse

DeleteAllPitsDescriptor

Descriptor for DeleteAllPits

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#delete-pits</p>

DeleteAllPitsRequest

Request for DeleteAllPits

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#delete-pits</p>

DeleteAllPitsResponse

DeleteByQueryDescriptor<TDocument>

Delete documents that match a given query

DeleteByQueryRequest

Delete documents that match a given query

DeleteByQueryRequest<TDocument>

Delete documents that match a given query

DeleteByQueryResponse

DeleteByQueryRethrottleDescriptor

Rethrottles a running delete by query

DeleteByQueryRethrottleRequest

Rethrottles a running delete by query

DeleteComponentTemplateDescriptor

Descriptor for DeleteComponentTemplate

<p>https://docs.opensearch.org/latest/</p>

DeleteComponentTemplateRequest

Request for DeleteComponentTemplate

<p>https://docs.opensearch.org/latest/</p>

DeleteComponentTemplateResponse

DeleteComposableIndexTemplateDescriptor

Descriptor for DeleteComposableTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/#delete-a-template</p>

DeleteComposableIndexTemplateRequest

Request for DeleteComposableTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/#delete-a-template</p>

DeleteComposableIndexTemplateResponse

DeleteConnectorDescriptor

Descriptor for DeleteConnector

DeleteConnectorRequest

Request for DeleteConnector

DeleteConnectorResponse

DeleteControllerDescriptor

Descriptor for DeleteController

DeleteControllerRequest

Request for DeleteController

DeleteControllerResponse

DeleteDanglingIndexDescriptor

Descriptor for DeleteDanglingIndex

<p>https://docs.opensearch.org/latest/api-reference/index-apis/dangling-index/</p>

DeleteDanglingIndexRequest

Request for DeleteDanglingIndex

<p>https://docs.opensearch.org/latest/api-reference/index-apis/dangling-index/</p>

DeleteDanglingIndexResponse

DeleteDescriptor<TDocument>

Descriptor for Delete

<p>https://docs.opensearch.org/latest/api-reference/document-apis/delete-document/</p>

DeleteExperimentsDescriptor

Descriptor for DeleteExperiments

DeleteExperimentsRequest

Request for DeleteExperiments

DeleteExperimentsResponse

DeleteIndexDescriptor

Descriptor for Delete

<p>https://docs.opensearch.org/latest/api-reference/index-apis/delete-index/</p>

DeleteIndexRequest

Request for Delete

<p>https://docs.opensearch.org/latest/api-reference/index-apis/delete-index/</p>

DeleteIndexResponse

DeleteIndexTemplateDescriptor

Descriptor for DeleteTemplate

<p>https://docs.opensearch.org/latest/</p>

DeleteIndexTemplateRequest

Request for DeleteTemplate

<p>https://docs.opensearch.org/latest/</p>

DeleteIndexTemplateResponse

DeleteJudgmentsDescriptor

Descriptor for DeleteJudgments

DeleteJudgmentsRequest

Request for DeleteJudgments

DeleteJudgmentsResponse

DeleteManyExtensions

Provides DeleteMany extensions that make it easier to get many documents given a list of ids

DeleteMemoryContainerDescriptor

Descriptor for DeleteMemoryContainer

DeleteMemoryContainerRequest

Request for DeleteMemoryContainer

DeleteMemoryContainerResponse

DeleteMemoryDescriptor

Descriptor for DeleteMemory

DeleteMemoryRequest

Request for DeleteMemory

DeleteMemoryResponse

DeleteModelDescriptor

Descriptor for DeleteModel

DeleteModelGroupDescriptor

Descriptor for DeleteModelGroup

DeleteModelGroupRequest

Request for DeleteModelGroup

DeleteModelGroupResponse

DeleteModelRequest

Request for DeleteModel

DeleteModelResponse

DeletePipelineDescriptor

Descriptor for DeletePipeline

<p>https://docs.opensearch.org/latest/api-reference/ingest-apis/delete-ingest/</p>

DeletePipelineRequest

Request for DeletePipeline

<p>https://docs.opensearch.org/latest/api-reference/ingest-apis/delete-ingest/</p>

DeletePipelineResponse

DeletePitDescriptor

Descriptor for DeletePit

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#delete-pits</p>

DeletePitRequest

Request for DeletePit

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#delete-pits</p>

DeletePitResponse

DeleteQuerySetsDescriptor

Descriptor for DeleteQuerySets

DeleteQuerySetsRequest

Request for DeleteQuerySets

DeleteQuerySetsResponse

DeleteRepositoryDescriptor

Descriptor for DeleteRepository

<p>https://docs.opensearch.org/latest/api-reference/snapshots/delete-snapshot-repository/</p>

DeleteRepositoryRequest

Request for DeleteRepository

<p>https://docs.opensearch.org/latest/api-reference/snapshots/delete-snapshot-repository/</p>

DeleteRepositoryResponse

DeleteRequest

Request for Delete

<p>https://docs.opensearch.org/latest/api-reference/document-apis/delete-document/</p>

DeleteRequest<TDocument>

DeleteResponse

DeleteScheduledExperimentsDescriptor

Descriptor for DeleteScheduledExperiments

DeleteScheduledExperimentsRequest

Request for DeleteScheduledExperiments

DeleteScheduledExperimentsResponse

DeleteScriptDescriptor

Descriptor for DeleteScript

<p>https://docs.opensearch.org/latest/api-reference/script-apis/delete-script/</p>

DeleteScriptRequest

Request for DeleteScript

<p>https://docs.opensearch.org/latest/api-reference/script-apis/delete-script/</p>

DeleteScriptResponse

DeleteSearchConfigurationsDescriptor

Descriptor for DeleteSearchConfigurations

DeleteSearchConfigurationsRequest

Request for DeleteSearchConfigurations

DeleteSearchConfigurationsResponse

DeleteSearchPipelineDescriptor

Descriptor for Delete

DeleteSearchPipelineRequest

Request for Delete

DeleteSearchPipelineResponse

DeleteSnapshotDescriptor

Descriptor for Delete

<p>https://docs.opensearch.org/latest/api-reference/snapshots/delete-snapshot/</p>

DeleteSnapshotRequest

Request for Delete

<p>https://docs.opensearch.org/latest/api-reference/snapshots/delete-snapshot/</p>

DeleteSnapshotResponse

DeleteTaskDescriptor

Descriptor for DeleteTask

DeleteTaskRequest

Request for DeleteTask

DeleteTaskResponse

DeleteVotingConfigExclusionsDescriptor

Descriptor for DeleteVotingConfigExclusions

<p>https://docs.opensearch.org/latest/</p>

DeleteVotingConfigExclusionsRequest

Request for DeleteVotingConfigExclusions

<p>https://docs.opensearch.org/latest/</p>

DeleteVotingConfigExclusionsResponse

DeletedPit

DelimitedPayloadTokenFilter

DelimitedPayloadTokenFilterDescriptor

DeployModelDescriptor

Descriptor for DeployModel

DeployModelRequest

Request for DeployModel

DeployModelResponse

DerivativeAggregation

DerivativeAggregationDescriptor

DescriptorBase<TDescriptor, TInterface>

DescriptorPromiseBase<TDescriptor, TValue>

DictionaryDecompounderTokenFilter

DictionaryDecompounderTokenFilterDescriptor

DictionaryResponseBase<TKey, TValue>

DirectGenerator

DirectGeneratorDescriptor<T>

DisMaxQuery

DisMaxQueryDescriptor<T>

DiskBasedShardAllocationSettings

DiskBasedShardAllocationSettingsDescriptor

DissectProcessor

Similar to the Grok Processor, dissect also extracts structured fields out of a single text field within a document. However unlike the Grok Processor, dissect does not use Regular Expressions. This allows dissect’s syntax to be simple and, for some cases faster, than the Grok Processor.

DissectProcessorDescriptor<T>

Distance

DistanceFeatureQuery

Boosts the relevance score of documents closer to a provided origin date or point. For example, you can use this query to give more weight to documents closer to a certain date or location. You can use the distance_feature query to find the nearest neighbors to a location. You can also use the query in a bool search’s should filter to add boosted relevance scores to the bool query’s scores.

DistanceFeatureQueryDescriptor<T>

DiversifiedSamplerAggregation

DiversifiedSamplerAggregationDescriptor<T>

DocStats

DocValuesPropertyBase

Properties of a mapping for a property type to a document field that has doc_values in OpenSearch

DocValuesPropertyDescriptorBase<TDescriptor, TInterface, T>

Properties of a mapping for a property type to a document field that has doc_values in OpenSearch

DocumentExistsDescriptor<TDocument>

Descriptor for DocumentExists

<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>

DocumentExistsRequest

Request for DocumentExists

<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>

DocumentExistsRequest<TDocument>

DocumentPath<T>

DocumentSimulation

DotExpanderProcessor

Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor.

DotExpanderProcessorDescriptor<T>

DoubleRange

DoubleRangeAttribute

DoubleRangeProperty

A range of double-precision 64-bit IEEE 754 floating point values.

DoubleRangePropertyDescriptor<T>

A range of double-precision 64-bit IEEE 754 floating point values.

DropProcessor

Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.

DropProcessorDescriptor

Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.

DslPrettyPrintVisitor

DynamicIndexSettings

DynamicIndexSettingsDescriptor

Dynamic index settings

DynamicIndexSettingsDescriptorBase<TDescriptor, TIndexSettings>

Base descriptor implementation for dynamic index settings

DynamicResponseBase

DynamicTemplate

DynamicTemplateContainer

DynamicTemplateContainerDescriptor<T>

DynamicTemplateDescriptor<T>

A Dynamic template that defines custom mappings to be applied to dynamically added fields based on:

the datatype detected by OpenSearch, with MatchMappingType.

the name of the field, with Match and Unmatch or MatchPattern.

the full dotted path to the field, with PathMatch and PathUnmatch.

EdgeNGramTokenFilter

EdgeNGramTokenFilterDescriptor

EdgeNGramTokenizer

EdgeNGramTokenizerDescriptor

ElisionTokenFilter

A token filter which removes elisions. For example, “l’avion” (the plane) will tokenized as “avion” (plane).

ElisionTokenFilterDescriptor

A token filter which removes elisions. For example, “l’avion” (the plane) will tokenized as “avion” (plane).

Entity

EntityDescriptor

EnvelopeGeoShape

EpochDateTimeAttribute

Signals that this date time property returns the date as epoch.

EwmaModel

EwmaModelDescriptor

ExecuteAgentDescriptor

Descriptor for ExecuteAgent

ExecuteAgentRequest

Request for ExecuteAgent

ExecuteAgentResponse

ExecuteAlgorithmDescriptor

Descriptor for ExecuteAlgorithm

ExecuteAlgorithmRequest

Request for ExecuteAlgorithm

ExecuteAlgorithmResponse

ExecuteAnomalyLocalizationResponse

ExecuteAnomalyLocalizationResponseDescriptor

ExecuteLocalSampleCalculatorResponse

ExecuteLocalSampleCalculatorResponseDescriptor

ExecutePainlessScriptDescriptor

The Painless execute API allows an arbitrary script to be executed and a result to be returned.

ExecutePainlessScriptRequest

The Painless execute API allows an arbitrary script to be executed and a result to be returned.

ExecutePainlessScriptResponse<TResult>

ExecuteToolDescriptor

Descriptor for ExecuteTool

ExecuteToolRequest

Request for ExecuteTool

ExecuteToolResponse

ExistsQuery

ExistsQueryDescriptor<T>

ExistsResponse

ExperimentsSearchDescriptor

Descriptor for ExperimentsSearch

ExperimentsSearchRequest

Request for ExperimentsSearch

ExperimentsSearchResponse

ExplainAnalyzeToken

ExplainDescriptor<TDocument>

Descriptor for Explain

<p>https://docs.opensearch.org/latest/api-reference/explain/</p>

ExplainRequest

Request for Explain

<p>https://docs.opensearch.org/latest/api-reference/explain/</p>

ExplainRequest<TDocument>

ExplainResponse<TDocument>

Explanation

ExplanationDetail

ExponentialDateDecayFunction

ExponentialDecayFunction

ExponentialDecayFunctionBase<TOrigin, TScale>

ExponentialDecayFunctionDescriptor<TOrigin, TScale, T>

ExponentialGeoDecayFunction

ExpressionExtensions

ExtendedBounds<T>

ExtendedStatsAggregate

ExtendedStatsAggregation

ExtendedStatsAggregationDescriptor<T>

ExtendedStatsBucketAggregation

ExtendedStatsBucketAggregationDescriptor

FailProcessor

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

FailProcessorDescriptor

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

Field

FieldAliasProperty

An alias mapping defines an alternate name for a field in the index. The alias can be used in place of the target field in search requests, and selected other APIs like field capabilities.

FieldAliasPropertyDescriptor<T>

An alias mapping defines an alternate name for a field in the index. The alias can be used in place of the target field in search requests, and selected other APIs like field capabilities.

FieldCapabilities

FieldCapabilitiesDescriptor

Descriptor for FieldCapabilities

<p>https://docs.opensearch.org/latest/mappings/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations</p>

FieldCapabilitiesFields

FieldCapabilitiesRequest

Request for FieldCapabilities

<p>https://docs.opensearch.org/latest/mappings/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations</p>

FieldCapabilitiesResponse

FieldCollapse

Allows to collapse search results based on field values. The collapsing is done by selecting only the top sorted document per collapse key. For instance the query below retrieves the best tweet for each user and sorts them by number of likes.

NOTE: The collapsing is applied to the top hits only and does not affect aggregations.

FieldCollapseDescriptor<T>

NOTE: The collapsing is applied to the top hits only and does not affect aggregations.

FieldLookup

FieldLookupDescriptor<T>

FieldMapping

FieldNameQueryBase

FieldNameQueryDescriptorBase<TDescriptor, TInterface, T>

FieldNamesField

FieldNamesFieldDescriptor<T>

FieldResolver

FieldSort

FieldSortDescriptor<T>

FieldStatistics

FieldTypes

FieldValueFactorFunction

FieldValueFactorFunctionDescriptor<T>

FieldValues

FielddataBase

FielddataDescriptorBase<TDescriptor, TInterface>

FielddataFilter

FielddataFilterDescriptor

FielddataFrequencyFilter

FielddataFrequencyFilterDescriptor

FielddataRegexFilter

FielddataRegexFilterDescriptor

FielddataSettings

FielddataStats

Fields

FieldsDescriptor<T>

FileCountSnapshotStats

FileSystemRepository

FileSystemRepositoryDescriptor

A snapshot repository that uses a shared file system to store snapshot data. The path specified in the location parameter should point to the same location in the shared filesystem and be accessible on all data and cluster_manager nodes.

FileSystemRepositorySettings

Repository settings for IFileSystemRepository

FileSystemRepositorySettingsDescriptor

Repository settings for IFileSystemRepository

FileSystemStats

FileSystemStats.DataPathStats

FileSystemStats.TotalFileSystemStats

FilterAggregation

FilterAggregationDescriptor<T>

FilterQueryRequestProcessor

FilterQueryRequestProcessorDescriptor

FiltersAggregate

FiltersAggregation

FiltersAggregationDescriptor<T>

FiltersBucketItem

FingerprintAnalyzer

FingerprintAnalyzerDescriptor

FingerprintProcessor

FingerprintProcessorDescriptor<T>

FingerprintTokenFilter

FingerprintTokenFilterDescriptor

FixedIndexSettings

const string collection of known OpenSearch index settings that can only be provided at index creation time

FloatRange

FloatRangeAttribute

FloatRangeProperty

A range of single-precision 32-bit IEEE 754 floating point values.

FloatRangePropertyDescriptor<T>

A range of single-precision 32-bit IEEE 754 floating point values.

FluentDictionary<TKey, TValue>

FlushDescriptor

Descriptor for Flush

<p>https://docs.opensearch.org/latest/</p>

FlushRequest

Request for Flush

<p>https://docs.opensearch.org/latest/</p>

FlushResponse

FlushStats

ForceMergeDescriptor

Descriptor for ForceMerge

<p>https://docs.opensearch.org/latest/</p>

ForceMergeRequest

Request for ForceMerge

<p>https://docs.opensearch.org/latest/</p>

ForceMergeResponse

ForeachProcessor

Processes elements in an array of unknown length. All processors can operate on elements inside an array, but if all elements of an array need to be processed in the same way, defining a processor for each element becomes cumbersome and tricky because it is likely that the number of elements in an array is unknown. For this reason the foreach processor exists. By specifying the field holding array elements and a processor that defines what should happen to each element, array fields can easily be preprocessed.

ForeachProcessorDescriptor<T>

FormattableMetricAggregationBase

FormattableMetricAggregationDescriptorBase<TFormattableMetricAggregation, TFormattableMetricAggregationInterface, T>

FunctionScoreFunction

FunctionScoreFunctionBase

FunctionScoreFunctionDescriptorBase<TDescriptor, TInterface, T>

FunctionScoreFunctionDescriptor<T>

FunctionScoreQuery

FunctionScoreQueryDescriptor<T>

Fuzziness

FuzzyDateQuery

FuzzyDateQueryDescriptor<T>

FuzzyNumericQuery

FuzzyNumericQueryDescriptor<T>

FuzzyQuery

FuzzyQueryBase<TValue, TFuzziness>

FuzzyQueryDescriptorBase<TDescriptor, T, TValue, TFuzziness>

FuzzyQueryDescriptor<T>

GatewaySettings

GaussDateDecayFunction

GaussDecayFunction

GaussDecayFunctionBase<TOrigin, TScale>

GaussDecayFunctionDescriptor<TOrigin, TScale, T>

GaussGeoDecayFunction

GenericProperty

A generic property to map properties that may be of different types. Not all methods are valid for all types.

GenericPropertyDescriptor<T>

A generic property to map properties that may be of different types. Not all methods are valid for all types.

GeoBoundingBoxQuery

GeoBoundingBoxQueryDescriptor<T>

GeoBounds

GeoBoundsAggregate

GeoBoundsAggregation

GeoBoundsAggregationDescriptor<T>

GeoCentroidAggregate

GeoCentroidAggregation

GeoCentroidAggregationDescriptor<T>

GeoCoordinate

Represents a Latitude/Longitude and optional Z value as a 2 or 3 dimensional point that gets serialized as new [] { lon, lat, [z] }

GeoDistanceAggregation

GeoDistanceAggregationDescriptor<T>

GeoDistanceQuery

GeoDistanceQueryDescriptor<T>

GeoDistanceSort

Allows you to sort based on a proximity to one or more GeoLocation

GeoDistanceSortDescriptor<T>

Allows you to sort based on a proximity to one or more GeoLocation

GeoHashGridAggregation

A multi-bucket aggregation that works on geo_point fields and groups points into buckets that represent cells in a grid. The resulting grid can be sparse and only contains cells that have matching data. Each cell is labeled using a geohash which is of user-definable precision.

GeoHashGridAggregationDescriptor<T>

GeoIpProcessor

The GeoIP processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases. This processor adds this information by default under the geoip field. The geoip processor can resolve both IPv4 and IPv6 addresses.

GeoIpProcessorDescriptor<T>

GeoLineAggregate

GeoLineAggregation

GeoLineAggregationDescriptor<T>

GeoLinePoint

GeoLineProperties

GeoLineSort

GeoLocation

Represents a Latitude/Longitude as a 2 dimensional point that gets serialized as { lat, lon }

GeoPointAttribute

GeoPointFielddata

GeoPointFielddataDescriptor

GeoPointProperty

Data type mapping to map a property as a geopoint

GeoPointPropertyDescriptor<T>

Data type mapping to map a property as a geopoint

GeoPolygonQuery

GeoPolygonQueryDescriptor<T>

GeoShapeAttribute

Maps a property as a geo_shape field

GeoShapeBase

Base type for geo shapes

GeoShapeDescriptor

Descriptor for building a IGeoShape

GeoShapeProperty

Maps a property as a geo_shape field

GeoShapePropertyDescriptor<T>

Maps a property as a geo_shape field

GeoShapeQuery

GeoShapeQueryDescriptor<T>

GeoSuggestContext

GeoSuggestContextDescriptor<T>

GeoTileGridAggregation

GeoTileGridAggregationDescriptor<T>

GeoTileGridCompositeAggregationSource

A values source that is equivalent to a simple Geo aggregation.

GeoTileGridCompositeAggregationSourceDescriptor<T>

A values source that is equivalent to a simple Geo aggregation.

GeoWKTException

An exception when handling shapes in Well-Known Text (WKT) format

GeoWKTReader

Reads Well-Known Text (WKT) into IGeoShape types

GeoWKTWriter

Writes IGeoShape types to Well-Known Text (WKT)

GeometryCollection

A geo shape representing a collection of IGeoShape geometries

GetAgentDescriptor

Descriptor for GetAgent

GetAgentRequest

Request for GetAgent

GetAgentResponse

GetAgenticMemoryDescriptor

Descriptor for GetAgenticMemory

GetAgenticMemoryRequest

Request for GetAgenticMemory

GetAgenticMemoryResponse

GetAliasDescriptor

Descriptor for GetAlias

<p>https://docs.opensearch.org/latest/im-plugin/index-alias/</p>

GetAliasRequest

Request for GetAlias

<p>https://docs.opensearch.org/latest/im-plugin/index-alias/</p>

GetAliasResponse

GetAllMemoriesDescriptor

Descriptor for GetAllMemories

GetAllMemoriesRequest

Request for GetAllMemories

GetAllMemoriesResponse

GetAllMessagesDescriptor

Descriptor for GetAllMessages

GetAllMessagesRequest

Request for GetAllMessages

GetAllMessagesResponse

GetAllPitsDescriptor

Descriptor for GetAllPits

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#list-all-pits</p>

GetAllPitsRequest

Request for GetAllPits

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#list-all-pits</p>

GetAllPitsResponse

GetAllToolsDescriptor

Descriptor for GetAllTools

GetAllToolsRequest

Request for GetAllTools

GetAllToolsResponse

GetComponentTemplateDescriptor

Descriptor for GetComponentTemplate

<p>https://docs.opensearch.org/latest/</p>

GetComponentTemplateRequest

Request for GetComponentTemplate

<p>https://docs.opensearch.org/latest/</p>

GetComponentTemplateResponse

GetComposableIndexTemplateDescriptor

Descriptor for GetComposableTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/</p>

GetComposableIndexTemplateRequest

Request for GetComposableTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/</p>

GetComposableIndexTemplateResponse

GetConnectorDescriptor

Descriptor for GetConnector

GetConnectorRequest

Request for GetConnector

GetConnectorResponse

GetControllerDescriptor

Descriptor for GetController

GetControllerRequest

Request for GetController

GetControllerResponse

GetDescriptor<TDocument>

Descriptor for Get

<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>

GetExperimentsDescriptor

Descriptor for GetExperiments

GetExperimentsRequest

Request for GetExperiments

GetExperimentsResponse

GetFieldMappingDescriptor<TDocument>

Descriptor for GetFieldMapping

<p>https://docs.opensearch.org/latest/field-types/index/</p>

GetFieldMappingRequest

Request for GetFieldMapping

<p>https://docs.opensearch.org/latest/field-types/index/</p>

GetFieldMappingResponse

GetIndexDescriptor

Descriptor for Get

<p>https://docs.opensearch.org/latest/api-reference/index-apis/get-index/</p>

GetIndexRequest

Request for Get

<p>https://docs.opensearch.org/latest/api-reference/index-apis/get-index/</p>

GetIndexResponse

GetIndexSettingsDescriptor

Descriptor for GetSettings

<p>https://docs.opensearch.org/latest/api-reference/index-apis/get-settings/</p>

GetIndexSettingsRequest

Request for GetSettings

<p>https://docs.opensearch.org/latest/api-reference/index-apis/get-settings/</p>

GetIndexSettingsResponse

GetIndexTemplateDescriptor

Descriptor for GetTemplate

<p>https://docs.opensearch.org/latest/</p>

GetIndexTemplateRequest

Request for GetTemplate

<p>https://docs.opensearch.org/latest/</p>

GetIndexTemplateResponse

GetJudgmentsDescriptor

Descriptor for GetJudgments

GetJudgmentsRequest

Request for GetJudgments

GetJudgmentsResponse

GetMLTaskDescriptor

Descriptor for GetMLTask

GetMLTaskRequest

Request for GetMLTask

GetMLTaskResponse

GetManyExtensions

Provides GetMany extensions that make it easier to get many documents given a list of ids

GetMappingDescriptor<TDocument>

Descriptor for GetMapping

<p>https://docs.opensearch.org/latest/api-reference/index-apis/get-mapping/</p>

GetMappingRequest

Request for GetMapping

<p>https://docs.opensearch.org/latest/api-reference/index-apis/get-mapping/</p>

GetMappingResponse

GetMappingResponseExtensions

GetMemoryContainerDescriptor

Descriptor for GetMemoryContainer

GetMemoryContainerRequest

Request for GetMemoryContainer

GetMemoryContainerResponse

GetMemoryDescriptor

Descriptor for GetMemory

GetMemoryRequest

Request for GetMemory

GetMemoryResponse

GetMessageDescriptor

Descriptor for GetMessage

GetMessageRequest

Request for GetMessage

GetMessageResponse

GetMessageTracesDescriptor

Descriptor for GetMessageTraces

GetMessageTracesRequest

Request for GetMessageTraces

GetMessageTracesResponse

GetModelDescriptor

Descriptor for GetModel

GetModelGroupDescriptor

Descriptor for GetModelGroup

GetModelGroupRequest

Request for GetModelGroup

GetModelGroupResponse

GetModelRequest

Request for GetModel

GetModelResponse

GetNodeStatsDescriptor

Descriptor for GetNodeStats

GetNodeStatsRequest

Request for GetNodeStats

GetNodeStatsResponse

GetPipelineDescriptor

Descriptor for GetPipeline

<p>https://docs.opensearch.org/latest/api-reference/ingest-apis/get-ingest/</p>

GetPipelineRequest

Request for GetPipeline

<p>https://docs.opensearch.org/latest/api-reference/ingest-apis/get-ingest/</p>

GetPipelineResponse

GetProfileDescriptor

Descriptor for GetProfile

GetProfileModelsDescriptor

Descriptor for GetProfileModels

GetProfileModelsRequest

Request for GetProfileModels

GetProfileModelsResponse

GetProfileRequest

Request for GetProfile

GetProfileResponse

GetProfileTasksDescriptor

Descriptor for GetProfileTasks

GetProfileTasksRequest

Request for GetProfileTasks

GetProfileTasksResponse

GetQuerySetsDescriptor

Descriptor for GetQuerySets

GetQuerySetsRequest

Request for GetQuerySets

GetQuerySetsResponse

GetRepositoryDescriptor

Descriptor for GetRepository

<p>https://docs.opensearch.org/latest/api-reference/snapshots/get-snapshot-repository/</p>

GetRepositoryRequest

Request for GetRepository

<p>https://docs.opensearch.org/latest/api-reference/snapshots/get-snapshot-repository/</p>

GetRepositoryResponse

GetRequest

Request for Get

<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>

GetRequest<TDocument>

GetResponse<TDocument>

GetScheduledExperimentsDescriptor

Descriptor for GetScheduledExperiments

GetScheduledExperimentsRequest

Request for GetScheduledExperiments

GetScheduledExperimentsResponse

GetScriptDescriptor

Descriptor for GetScript

<p>https://docs.opensearch.org/latest/api-reference/script-apis/get-stored-script/</p>

GetScriptRequest

Request for GetScript

<p>https://docs.opensearch.org/latest/api-reference/script-apis/get-stored-script/</p>

GetScriptResponse

GetSearchConfigurationsDescriptor

Descriptor for GetSearchConfigurations

GetSearchConfigurationsRequest

Request for GetSearchConfigurations

GetSearchConfigurationsResponse

GetSearchPipelineDescriptor

Descriptor for Get

GetSearchPipelineRequest

Request for Get

GetSearchPipelineResponse

GetSearchRelevanceStatsDescriptor

Descriptor for GetStats

GetSearchRelevanceStatsRequest

Request for GetStats

GetSearchRelevanceStatsResponse

GetSnapshotDescriptor

Descriptor for Get

<p>https://docs.opensearch.org/latest/</p>

GetSnapshotRequest

Request for Get

<p>https://docs.opensearch.org/latest/</p>

GetSnapshotResponse

GetStats

GetStatsDescriptor

Descriptor for GetStats

GetStatsRequest

Request for GetStats

GetStatsResponse

GetTaskDescriptor

Descriptor for GetTask

<p>https://docs.opensearch.org/latest/api-reference/tasks/</p>

GetTaskRequest

Request for GetTask

<p>https://docs.opensearch.org/latest/api-reference/tasks/</p>

GetTaskResponse

GetToolDescriptor

Descriptor for GetTool

GetToolRequest

Request for GetTool

GetToolResponse

GlobalAggregation

GlobalAggregationDescriptor<T>

GoogleNormalizedDistanceHeuristic

GoogleNormalizedDistanceHeuristicDescriptor

GrokProcessor

GrokProcessorDescriptor<T>

GrokProcessorPatternsDescriptor

Descriptor for GrokProcessorPatterns

<p>https://docs.opensearch.org/latest/</p>

GrokProcessorPatternsRequest

Request for GrokProcessorPatterns

<p>https://docs.opensearch.org/latest/</p>

GrokProcessorPatternsResponse

GsubProcessor

Converts a string field by applying a regular expression and a replacement. If the field is not a string, the processor will throw an exception.

GsubProcessorDescriptor<T>

Converts a string field by applying a regular expression and a replacement. If the field is not a string, the processor will throw an exception.

Guardrails

GuardrailsDescriptor

GuardrailsInputOutput

GuardrailsInputOutputDescriptor

HDRHistogramMethod

HDRHistogramMethodDescriptor

HardBounds<T>

HasChildQuery

HasChildQueryDescriptor<T>

HasParentQuery

HasParentQueryDescriptor<T>

HdfsRepository

HdfsRepositoryDescriptor

A snapshot repository that stores snapshot data within a Hadoop HDFS filesystem

Requires the repository-hdfs plugin to be installed on the cluster

HdfsRepositorySettings

HdfsRepositorySettingsDescriptor

Snapshot repository settings for IHdfsRepository

Headers

HeadersDescriptor

Highlight

HighlightDescriptor<T>

HighlightField

HighlightFieldDescriptor<T>

HistogramAggregation

HistogramAggregationDescriptor<T>

HistogramCompositeAggregationSource

A value source that can be applied on numeric values to build fixed size interval over the values. The interval parameter defines how the numeric values should be transformed. For instance an interval set to 5 will translate any numeric values to its closest interval, a value of 101 would be translated to 100 which is the key for the interval between 100 and 105.

HistogramCompositeAggregationSourceDescriptor<T>

HistogramOrder

Hit<TDocument>

HitsMetadata<T>

HitsTotal

HitsTotalDescriptor

HoltLinearModel

HoltLinearModelDescriptor

HoltWintersModel

HoltWintersModelDescriptor

HotThreadInformation

HtmlStripCharFilter

HtmlStripCharFilterDescriptor

HttpDeleteDescriptor

HttpDeleteRequest

HttpGetDescriptor

HttpGetRequest

HttpHeadDescriptor

HttpHeadRequest

HttpPatchDescriptor

HttpPatchRequest

HttpPostDescriptor

HttpPostRequest

HttpPutDescriptor

HttpPutRequest

HttpStats

HunspellTokenFilter

HunspellTokenFilterDescriptor

HybridQuery

HybridQueryDescriptor<T>

HyphenationDecompounderTokenFilter

HyphenationDecompounderTokenFilterDescriptor

IBSimilarity

IBSimilarityDescriptor

Information based model similarity. The algorithm is based on the concept that the information content in any symbolic distribution sequence is primarily determined by the repetitive usage of its basic elements. For written texts this challenge would correspond to comparing the writing styles of different authors.

IcuAnalyzer

An ICU analyzer that performs basic normalization, tokenization and character folding, using the IIcuNormalizationCharFilter char filter, IIcuTokenizer and IcuNormalizationTokenFilter token filter

IcuAnalyzerDescriptor

An ICU analyzer that performs basic normalization, tokenization and character folding, using the IIcuNormalizationCharFilter char filter, IIcuTokenizer and IcuNormalizationTokenFilter token filter

IcuCollationTokenFilter

Collations are used for sorting documents in a language-specific word order. The icu_collation token filter is available to all indices and defaults to using the DUCET collation, which is a best-effort attempt at language-neutral sorting. Part of the analysis-icu plugin:

IcuCollationTokenFilterDescriptor

IcuFoldingTokenFilter

IcuFoldingTokenFilterDescriptor

IcuNormalizationCharFilter

IcuNormalizationCharFilterDescriptor

IcuNormalizationTokenFilter

IcuNormalizationTokenFilterDescriptor

IcuTokenizer

IcuTokenizerDescriptor

IcuTransformTokenFilter

IcuTransformTokenFilterDescriptor

Id

IdResolver

Ids

IdsQuery

IdsQueryDescriptor

IgnoreAttribute

IgnoreClrPropertyMapping<TDocument>

ImportDanglingIndexDescriptor

Descriptor for ImportDanglingIndex

<p>https://docs.opensearch.org/latest/api-reference/index-apis/dangling-index/</p>

ImportDanglingIndexRequest

Request for ImportDanglingIndex

<p>https://docs.opensearch.org/latest/api-reference/index-apis/dangling-index/</p>

ImportDanglingIndexResponse

IncludeExclude

Index

IndexAliases

IndexBlock

Block type for an index.

IndexDescriptor

IndexDescriptor<TDocument>

Descriptor for Index

<p>https://docs.opensearch.org/latest/api-reference/document-apis/index-document/</p>

IndexExistsDescriptor

Descriptor for Exists

<p>https://docs.opensearch.org/latest/api-reference/index-apis/exists/</p>

IndexExistsRequest

Request for Exists

<p>https://docs.opensearch.org/latest/api-reference/index-apis/exists/</p>

IndexHealthStats

IndexManyExtensions

Provides GetMany extensions that make it easier to get many documents given a list of ids

IndexMappings

IndexMetrics

IndexName

IndexNameExtensions

IndexNameResolver

IndexRequest<TDocument>

Request for Index

<p>https://docs.opensearch.org/latest/api-reference/document-apis/index-document/</p>

IndexResponse

IndexSettings

The settings for an index

IndexSettingsDescriptor

The settings for an index

IndexShardStats

IndexSortSettings

IndexState

IndexStats

IndexStatsBase

IndexTemplateExistsDescriptor

Descriptor for TemplateExists

<p>https://docs.opensearch.org/latest/</p>

IndexTemplateExistsRequest

Request for TemplateExists

<p>https://docs.opensearch.org/latest/</p>

IndexUuid

IndexedScript

IndexedScriptDescriptor

IndexingBufferSettings

The indexing buffer is used to store newly indexed documents. When it fills up, the documents in the buffer are written to a segment on disk. It is divided between all shards on the node.

The following settings are static and must be configured on every data node in the cluster

IndexingLoad

IndexingPressureMemoryStats

IndexingPressureStats

IndexingStats

Indices

Indices.AllIndicesMarker

Indices.ManyIndices

IndicesExtensions

IndicesModuleSettings

IndicesModuleSettingsDescriptor

IndicesPointingToAliasExtensions

Implements several handy alias extensions.

IndicesRecoverySettings

IndicesRecoverySettingsDescriptor

IndicesResponseBase

IndicesStats

IndicesStatsDescriptor

Descriptor for Stats

<p>https://docs.opensearch.org/latest/</p>

IndicesStatsDictionary

IndicesStatsRequest

Request for Stats

<p>https://docs.opensearch.org/latest/</p>

IndicesStatsResponse

Infer

InferenceFieldMap

InferenceFieldMapDescriptor<TDocument>

InferenceProcessorBase

InferenceProcessorDescriptorBase<T, TInferenceProcessorDescriptor, TInferenceProcessorInterface>

InferenceResults

InferenceResultsDescriptor

Inferrer

Ingest

IngestStats

InlineGet<TDocument>

InlineScript

InlineScriptDescriptor

InnerHits

InnerHitsDescriptor<T>

InnerHitsMetadata

InnerHitsResult

InputQuery

InputQueryDescriptor

IntegerRange

IntegerRangeAttribute

IntegerRangeProperty

A range of signed 32-bit integers with a minimum value of -231 and maximum of 231-1.

IntegerRangePropertyDescriptor<T>

A range of signed 32-bit integers with a minimum value of -231 and maximum of 231-1.

IntervalsAllOf

A rule that returns matches that span a combination of other rules.

IntervalsAllOfDescriptor

A rule that returns matches that span a combination of other rules.

IntervalsAnyOf

A rule that emits intervals produced by any of its sub-rules.

IntervalsAnyOfDescriptor

A rule that emits intervals produced by any of its sub-rules.

IntervalsBase

Base type for an IIntervals implementation

IntervalsContainer

Container for an IIntervalsQuery rule

IntervalsDescriptor

Descriptor to construct an IIntervalsQuery rule

IntervalsDescriptorBase<TDescriptor, TInterface>

Base type for descriptors that define IIntervals

IntervalsFilter

IntervalsFilterDescriptor

Filters intervals produced by any rules by their relation to the intervals produced by another rule

IntervalsFuzzy

The fuzzy rule matches terms that are similar to the provided term, within an edit distance defined by Fuzziness. If the fuzzy expansion matches more than 128 terms, OpenSearch returns an error.

IntervalsFuzzyDescriptor

The fuzzy rule matches terms that are similar to the provided term, within an edit distance defined by Fuzziness. If the fuzzy expansion matches more than 128 terms, OpenSearch returns an error.

IntervalsListDescriptor

Constructs a collection of IntervalsContainer

IntervalsMatch

Matches the analyzed text

IntervalsMatchDescriptor

Matches the analyzed text

IntervalsNoFilterBase

Base type for an IIntervalsNoFilter implementation

IntervalsPrefix

Matches terms that start with a specified set of characters. This prefix can expand to match at most 128 terms. If the prefix matches more than 128 terms, OpenSearch returns an error. You can use the index-prefixes option in the field mapping to avoid this limit.

IntervalsPrefixDescriptor

IntervalsQuery

A query that allows fine-grained control over the order and proximity of matching terms. Matching rules are constructed from a small set of definitions, and the rules are then applied to terms from a particular field. The definitions produce sequences of minimal intervals that span terms in a body of text. These intervals can be further combined and filtered by parent sources.

IntervalsQueryDescriptor<T>

IntervalsWildcard

Matches terms using a wildcard pattern. This pattern can expand to match at most 128 terms. If the pattern matches more than 128 terms, OpenSearch returns an error.

IntervalsWildcardDescriptor

Matches terms using a wildcard pattern. This pattern can expand to match at most 128 terms. If the pattern matches more than 128 terms, OpenSearch returns an error.

IpAddressRange

IpAttribute

IpProperty

An ip field can index/store either IPv4 or IPv6 addresses.

IpPropertyDescriptor<T>

An ip field can index/store either IPv4 or IPv6 addresses.

IpRangeAggregation

IpRangeAggregationDescriptor<T>

IpRangeAggregationRange

IpRangeAggregationRangeDescriptor

IpRangeAttribute

IpRangeBucket

A bucket for an IpRangeAggregation

IpRangeProperty

A range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.

IpRangePropertyDescriptor<T>

A range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.

IsADictionaryBase<TKey, TValue>

IsADictionaryDescriptorBase<TDescriptor, TInterface, TKey, TValue>

IsAReadOnlyDictionaryBase<TKey, TValue>

JoinAttribute

JoinField

The field on which a parent-child relationship is joined

JoinField.Child

JoinField.Parent

JoinProcessor

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

JoinProcessorDescriptor<T>

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

JoinProperty

The join datatype is a special field that creates parent/child relation within documents of the same index.

JoinPropertyDescriptor<T>

The join datatype is a special field that creates parent/child relation within documents of the same index.

JsonProcessor

Converts a JSON string into a structured JSON object.

JsonProcessorDescriptor<T>

Converts a JSON string into a structured JSON object.

JudgmentsSearchDescriptor

Descriptor for JudgmentsSearch

JudgmentsSearchRequest

Request for JudgmentsSearch

JudgmentsSearchResponse

KStemTokenFilter

KStemTokenFilterDescriptor

KeepTypesTokenFilter

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

KeepTypesTokenFilterDescriptor

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

KeepWordsTokenFilter

KeepWordsTokenFilterDescriptor

KeyValueProcessor

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

KeyValueProcessorDescriptor<T>

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

KeyedBucket<TKey>

KeyedProcessorStats

KeyedValueAggregate

KeywordAnalyzer

KeywordAnalyzerDescriptor

KeywordAttribute

KeywordMarkerTokenFilter

Protects words from being modified by stemmers. Must be placed before any stemming filters.

KeywordMarkerTokenFilterDescriptor

Protects words from being modified by stemmers. Must be placed before any stemming filters.

KeywordProperty

A field to index structured content such as IDs, email addresses, hostnames, status codes, zip codes or tags. Used for filtering, sorting, and for aggregations.

Keyword fields are only searchable by their exact value.

KeywordPropertyDescriptor<T>

A field to index structured content such as IDs, email addresses, hostnames, status codes, zip codes or tags. Used for filtering, sorting, and for aggregations.

Keyword fields are only searchable by their exact value.

KeywordTokenizer

KeywordTokenizerDescriptor

KnnMethod

KnnMethodDescriptor

KnnMethodParameters

KnnMethodParametersDescriptor

KnnQuery

KnnQueryDescriptor<T>

KnnQueryRescoreContext

Configures rescoring of approximate k-NN search results using full-precision vectors.

KnnQueryRescoreContextDescriptor

A descriptor for configuring k-NN query rescoring.

KnnVectorProperty

KnnVectorPropertyDescriptor<T>

KuromojiAnalyzer

KuromojiAnalyzerDescriptor

KuromojiIterationMarkCharFilter

KuromojiIterationMarkCharFilterDescriptor

KuromojiPartOfSpeechTokenFilter

KuromojiPartOfSpeechTokenFilterDescriptor

KuromojiReadingFormTokenFilter

KuromojiReadingFormTokenFilterDescriptor

KuromojiStemmerTokenFilter

KuromojiStemmerTokenFilterDescriptor

KuromojiTokenizer

KuromojiTokenizerDescriptor

LLM

LLMDescriptor

LMDirichletSimilarity

LMDirichletSimilarityDescriptor

LMJelinekMercerSimilarity

LMJelinekMercerSimilarityDescriptor

LanguageAnalyzer

LanguageAnalyzerDescriptor

LaplaceSmoothingModel

LaplaceSmoothingModelDescriptor

LatLon

LazyDocument

LengthTokenFilter

LengthTokenFilterDescriptor

LetterTokenizer

LetterTokenizerDescriptor

Like

LikeDescriptor<T>

LikeDocumentBase

LikeDocumentDescriptor<TDocument>

An indexed or artificial document with which to find likeness

LikeDocument<TDocument>

An indexed or artificial document with which to find likeness

LimitTokenCountTokenFilter

LimitTokenCountTokenFilterDescriptor

LineStringGeoShape

LinearDateDecayFunction

LinearDecayFunction

LinearDecayFunctionBase<TOrigin, TScale>

LinearDecayFunctionDescriptor<TOrigin, TScale, T>

LinearGeoDecayFunction

LinearInterpolationSmoothingModel

LinearInterpolationSmoothingModelDescriptor

LinearModel

LinearModelDescriptor

ListDanglingIndicesDescriptor

Descriptor for List

<p>https://docs.opensearch.org/latest/api-reference/index-apis/dangling-index/</p>

ListDanglingIndicesRequest

Request for List

<p>https://docs.opensearch.org/latest/api-reference/index-apis/dangling-index/</p>

ListDanglingIndicesResponse

ListTasksDescriptor

Descriptor for List

<p>https://docs.opensearch.org/latest/api-reference/tasks/</p>

ListTasksRequest

Request for List

<p>https://docs.opensearch.org/latest/api-reference/tasks/</p>

ListTasksResponse

LoadModelDescriptor

Descriptor for LoadModel

LoadModelRequest

Request for LoadModel

LoadModelResponse

LongId

LongRange

LongRangeAttribute

LongRangeProperty

A range of signed 64-bit integers with a minimum value of -263 and maximum of 263-1.

LongRangePropertyDescriptor<T>

A range of signed 64-bit integers with a minimum value of -263 and maximum of 263-1.

LongRangeQuery

LongRangeQueryDescriptor<T>

LowercaseProcessor

Converts a string to its lowercase equivalent.

LowercaseProcessorDescriptor<T>

Converts a string to its lowercase equivalent.

LowercaseTokenFilter

LowercaseTokenFilterDescriptor

LowercaseTokenizer

LowercaseTokenizerDescriptor

LuceneExpressionScript

MLAction

MLActionDescriptor

MLAggregation

MLAggregationDescriptor

MLIndexSettings

MLIndexSettingsDescriptor

MLInferenceRequestProcessor

MLInferenceRequestProcessorDescriptor

MLMetadata

MLMetadataDescriptor

MLNode

MLNodeDescriptor

MLResult

MLResultDescriptor

MLTask

MLTaskDescriptor

MappingCharFilter

MappingCharFilterDescriptor

MappingWalker

MappingsDescriptor

MatchAllQuery

MatchAllQueryDescriptor

MatchBoolPrefixQuery

A match_bool_prefix query analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

MatchBoolPrefixQueryDescriptor<T>

A match_bool_prefix query analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

MatchNoneQuery

MatchNoneQueryDescriptor

MatchPhrasePrefixQuery

MatchPhrasePrefixQueryDescriptor<T>

MatchPhraseQuery

MatchPhraseQueryDescriptor<T>

MatchQuery

A match query for a single field

MatchQueryDescriptor<T>

A match query for a single field

MatrixAggregateBase

MatrixAggregationBase

MatrixAggregationDescriptorBase<TMatrixAggregation, TMatrixAggregationInterface, T>

MatrixStatsAggregate

MatrixStatsAggregation

MatrixStatsAggregationDescriptor<T>

MatrixStatsField

MaxAggregation

MaxAggregationDescriptor<T>

MaxBucketAggregation

MaxBucketAggregationDescriptor

MedianAbsoluteDeviationAggregation

This single-value aggregation approximates the median absolute deviation of its search results.

Median absolute deviation is a measure of variability. It is a robust statistic, meaning that it is useful for describing data that may have outliers, or may not be normally distributed. For such data it can be more descriptive than standard deviation.

It is calculated as the median of each data point’s deviation from the median of the entire sample. That is, for a random variable

, the median absolute deviation is

median(|median(X) - Xi|).

MedianAbsoluteDeviationAggregationDescriptor<T>

This single-value aggregation approximates the median absolute deviation of its search results.

It is calculated as the median of each data point’s deviation from the median of the entire sample. That is, for a random variable

, the median absolute deviation is

median(|median(X) - Xi|).

MemberInfoResolver

Resolves member infos in an expression, instance may NOT be shared.

Memory

MemoryContainerConfiguration

MemoryContainerConfigurationDescriptor

MemoryDescriptor

MemoryIndexSettings

MemoryIndexSettingsDescriptor

MergePolicySettings

MergePolicySettingsDescriptor

MergeSchedulerSettings

MergeSchedulerSettingsDescriptor

MergeSettings

MergeSettingsDescriptor

MergesStats

Message

MessageDescriptor

Messages

MessagesDescriptor

MetricAggregateBase

MetricAggregationBase

MetricAggregationDescriptorBase<TMetricAggregation, TMetricAggregationInterface, T>

Metrics

MinAggregation

MinAggregationDescriptor<T>

MinBucketAggregation

MinBucketAggregationDescriptor

MinimumShouldMatch

MissingAggregation

MissingAggregationDescriptor<T>

Model

ModelConfig

ModelConfigDescriptor

ModelDescriptor

ModelGroup

ModelGroupDescriptor

ModelGroupRegistration

ModelGroupRegistrationDescriptor

ModelProfile

ModelProfileDescriptor

ModelStats

ModelStatsDescriptor

MoreLikeThisQuery

MoreLikeThisQueryDescriptor<T>

MoveClusterRerouteCommand

MoveClusterRerouteCommandDescriptor

MovingAverageAggregation

MovingAverageAggregationDescriptor

MovingAverageModelDescriptor

MovingFunctionAggregation

MovingFunctionAggregationDescriptor

MultiBucketAggregate<TBucket>

Aggregation response for a bucket aggregation

MultiBucketsPath

MultiBucketsPathDescriptor

MultiGetDescriptor

Descriptor for MultiGet

<p>https://docs.opensearch.org/latest/api-reference/document-apis/multi-get/</p>

MultiGetHit<TDocument>

MultiGetOperationDescriptor<T>

MultiGetOperation<T>

MultiGetRequest

Request for MultiGet

<p>https://docs.opensearch.org/latest/api-reference/document-apis/multi-get/</p>

MultiGetResponse

MultiLineStringGeoShape

MultiMatchQuery

A match query across multiple fields.

MultiMatchQueryDescriptor<T>

A match query across multiple fields.

MultiPointGeoShape

MultiPolygonGeoShape

MultiSearchDescriptor

Descriptor for MultiSearch

<p>https://docs.opensearch.org/latest/api-reference/multi-search/</p>

MultiSearchRequest

Request for MultiSearch

<p>https://docs.opensearch.org/latest/api-reference/multi-search/</p>

MultiSearchResponse

MultiSearchTemplateDescriptor

Descriptor for MultiSearchTemplate

<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>

MultiSearchTemplateRequest

Request for MultiSearchTemplate

<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>

MultiTermQueryRewrite

Controls how a multi term query such as a wildcard or prefix query, is rewritten.

MultiTermVectorOperationDescriptor<T>

An operation to define the calculation of term vectors when using Multi termvectors API

MultiTermVectorOperation<T>

MultiTermVectorsDescriptor

A Multi termvectors API request

MultiTermVectorsRequest

A Multi termvectors API request

MultiTermVectorsResponse

MultiTermsAggregate<TKey>

MultiTermsAggregation

MultiTermsAggregationDescriptor<T>

MultiTermsBucket<TKey>

MultiplexerTokenFilter

MultiplexerTokenFilterDescriptor

A token filter of type multiplexer will emit multiple tokens at the same position, each version of the token having been run through a different filter. Identical output tokens at the same position will be removed.

Murmur3HashAttribute

Murmur3HashProperty

Murmur3HashPropertyDescriptor<T>

MustacheScript

MutualInformationHeuristic

MutualInformationHeuristicDescriptor

NGramTokenFilter

NGramTokenFilterDescriptor

NGramTokenizer

NGramTokenizerDescriptor

Name

NamedComponentTemplate

NamedComposableIndexTemplate

NamedFiltersContainer

NamedFiltersContainerDescriptor<T>

Names

Namespace

NamespaceDescriptor

NamespacedClientProxy

NestedAggregation

NestedAggregationDescriptor<T>

NestedAttribute

NestedIdentity

NestedProperty

A specialised version of the IObjectProperty datatype that allows arrays of objects to be indexed in a way that they can be queried independently of each other, using nested queries and aggregations.

NestedPropertyDescriptor<TParent, TChild>

A specialised version of the IObjectProperty datatype that allows arrays of objects to be indexed in a way that they can be queried independently of each other, using nested queries and aggregations.

NestedQuery

NestedQueryDescriptor<T>

NestedSort

NestedSortDescriptor<T>

Sort on a field inside one or more nested objects.

NetworkCommunityIdProcessor

NetworkCommunityIdProcessorDescriptor<T>

NetworkDirectionProcessor

NetworkDirectionProcessorDescriptor<T>

NeuralQuery

NeuralQueryDescriptor<T>

NeuralQueryEnricherRequestProcessor

NeuralQueryEnricherRequestProcessorDescriptor

NodeAllocationExplanation

NodeIds

NodeInfo

NodeInfoHttp

NodeInfoJvmMemory

NodeInfoMemory

NodeInfoNetwork

NodeInfoNetworkInterface

NodeInfoOSCPU

NodeInfoTransport

NodeIngestStats

NodeJvmInfo

NodeJvmStats

NodeJvmStats.GarbageCollectionGenerationStats

NodeJvmStats.GarbageCollectionStats

NodeJvmStats.JvmClassesStats

NodeJvmStats.MemoryStats

NodeJvmStats.MemoryStats.JvmPool

NodeJvmStats.NodeBufferPool

NodeJvmStats.ThreadStats

NodeOperatingSystemInfo

NodePackagingType

NodeProcessInfo

NodeStatistics

NodeStats

NodeStatsDetails

NodeStatsDetailsDescriptor

NodeThreadPoolInfo

NodeUsageInformation

NodesHotThreadsDescriptor

Descriptor for HotThreads

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-hot-threads/</p>

NodesHotThreadsRequest

Request for HotThreads

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-hot-threads/</p>

NodesHotThreadsResponse

NodesInfoDescriptor

Descriptor for Info

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-info/</p>

NodesInfoRequest

Request for Info

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-info/</p>

NodesInfoResponse

NodesResponseBase

NodesStatsDescriptor

Descriptor for Stats

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-usage/</p>

NodesStatsRequest

Request for Stats

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-usage/</p>

NodesStatsResponse

NodesUsageDescriptor

Descriptor for Usage

<p>https://docs.opensearch.org/latest/</p>

NodesUsageRequest

Request for Usage

<p>https://docs.opensearch.org/latest/</p>

NodesUsageResponse

NoopMappingVisitor

NoopPropertyVisitor

NoriAnalyzer

The nori analyzer consists of the following tokenizer and token filters:

- nori_tokenizer

- nori_part_of_speech token filter

- nori_readingform token filter

- nori_number token filter

- lowercase token filter

NoriAnalyzerDescriptor

The nori analyzer consists of the following tokenizer and token filters:

- nori_tokenizer

- nori_part_of_speech token filter

- nori_readingform token filter

- nori_number token filter

- lowercase token filter

NoriPartOfSpeechTokenFilter

The nori_part_of_speech token filter removes tokens that match a set of part-of-speech tags.

NoriPartOfSpeechTokenFilterDescriptor

The nori_part_of_speech token filter removes tokens that match a set of part-of-speech tags.

NoriTokenizer

Tokenizer that ships with the analysis-nori plugin

NoriTokenizerDescriptor

Tokenizer that ships with the analysis-nori plugin

NormalizationPhaseResultsProcessor

NormalizationPhaseResultsProcessorDescriptor

NormalizerBase

NormalizerDescriptorBase<TNormalizer, TNormalizerInterface>

Normalizers

NormalizersDescriptor

NumberAttribute

Maps a property as a number type. If no type is specified, the default type is float (single precision floating point).

NumberProperty

NumberPropertyDescriptorBase<TDescriptor, TInterface, T>

NumberPropertyDescriptor<T>

NumericFielddata

NumericFielddataDescriptor

NumericRangeQuery

NumericRangeQueryDescriptor<T>

ObjectAttribute

ObjectProperty

A object datatype mapping for an inner object

ObjectPropertyDescriptorBase<TDescriptor, TInterface, TParent, TChild>

ObjectTypeDescriptor<TParent, TChild>

ObsoleteMappingsBase

ObsoleteMappingsBase.Mappings

Types are gone from OpenSearch, this class solely exist to help you move your complex mappings over to the new way of writing the mappings. Use TypeMapping directly instead.

    This class won't receive updates, please be advised to move over if you need to utilize
    new features in the future.

OpenIndexDescriptor

Descriptor for Open

<p>https://docs.opensearch.org/latest/api-reference/index-apis/open-index/</p>

OpenIndexRequest

Request for Open

<p>https://docs.opensearch.org/latest/api-reference/index-apis/open-index/</p>

OpenIndexResponse

OpenSearchClient

OpenSearchClient is a strongly typed client which exposes fully mapped OpenSearch endpoints

OpenSearchCorePropertyAttributeBase

OpenSearchDocValuesPropertyAttributeBase

OpenSearchPropertyAttributeBase

OpenSearchTypeAttribute

Applied to a CLR type to override the name of a CLR type and the property from which an _id is inferred when serializing an instance of the type.

OpenSearchVersionInfo

OperatingSystemMemoryInfo

OperatingSystemStats

OperatingSystemStats.CPUStats

OperatingSystemStats.CPUStats.LoadAverageStats

OperatingSystemStats.ExtendedMemoryStats

OperatingSystemStats.MemoryStats

Output

OutputDescriptor

OversampleRequestProcessor

OversampleRequestProcessorDescriptor

Owner

OwnerDescriptor

PainlessContextSetup

Sets up contextual scope for the painless script the execute under.

PainlessContextSetupDescriptor

Sets up contextual scope for the painless script the execute under.

PainlessScript

Parameters

ParametersDescriptor

ParentAggregation

A special single bucket aggregation that selects parent documents that have the specified type, as defined in a join field.

ParentAggregationDescriptor<T, TParent>

A special single bucket aggregation that selects parent documents that have the specified type, as defined in a join field.

ParentIdQuery

ParentIdQueryDescriptor<T>

PathHierarchyTokenizer

PathHierarchyTokenizerDescriptor

PatternAnalyzer

PatternAnalyzerDescriptor

PatternCaptureTokenFilter

PatternCaptureTokenFilterDescriptor

PatternReplaceCharFilter

PatternReplaceCharFilterDescriptor

PatternReplaceTokenFilter

PatternReplaceTokenFilterDescriptor

PatternTokenizer

PatternTokenizerDescriptor

PendingTask

PerFieldAnalyzer

PerFieldAnalyzerDescriptor<T>

PerFieldAnalyzer<T>

PercentageScoreHeuristic

PercentageScoreHeuristicDescriptor

PercentileItem

PercentileRanksAggregation

PercentileRanksAggregationDescriptor<T>

PercentilesAggregate

PercentilesAggregation

PercentilesAggregationDescriptor<T>

PercentilesBucketAggregation

PercentilesBucketAggregationDescriptor

PercentilesMethodDescriptor

PercolateQuery

The percolate query can be used to match queries stored in an index

PercolateQueryDescriptor<T>

The percolate query can be used to match queries stored in an index

PercolatorAttribute

PercolatorProperty

The percolator datatype is used to store a query, so that the IPercolateQuery can use it to match provided documents.

PercolatorPropertyDescriptor<T>

The percolator datatype is used to store a query, so that the IPercolateQuery can use it to match provided documents.

PersonalizeSearchRankingResponseProcessor

PersonalizeSearchRankingResponseProcessorDescriptor

PhaseResultsProcessorsDescriptor

PhoneticTokenFilter

A token filter that converts tokens to their phonetic representation using Soundex, Metaphone, and a variety of other algorithms.

PhoneticTokenFilterDescriptor

A token filter that converts tokens to their phonetic representation using Soundex, Metaphone, and a variety of other algorithms.

PhraseSuggestCollate

PhraseSuggestCollateDescriptor<T>

Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index.

PhraseSuggestCollateQuery

PhraseSuggestCollateQueryDescriptor

A query to run for a phrase suggester collate

PhraseSuggestHighlight

PhraseSuggestHighlightDescriptor

Highlighting for IPhraseSuggester

PhraseSuggester

The phrase suggester adds additional logic on top of the term suggester to select entire corrected phrases instead of individual tokens weighted based on ngram-language models. In practice this suggester will be able to make better decisions about which tokens to pick based on co-occurrence and frequencies.

PhraseSuggesterDescriptor<T>

PingDescriptor

Descriptor for Ping

<p>https://docs.opensearch.org/latest/</p>

PingRequest

Request for Ping

<p>https://docs.opensearch.org/latest/</p>

PingResponse

Pipeline

PipelineAggregationBase

PipelineAggregationDescriptorBase<TPipelineAggregation, TPipelineAggregationInterface, TBucketsPath>

PipelineDescriptor

PipelineProcessor

Executes another pipeline.

PipelineProcessorDescriptor

Executes another pipeline.

PipelineSimulation

PitDetail

PlainRequestBase<TParameters>

PluginStats

PointGeoShape

PointInTime

PointInTimeDescriptor

PolygonGeoShape

PorterStemTokenFilter

PorterStemTokenFilterDescriptor

PostQuerySetsDescriptor

Descriptor for PostQuerySets

PostQuerySetsRequest

Request for PostQuerySets

PostQuerySetsResponse

PostScheduledExperimentsDescriptor

Descriptor for PostScheduledExperiments

PostScheduledExperimentsRequest

Request for PostScheduledExperiments

PostScheduledExperimentsResponse

PostVotingConfigExclusionsDescriptor

Descriptor for PostVotingConfigExclusions

<p>https://docs.opensearch.org/latest/</p>

PostVotingConfigExclusionsRequest

Request for PostVotingConfigExclusions

<p>https://docs.opensearch.org/latest/</p>

PostVotingConfigExclusionsResponse

PredicateTokenFilter

PredicateTokenFilterDescriptor

The predicate_token_filter token filter takes a predicate script, and removes tokens that do not match the predicate.

PredictDescriptor

Descriptor for Predict

PredictModelDescriptor

Descriptor for PredictModel

PredictModelOutput

PredictModelOutputDescriptor

PredictModelRequest

Request for PredictModel

PredictModelResponse

PredictModelResult

PredictModelResultDescriptor

PredictRequest

Request for Predict

PredictRequestStats

PredictRequestStatsDescriptor

PredictResponse

PredictionResult

PredictionResultDescriptor

PrefixQuery

PrefixQueryDescriptor<T>

PreventMappingMultipleTypesDescriptor

The common pattern in OpenSearch.Client is that you can call fluent methods multiple types overriding what was previously set. This type prevents a user to call Map() multiple times with different types making it crystal clear not only can you no longer have multiple types in an index MappingsDescriptor makes the overloads that take type obsolete as well. Both PreventMappingMultipleTypesDescriptor and MappingsDescriptor are obsolete. Please move to

ProcessStats

ProcessStats.CPUStats

ProcessStats.MemoryStats

ProcessorBase

Ingest pipelines are composed of one or more processors

ProcessorDescriptorBase<TProcessorDescriptor, TProcessorInterface>

Ingest pipelines are composed of one or more processors

ProcessorStats

ProcessorsDescriptor

ProducerConsumerBackPressure

Simple back pressure implementation that makes sure the minimum max concurrency between producer and consumer is not amplified by the greedier of the two by more then the backPressureFactor which defaults to 4

Profile

ProfileRequest

ProfileRequestDescriptor

Properties

PropertiesDescriptor<T>

Properties<T>

PropertyBase

A mapping for a property type to a document field in OpenSearch

PropertyDescriptorBase<TDescriptor, TInterface, T>

A mapping for a property type to a document field in OpenSearch

PropertyMapping

PropertyMappingDescriptor<TDocument>

PropertyMappingProvider

PropertyName

PropertyNameAttribute

PropertyWalker

PutAliasDescriptor

Descriptor for PutAlias

<p>https://docs.opensearch.org/latest/api-reference/index-apis/update-alias/</p>

PutAliasRequest

A request to put an alias to one or more indices

PutAliasResponse

PutComponentTemplateDescriptor

Descriptor for PutComponentTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template</p>

PutComponentTemplateRequest

Request for PutComponentTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template</p>

PutComponentTemplateResponse

PutComposableIndexTemplateDescriptor

Descriptor for PutComposableTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/</p>

PutComposableIndexTemplateRequest

Request for PutComposableTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/</p>

PutComposableIndexTemplateResponse

PutExperimentsDescriptor

Descriptor for PutExperiments

PutExperimentsRequest

Request for PutExperiments

PutExperimentsResponse

PutHybridOptimizerExperimentRequest

PutHybridOptimizerExperimentRequestDescriptor

PutImportJudgmentsRequest

PutImportJudgmentsRequestDescriptor

PutIndexTemplateDescriptor

Descriptor for PutTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/</p>

PutIndexTemplateRequest

Request for PutTemplate

<p>https://docs.opensearch.org/latest/im-plugin/index-templates/</p>

PutIndexTemplateResponse

PutJudgmentsDescriptor

Descriptor for PutJudgments

PutJudgmentsRequest

Request for PutJudgments

PutJudgmentsResponse

PutLLMJudgmentsRequest

PutLLMJudgmentsRequestDescriptor

PutMappingDescriptor<TDocument>

Descriptor for PutMapping

<p>https://docs.opensearch.org/latest/api-reference/index-apis/put-mapping/</p>

PutMappingRequest

Request for PutMapping

<p>https://docs.opensearch.org/latest/api-reference/index-apis/put-mapping/</p>

PutMappingRequest<TDocument>

PutMappingResponse

PutPairwiseExperimentRequest

PutPairwiseExperimentRequestDescriptor

PutPipelineDescriptor

Descriptor for PutPipeline

<p>https://docs.opensearch.org/latest/ingest-pipelines/create-ingest/</p>

PutPipelineRequest

Request for PutPipeline

<p>https://docs.opensearch.org/latest/ingest-pipelines/create-ingest/</p>

PutPipelineResponse

PutPointwiseExperimentRequest

PutPointwiseExperimentRequestDescriptor

PutQuerySetsDescriptor

Descriptor for PutQuerySets

PutQuerySetsRequest

Request for PutQuerySets

PutQuerySetsResponse

PutScriptDescriptor

Descriptor for PutScript

<p>https://docs.opensearch.org/latest/api-reference/script-apis/create-stored-script/</p>

PutScriptRequest

Request for PutScript

<p>https://docs.opensearch.org/latest/api-reference/script-apis/create-stored-script/</p>

PutScriptResponse

PutSearchConfigurationRequest

PutSearchConfigurationRequestDescriptor

PutSearchConfigurationsDescriptor

Descriptor for PutSearchConfigurations

PutSearchConfigurationsRequest

Request for PutSearchConfigurations

PutSearchConfigurationsResponse

PutSearchPipelineDescriptor

Descriptor for Put

<p>https://docs.opensearch.org/latest/search-plugins/search-pipelines/creating-search-pipeline/</p>

PutSearchPipelineRequest

Request for Put

<p>https://docs.opensearch.org/latest/search-plugins/search-pipelines/creating-search-pipeline/</p>

PutSearchPipelineResponse

PutUBIJudgmentsRequest

PutUBIJudgmentsRequestDescriptor

QueriesCacheSettings

QueriesCacheSettingsDescriptor

QueriesSettings

QueriesSettingsDescriptor

QueryBase

QueryBreakdown

QueryCacheStats

QueryContainer

QueryContainerDescriptor<T>

QueryDescriptorBase<TDescriptor, TInterface>

QueryProfile

QuerySetsSearchDescriptor

Descriptor for QuerySetsSearch

QuerySetsSearchRequest

Request for QuerySetsSearch

QuerySetsSearchResponse

QueryStringQuery

A query that uses a query parser in order to parse its content

QueryStringQueryDescriptor<T>

A query that uses a query parser in order to parse its content

QueryVisitor

QueryWalker

Query<T>

RandomScoreFunction

RandomScoreFunctionDescriptor<T>

RangeAggregation

RangeAggregationDescriptor<T>

RangeBucket

RangePropertyAttributeBase

RangePropertyBase

RangePropertyDescriptorBase<TDescriptor, TInterface, T>

RankFeatureAttribute

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

RankFeatureLinearFunction

Gives a score equal to the indexed value of S, where S is the value of the rank feature field.

If a rank feature field is indexed with "positive_score_impact": true, its indexed value is equal to S and rounded to preserve only 9 significant bits for the precision.

If a rank feature field is indexed with "positive_score_impact": false, its indexed value is equal to 1/S and rounded to preserve only 9 significant bits for the precision.

RankFeatureLogarithmFunction

RankFeatureLogarithmFunctionDescriptor

Gives a score that is equal to log(scaling_factor + S) where S is the value of the rank feature and scaling_factor is a configurable scaling factor. Scores are unbounded. This function only supports rank features that have a positive score impact.

RankFeatureProperty

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

RankFeaturePropertyDescriptor<T>

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

RankFeatureQuery

RankFeatureQueryDescriptor<T>

RankFeatureSaturationFunction

RankFeatureSaturationFunctionDescriptor

Gives a score that is equal to S / (S + pivot) where S is the value of the rank feature and pivot is a configurable pivot value so that the result will be less than 0.5 if S is less than pivot and greater than 0.5 otherwise. Scores are always is (0, 1). If the rank feature has a negative score impact then the function will be computed as pivot / (S + pivot), which decreases when S increases.

RankFeatureSigmoidFunction

is an extension of saturation which adds a configurable exponent. Scores are computed as S^exp^ / (S^exp^ + pivot^exp^). Like for the saturation function, pivot is the value of S that gives a score of 0.5 and scores are in (0, 1).

exponent must be positive, but is typically in [0.5, 1]. A good value should be computed via training. If you don’t have the opportunity to do so, we recommend that you stick to the saturation function instead.

RankFeatureSigmoidFunctionDescriptor

RankFeaturesAttribute

A field that can index numeric feature vectors, so that they can later be used to boost documents in queries with a rank_feature query. It is analogous to the IRankFeatureProperty datatype, but is better suited when the list of features is sparse so that it wouldn't be reasonable to add one field to the mappings for each of them.

RankFeaturesProperty

RankFeaturesPropertyDescriptor<T>

RareTermsAggregation

A multi-bucket value source based aggregation which finds "rare" terms — terms that are at the long-tail of the distribution and are not frequent. Conceptually, this is like a terms aggregation that is sorted by _count ascending.

RareTermsAggregationDescriptor<T>

RareTermsBucket<TKey>

RateLimiter

RateLimiterDescriptor

RawQuery

RawQueryDescriptor

ReadOnlyUrlRepository

ReadOnlyUrlRepositoryDescriptor

A snapshot repository that can be used as an alternative read-only way to access data created by the IFileSystemRepository. The URL specified in the url parameter should point to the root of the shared filesystem repository.

ReadOnlyUrlRepositorySettings

ReadOnlyUrlRepositorySettingsDescriptor

Snapshot repository settings for IReadOnlyUrlRepository

RecoveryStats

RefreshDescriptor

Descriptor for Refresh

<p>https://docs.opensearch.org/latest/api-reference/index-apis/refresh/</p>

RefreshRequest

Request for Refresh

<p>https://docs.opensearch.org/latest/api-reference/index-apis/refresh/</p>

RefreshResponse

RefreshStats

RegexpQuery

Queries documents that contain terms matching a regular expression.

RegexpQueryDescriptor<T>

Queries documents that contain terms matching a regular expression.

RegisterAgentsDescriptor

Descriptor for RegisterAgents

RegisterAgentsRequest

Request for RegisterAgents

RegisterAgentsResponse

RegisterModelDescriptor

Descriptor for RegisterModel

RegisterModelGroupDescriptor

Descriptor for RegisterModelGroup

RegisterModelGroupRequest

Request for RegisterModelGroup

RegisterModelGroupResponse

RegisterModelMetaDescriptor

Descriptor for RegisterModelMeta

RegisterModelMetaRequest

Request for RegisterModelMeta

RegisterModelMetaResponse

RegisterModelRequest

Request for RegisterModel

RegisterModelResponse

ReindexDescriptor<TSource, TTarget>

ReindexDestination

ReindexDestinationDescriptor

Configures the destination for a reindex API request

ReindexNode

ReindexObservable<TSource>

ReindexObservable<TSource, TTarget>

ReindexObserver

ReindexOnServerDescriptor

Descriptor for ReindexOnServer

<p>https://docs.opensearch.org/latest/im-plugin/reindex-data/</p>

ReindexOnServerRequest

A request to Reindex API

ReindexOnServerResponse

ReindexRequest<TSource>

ReindexRequest<TSource, TTarget>

ReindexRethrottleDescriptor

Descriptor for ReindexRethrottle

<p>https://docs.opensearch.org/latest/</p>

ReindexRethrottleRequest

Request for ReindexRethrottle

<p>https://docs.opensearch.org/latest/</p>

ReindexRethrottleResponse

ReindexRouting

ReindexSource

ReindexSourceDescriptor

Configures the source for a reindex API request

ReindexStatus

ReindexTask

RelationName

RelationNameResolver

Relations

RelationsDescriptor

ReloadSecureSettingsDescriptor

Descriptor for ReloadSecureSettings

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-reload-secure/</p>

ReloadSecureSettingsRequest

Request for ReloadSecureSettings

<p>https://docs.opensearch.org/latest/api-reference/nodes-apis/nodes-reload-secure/</p>

ReloadSecureSettingsResponse

RemoteClusterConfiguration

Simplifies the creation of remote cluster configuration, can be combined with a dictionary using the overloaded + operator

RemoteInfo

RemoteInfoDescriptor

Descriptor for RemoteInfo

<p>https://docs.opensearch.org/latest/api-reference/remote-info/</p>

RemoteInfoRequest

Request for RemoteInfo

<p>https://docs.opensearch.org/latest/api-reference/remote-info/</p>

RemoteInfoResponse

RemoteSource

RemoteSourceDescriptor

RemoveDuplicatesTokenFilter

A token filter that drops identical tokens at the same position

RemoveDuplicatesTokenFilterDescriptor

A token filter that drops identical tokens at the same position

RemoveProcessor

Removes existing fields. If one field doesn't exist, an exception will be thrown.

RemoveProcessorDescriptor<T>

Removes existing fields. If one field doesn't exist, an exception will be thrown.

RenameClrPropertyMapping<TDocument>

RenameFieldResponseProcessor

RenameFieldResponseProcessorDescriptor

RenameProcessor

Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.

RenameProcessorDescriptor<T>

Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.

RenderSearchTemplateDescriptor

Descriptor for RenderSearchTemplate

<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>

RenderSearchTemplateRequest

Request for RenderSearchTemplate

<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>

RenderSearchTemplateResponse

RequestBase<TParameters>

RequestCacheStats

RequestDescriptorBase<TDescriptor, TParameters, TInterface>

Base class for all Request descriptor types

RequestProcessorsDescriptor

RerankResponseProcessor

RerankResponseProcessorDescriptor

Rescore

RescoreDescriptor<T>

RescoreQuery

RescoreQueryDescriptor<T>

RescoringDescriptor<T>

ResolvableDictionaryProxy<TKey, TValue>

ResolveIndexDescriptor

A request to the resolve index API

ResolveIndexRequest

A request to the resolve index API

ResolveIndexResponse

ResolvedAlias

ResolvedIndex

ResponseBase

ResponseProcessorsDescriptor

RestoreDescriptor

Restores a snapshot

RestoreErrorEventArgs

RestoreRequest

Restores a snapshot

RestoreResponse

RestoreStatusHumbleObject

Retries

RetrievalAugmentedGenerationResponseProcessor

RetrievalAugmentedGenerationResponseProcessorDescriptor

ReverseNestedAggregation

ReverseNestedAggregationDescriptor<T>

ReverseTokenFilter

ReverseTokenFilterDescriptor

RolloverConditions

RolloverConditionsDescriptor

Conditions that must be satisfied for a new index to be created with the rollover index API

RolloverIndexDescriptor

Descriptor for Rollover

<p>https://docs.opensearch.org/latest/dashboards/im-dashboards/rollover/</p>

RolloverIndexRequest

Request for Rollover

<p>https://docs.opensearch.org/latest/dashboards/im-dashboards/rollover/</p>

RolloverIndexResponse

RootNodeInfoDescriptor

Descriptor for RootNodeInfo

<p>https://docs.opensearch.org/latest/</p>

RootNodeInfoRequest

Request for RootNodeInfo

<p>https://docs.opensearch.org/latest/</p>

RootNodeInfoResponse

RouteValues

Routing

RoutingField

RoutingFieldDescriptor<T>

RoutingResolver

Rows

RowsDescriptor

RuntimeField

RuntimeFieldDescriptor

RuntimeFields

RuntimeFieldsDescriptor<TDocument>

S3Repository

S3RepositoryDescriptor

A snapshot repository that stores snapshots in an Amazon S3 bucket

Requires the repository-s3 plugin to be installed on the cluster

S3RepositorySettings

S3RepositorySettingsDescriptor

Snapshot repository settings for IS3Repository

SamplerAggregation

SamplerAggregationDescriptor<T>

ScoreCombination

ScoreCombinationDescriptor

ScoreCombinationParameters

ScoreCombinationParametersDescriptor

ScoreFunctionsDescriptor<T>

ScoreNormalization

ScoreNormalizationDescriptor

ScoreRankerCombination

ScoreRankerCombinationDescriptor

ScoreRankerPhaseResultsProcessor

ScoreRankerPhaseResultsProcessorDescriptor

ScriptBase

A script to execute to provide custom computation

ScriptCacheStats

ScriptDescriptor

A script to execute to provide custom computation

ScriptDescriptorBase<TDescriptor, TInterface>

A script to execute to provide custom computation

ScriptField

ScriptFieldDescriptor

ScriptFields

ScriptFieldsDescriptor

ScriptProcessor

Allows inline, stored, and file scripts to be executed within ingest pipelines.

ScriptProcessorDescriptor

Allows inline, stored, and file scripts to be executed within ingest pipelines.

ScriptQuery

A query allowing to define a script to execute as a query

ScriptQueryDescriptor<T>

A query allowing to define a script to execute as a query

ScriptScoreFunction

The script score function allows you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.

ScriptScoreFunctionDescriptor<T>

The script score function allows you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.

ScriptScoreQuery

A query allowing you to modify the score of documents that are retrieved by a query. This can be useful if, for example, a score function is computationally expensive and it is sufficient to compute the score on a filtered set of documents.

ScriptScoreQueryDescriptor<T>

ScriptSort

ScriptSortDescriptor<T>

ScriptStats

ScriptedHeuristic

ScriptedHeuristicDescriptor

ScriptedMetricAggregate

ScriptedMetricAggregation

ScriptedMetricAggregationDescriptor<T>

ScriptedSimilarity

ScriptedSimilarityDescriptor

A similarity that allows a script to be used in order to specify how scores should be computed.

ScrollAllDescriptor<T>

ScrollAllObservable<T>

ScrollAllObserver<T>

ScrollAllRequest

ScrollAllResponse<T>

A response returned for each scroll in ScrollAll()

ScrollDescriptor<TInferDocument>

Descriptor for Scroll

<p>https://docs.opensearch.org/latest/api-reference/search-apis/scroll/#endpoints</p>

ScrollRequest

Request for Scroll

<p>https://docs.opensearch.org/latest/api-reference/search-apis/scroll/#endpoints</p>

SearchAgenticMemoryDescriptor

Descriptor for SearchAgenticMemory

SearchAgenticMemoryRequest

Request for SearchAgenticMemory

SearchAgenticMemoryResponse

SearchAgentsDescriptor

Descriptor for SearchAgents

SearchAgentsRequest

Request for SearchAgents

SearchAgentsResponse

SearchAsYouTypeAttribute

SearchAsYouTypeProperty

A text-like field that is optimized to provide out-of-the-box support for the "search as you type" completion use case.

It creates a series of subfields that are analyzed to index terms that can be efficiently matched by a query that partially matches the entire indexed text value. Both prefix completion (i.e matching terms starting at the beginning of the input) and infix completion (i.e. matching terms at any position within the input) are supported.

SearchAsYouTypePropertyDescriptor<T>

A text-like field that is optimized to provide out-of-the-box support for the "search as you type" completion use case.

SearchConfigurationsSearchDescriptor

Descriptor for SearchConfigurationsSearch

SearchConfigurationsSearchRequest

Request for SearchConfigurationsSearch

SearchConfigurationsSearchResponse

SearchConnectorsDescriptor

Descriptor for SearchConnectors

SearchConnectorsRequest

Request for SearchConnectors

SearchConnectorsResponse

SearchDescriptor<TInferDocument>

A descriptor which describes a search operation for _search and _msearch

SearchHits

SearchHitsDescriptor

SearchHitsHit

SearchHitsHitDescriptor

SearchMemoryContainerDescriptor

Descriptor for SearchMemoryContainer

SearchMemoryContainerRequest

Request for SearchMemoryContainer

SearchMemoryContainerResponse

SearchMemoryDescriptor

Descriptor for SearchMemory

SearchMemoryRequest

Request for SearchMemory

SearchMemoryResponse

SearchMessageDescriptor

Descriptor for SearchMessage

SearchMessageRequest

Request for SearchMessage

SearchMessageResponse

SearchModelGroupDescriptor

Descriptor for SearchModelGroup

SearchModelGroupRequest

Request for SearchModelGroup

SearchModelGroupResponse

SearchModelGroupsResponse

SearchModelGroupsResponseDescriptor

SearchModelsDescriptor

Descriptor for SearchModels

SearchModelsRequest

Request for SearchModels

SearchModelsResponse

SearchNode

SearchPipeline

SearchPipelineDescriptor

SearchPipelineMLOpenSearchReranker

SearchPipelineMLOpenSearchRerankerDescriptor

SearchPipelineRerankContext

SearchPipelineRerankContextDescriptor

SearchProfile

SearchRelevanceSearchRequest

SearchRelevanceSearchRequestDescriptor

SearchRequest

Request for Search

<p>https://docs.opensearch.org/latest/api-reference/search/</p>

SearchRequest<TInferDocument>

SearchResponse

SearchResponseDescriptor

SearchResponse<TDocument>

SearchScriptRequestProcessor

SearchScriptRequestProcessorDescriptor

SearchShard

SearchShardsDescriptor<TDocument>

A descriptor which describes a search operation for _search_shards

SearchShardsRequest

Request for SearchShards

<p>https://docs.opensearch.org/latest/</p>

SearchShardsRequest<TDocument>

SearchShardsResponse

SearchStats

SearchTasksDescriptor

Descriptor for SearchTasks

SearchTasksRequest

Request for SearchTasks

SearchTasksResponse

SearchTemplateDescriptor<TDocument>

Descriptor for SearchTemplate

<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>

SearchTemplateRequest

Request for SearchTemplate

<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>

SearchTemplateRequest<T>

SegmentsStats

OpenSearch 2.0 has Lucene upgraded up to version 9.0 which doesn't provide memory info for segments. All fields except count might be zeroed.

SelectorBase

SerialDifferencingAggregation

SerialDifferencingAggregationDescriptor

SetProcessor

Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one.

SetProcessorDescriptor<T>

Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one.

ShapeQuery

ShapeQueryDescriptor<T>

ShardAllocationExplanation

ShardAllocationSettings

ShardAllocationSettingsDescriptor

ShardBalancingHeuristicsSettings

ShardBalancingHeuristicsSettingsDescriptor

ShardCommitStats

ShardHealthStats

ShardPath

ShardProfile

ShardRebalancingSettings

ShardRebalancingSettingsDescriptor

ShardRetentionLease

ShardRetentionLeasesStats

ShardRouting

ShardSequenceNumberStats

ShardStatistics

ShardsOperationResponseBase

ShingleTokenFilter

ShingleTokenFilterDescriptor

ShrinkIndexDescriptor

Descriptor for Shrink

<p>https://docs.opensearch.org/latest/api-reference/index-apis/shrink-index/</p>

ShrinkIndexRequest

Request for Shrink

<p>https://docs.opensearch.org/latest/api-reference/index-apis/shrink-index/</p>

ShrinkIndexResponse

SignificantTermsAggregate<TKey>

SignificantTermsAggregation

SignificantTermsAggregationDescriptor<T>

SignificantTermsBucket<TKey>

SignificantTextAggregation

An aggregation that returns interesting or unusual occurrences of free-text terms in a set.

SignificantTextAggregationDescriptor<T>

An aggregation that returns interesting or unusual occurrences of free-text terms in a set.

Similarities

SimilaritiesDescriptor

SimpleAnalyzer

SimpleAnalyzerDescriptor

SimpleModel

SimpleModelDescriptor

SimpleQueryStringQuery

A query that uses the SimpleQueryParser to parse its context. Unlike the regular IQueryStringQuery, the ISimpleQueryStringQuery query will never throw an exception, and discards invalid parts of the query.

SimpleQueryStringQueryDescriptor<T>

SimulatePipelineDescriptor

Descriptor for SimulatePipeline

<p>https://docs.opensearch.org/latest/api-reference/ingest-apis/simulate-ingest/</p>

SimulatePipelineDocument

SimulatePipelineDocumentDescriptor

SimulatePipelineDocumentsDescriptor

SimulatePipelineRequest

Request for SimulatePipeline

<p>https://docs.opensearch.org/latest/api-reference/ingest-apis/simulate-ingest/</p>

SimulatePipelineResponse

SingleBucketAggregate

SingleBucketsPath

SingleMappingSelector<T>

SizeField

SizeFieldDescriptor

SlicedScroll

SlicedScrollDescriptor<T>

Slices

SlowLog

SlowLogDescriptor

SlowLogIndexing

SlowLogIndexingDescriptor

SlowLogSearch

SlowLogSearchDescriptor

SlowLogSearchFetch

SlowLogSearchFetchDescriptor

SlowLogSearchQuery

SlowLogSearchQueryDescriptor

SmoothingModelBase

SmoothingModelContainer

SmoothingModelContainerDescriptor

Snapshot

SnapshotCompletedEventArgs

SnapshotDescriptor

Descriptor for Snapshot

<p>https://docs.opensearch.org/latest/api-reference/snapshots/create-snapshot/</p>

SnapshotErrorEventArgs

SnapshotIndexShardStats

SnapshotIndexStats

SnapshotNextEventArgs

SnapshotObservable

SnapshotObserver

SnapshotRequest

Request for Snapshot

<p>https://docs.opensearch.org/latest/api-reference/snapshots/create-snapshot/</p>

SnapshotResponse

SnapshotRestore

SnapshotShardFailure

SnapshotShardsStats

SnapshotStats

SnapshotStatus

SnapshotStatusDescriptor

Descriptor for Status

<p>https://docs.opensearch.org/latest/api-reference/snapshots/get-snapshot-status/</p>

SnapshotStatusHumbleObject

SnapshotStatusRequest

Request for Status

<p>https://docs.opensearch.org/latest/api-reference/snapshots/get-snapshot-status/</p>

SnapshotStatusResponse

SnowballAnalyzer

SnowballAnalyzerDescriptor

SnowballTokenFilter

SnowballTokenFilterDescriptor

SoftDeleteRetentionSettings

SoftDeleteRetentionSettingsDescriptor

SoftDeleteSettings

SoftDeleteSettingsDescriptor

SortBase

SortDescriptorBase<TDescriptor, TInterface, T>

SortDescriptor<T>

SortProcessor

Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings and numbers will be sorted lexicographically.

SortProcessorDescriptor<T>

SortResponseProcessor

SortResponseProcessorDescriptor

SortingSettings

SortingSettingsDescriptor<T>

Source

SourceDescriptor

SourceDescriptor<TDocument>

Descriptor for Source

<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>

SourceExistsDescriptor<TDocument>

Descriptor for SourceExists

<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>

SourceExistsRequest

Request for SourceExists

<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>

SourceExistsRequest<TDocument>

SourceField

SourceFieldDescriptor

SourceFilter

SourceFilterDescriptor<T>

SourceManyExtensions

Provides convenience extension methods to get many _source's given a list of ids.

SourceOnlyRepository

SourceOnlyRepositoryDescriptor

A source repository enables you to create minimal, source-only snapshots that take up to 50% less space on disk. Source only snapshots contain stored fields and index metadata. They do not include index or doc values structures and are not searchable when restored. After restoring a source-only snapshot, you must reindex the data into a new index.

SourceRequest

Request for Source

<p>https://docs.opensearch.org/latest/api-reference/document-apis/get-documents/</p>

SourceRequestResponseBuilder<TDocument>

SourceRequest<TDocument>

SourceResponse<TDocument>

SpanContainingQuery

SpanContainingQueryDescriptor<T>

SpanFieldMaskingQuery

SpanFieldMaskingQueryDescriptor<T>

SpanFirstQuery

SpanFirstQueryDescriptor<T>

SpanGapQuery

SpanGapQueryDescriptor<T>

SpanMultiTermQuery

SpanMultiTermQueryDescriptor<T>

SpanNearQuery

SpanNearQueryDescriptor<T>

SpanNotQuery

SpanNotQueryDescriptor<T>

SpanOrQuery

SpanOrQueryDescriptor<T>

SpanQuery

SpanQueryDescriptor<T>

SpanTermQuery

SpanTermQueryDescriptor<T>

SpanWithinQuery

SpanWithinQueryDescriptor<T>

SplitIndexDescriptor

A request to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index.

SplitIndexRequest

A request to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index.

SplitIndexResponse

SplitProcessor

Splits a field into an array using a separator character. Only works on string fields

SplitProcessorDescriptor<T>

Splits a field into an array using a separator character. Only works on string fields

SplitResponseProcessor

SplitResponseProcessorDescriptor

StandardAnalyzer

StandardAnalyzerDescriptor

StandardDeviationBounds

StandardTokenizer

StandardTokenizerDescriptor

StatsAggregate

StatsAggregation

StatsAggregationDescriptor<T>

StatsBucketAggregation

StatsBucketAggregationDescriptor

StemmerOverrideTokenFilter

StemmerOverrideTokenFilterDescriptor

StemmerTokenFilter

StemmerTokenFilterDescriptor

StopAnalyzer

StopAnalyzerDescriptor

StopTokenFilter

StopTokenFilterDescriptor

StopWords

StoreStats

StoredScript

StoredScriptDescriptor

Strategy

StrategyConfiguration

StrategyConfigurationDescriptor

StrategyDescriptor

StrictnessPropagatingVisitor

StringFielddata

StringFielddataDescriptor

StringTimeSpanAttribute

StupidBackoffSmoothingModel

StupidBackoffSmoothingModelDescriptor

SuffixExtensions

SuggestBucket

SuggestContainer

SuggestContainerDescriptor<T>

SuggestContextBase

SuggestContextDescriptorBase<TDescriptor, TInterface, T>

SuggestContextQueriesDescriptor<T>

SuggestContextQuery

SuggestContextQueryDescriptor<T>

SuggestContextsDescriptor<T>

SuggestDescriptorBase<TDescriptor, TInterface, T>

A suggester that suggests similar looking terms based on a provided text

SuggestDictionary<T>

SuggestFuzziness

SuggestFuzzinessDescriptor<T>

Fuzziness options for a suggester

SuggestOption<TDocument>

Suggest<T>

SuggesterBase

SumAggregation

SumAggregationDescriptor<T>

SumBucketAggregation

SumBucketAggregationDescriptor

SynonymGraphTokenFilter

SynonymGraphTokenFilterDescriptor

SynonymTokenFilter

SynonymTokenFilterDescriptor

TDigestMethod

TDigestMethodDescriptor

TaskExecutingNode

A node executing a task

TaskId

TaskInfo

TaskRetries

TaskState

The state of the task

TaskStatus

Template

TemplateDescriptor

TemplateMapping

Term

TermDescriptor<T>

TermQuery

TermQueryDescriptorBase<TDescriptor, TInterface, T>

TermQueryDescriptor<T>

TermRangeQuery

TermRangeQueryDescriptor<T>

TermSuggester

The term suggester suggests terms based on edit distance. The provided suggest text is analyzed before terms are suggested. The suggested terms are provided per analyzed suggest text token. The term suggester doesn’t take the query into account that is part of request.

TermSuggesterDescriptor<T>

TermVector

TermVectorFilter

Filter terms returned based on their TF-IDF scores. This can be useful in order find out a good characteristic vector of a document.

TermVectorFilterDescriptor

Filter terms returned based on their TF-IDF scores. This can be useful in order find out a good characteristic vector of a document.

TermVectorTerm

TermVectorsDescriptor<TDocument>

Descriptor for TermVectors

<p>https://docs.opensearch.org/latest/</p>

TermVectorsRequest<TDocument>

Request for TermVectors

<p>https://docs.opensearch.org/latest/</p>

TermVectorsResponse

TermVectorsResult

TermsAggregate<TKey>

TermsAggregation

TermsAggregationDescriptor<T>

TermsCompositeAggregationSource

A values source that is equivalent to a simple terms aggregation. The values are extracted from a field or a script exactly like the terms aggregation.

TermsCompositeAggregationSourceDescriptor<T>

A values source that is equivalent to a simple terms aggregation. The values are extracted from a field or a script exactly like the terms aggregation.

TermsExclude

Filters which terms to exclude from the response

TermsInclude

Filters which terms to include in the response

TermsOrder

TermsOrderDescriptor<T>

TermsQuery

TermsQueryDescriptor<T>

A query that match on any (configurable) of the provided terms. This is a simpler syntax query for using a bool query with several term queries in the should clauses.

TermsSetQuery

Returns any documents that match with at least one or more of the provided terms. The terms are not analyzed and thus must match exactly. The number of terms that must match varies per document and is either controlled by a minimum should match field or computed per document in a minimum should match script.

TermsSetQueryDescriptor<T>

TextAttribute

TextEmbeddingProcessor

The text_embedding processor is used to generate vector embeddings from text fields for semantic search.

TextEmbeddingProcessorDescriptor<TDocument>

The text_embedding processor is used to generate vector embeddings from text fields for semantic search.

TextIndexPrefixes

TextIndexPrefixesDescriptor

TextProperty

A field to index full-text values, such as the body of an email or the description of a product. These fields are analyzed in OpenSearch, by passing through an analyzer to convert the string into a list of individual terms before being indexed.

Text fields are not used for sorting and seldom used for aggregations

TextPropertyDescriptor<T>

Text fields are not used for sorting and seldom used for aggregations

ThreadCountStats

Time

Represents a time value

Timestamp

TimestampField

TimestampFieldDescriptor

Token

TokenCountAttribute

TokenCountProperty

A field of type token_count is really an integer field which accepts string values, analyzes them, then indexes the number of tokens in the string.

TokenCountPropertyDescriptor<T>

A field of type token_count is really an integer field which accepts string values, analyzes them, then indexes the number of tokens in the string.

TokenDetail

TokenFilterBase

TokenFilterDescriptorBase<TTokenFilter, TTokenFilterInterface>

TokenFilters

TokenFiltersDescriptor

TokenizerBase

TokenizerDescriptorBase<TTokenizer, TTokenizerInterface>

Tokenizers

TokenizersDescriptor

Tool

ToolAttributes

ToolAttributesDescriptor

ToolDescriptor

ToolItems

ToolItemsDescriptor

TopHitsAggregate

TopHitsAggregation

TopHitsAggregationDescriptor<T>

TotalHits

Description of the total number of hits of a query. The total hit count can't generally be computed accurately without visiting all matches, which is costly for queries that match lots of documents. Given that it is often enough to have a lower bounds of the number of hits, such as "there are more than 1000 hits", OpenSearch has options to stop counting as soon as a threshold has been reached in order to improve query times.

TotalIndexingLoad

TrackTotalHits

TrainDescriptor

Descriptor for Train

TrainParameters

TrainParametersDescriptor

TrainPredictDescriptor

Descriptor for TrainPredict

TrainPredictRequest

Request for TrainPredict

TrainPredictResponse

TrainRequest

Request for Train

TrainResponse

TranslogFlushSettings

TranslogFlushSettingsDescriptor

TranslogSettings

TranslogSettingsDescriptor

TranslogStats

TransportStats

TrimProcessor

Trims whitespace from field. This only works on leading and trailing whitespace

TrimProcessorDescriptor<T>

Trims whitespace from field. This only works on leading and trailing whitespace

TrimTokenFilter

TrimTokenFilterDescriptor

TruncateHitsResponseProcessor

TruncateHitsResponseProcessorDescriptor

TruncateTokenFilter

TruncateTokenFilterDescriptor

TypeExistsDescriptor

Descriptor for TypeExists

<p>https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/</p>

TypeExistsRequest

Request for TypeExists

<p>https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/</p>

TypeFieldMappings

TypeMapping

TypeMappingDescriptor<T>

UaxEmailUrlTokenizer

UaxEmailUrlTokenizerDescriptor

UnassignedInformation

UndeployModelDescriptor

Descriptor for UndeployModel

UndeployModelNode

UndeployModelNodeDescriptor

UndeployModelNodeStats

UndeployModelNodeStatsDescriptor

UndeployModelRequest

Request for UndeployModel

UndeployModelResponse

Union<TFirst, TSecond>

Represents the union of two types, TFirst and TSecond. Used in scenarios where an OpenSearch API may accept more than one different input data structure.

UniqueTokenFilter

UniqueTokenFilterDescriptor

UnloadModelDescriptor

Descriptor for UnloadModel

UnloadModelNode

UnloadModelNodeDescriptor

UnloadModelNodeStats

UnloadModelNodeStatsDescriptor

UnloadModelRequest

Request for UnloadModel

UnloadModelResponse

UpdatableIndexSettings

Collection of OpenSearch index settings that can be dynamically updated

UpdateAgenticMemoryDescriptor

Descriptor for UpdateAgenticMemory

UpdateAgenticMemoryRequest

Request for UpdateAgenticMemory

UpdateAgenticMemoryResponse

UpdateByQueryDescriptor<TDocument>

Descriptor for UpdateByQuery

<p>https://docs.opensearch.org/latest/api-reference/document-apis/update-by-query/</p>

UpdateByQueryRequest

Request for UpdateByQuery

<p>https://docs.opensearch.org/latest/api-reference/document-apis/update-by-query/</p>

UpdateByQueryRequest<TDocument>

UpdateByQueryResponse

UpdateByQueryRethrottleDescriptor

Descriptor for UpdateByQueryRethrottle

<p>https://docs.opensearch.org/latest/</p>

UpdateByQueryRethrottleRequest

Request for UpdateByQueryRethrottle

<p>https://docs.opensearch.org/latest/</p>

UpdateConnectorDescriptor

Descriptor for UpdateConnector

UpdateConnectorRequest

Request for UpdateConnector

UpdateConnectorResponse

UpdateControllerDescriptor

Descriptor for UpdateController

UpdateControllerRequest

Request for UpdateController

UpdateControllerResponse

UpdateDescriptor<TDocument, TPartialDocument>

Descriptor for Update

<p>https://docs.opensearch.org/latest/api-reference/document-apis/update-document/</p>

UpdateIndexSettingsDescriptor

Descriptor for UpdateSettings

<p>https://docs.opensearch.org/latest/api-reference/index-apis/update-settings/</p>

UpdateIndexSettingsRequest

Request for UpdateSettings

<p>https://docs.opensearch.org/latest/api-reference/index-apis/update-settings/</p>

UpdateIndexSettingsResponse

UpdateMemoryContainerDescriptor

Descriptor for UpdateMemoryContainer

UpdateMemoryContainerRequest

Request for UpdateMemoryContainer

UpdateMemoryContainerResponse

UpdateMemoryDescriptor

Descriptor for UpdateMemory

UpdateMemoryRequest

Request for UpdateMemory

UpdateMemoryResponse

UpdateMessageDescriptor

Descriptor for UpdateMessage

UpdateMessageRequest

Request for UpdateMessage

UpdateMessageResponse

UpdateModelDescriptor

Descriptor for UpdateModel

UpdateModelGroupDescriptor

Descriptor for UpdateModelGroup

UpdateModelGroupRequest

Request for UpdateModelGroup

UpdateModelGroupResponse

UpdateModelRequest

Request for UpdateModel

UpdateModelResponse

UpdateRequest<TDocument, TPartialDocument>

Request for Update

<p>https://docs.opensearch.org/latest/api-reference/document-apis/update-document/</p>

UpdateResponse<TDocument>

UploadChunkDescriptor

Descriptor for UploadChunk

UploadChunkRequest

Request for UploadChunk

UploadChunkResponse

UploadModelDescriptor

Descriptor for UploadModel

UploadModelRequest

Request for UploadModel

UploadModelResponse

UppercaseProcessor

UppercaseProcessorDescriptor<T>

UppercaseTokenFilter

UppercaseTokenFilterDescriptor

UriPartsProcessor

UriPartsProcessorDescriptor<T>

UrlDecodeProcessor

URL-decodes a string

UrlDecodeProcessorDescriptor<T>

URL-decodes a string

UserAgentProcessor

Ingest pipelines are composed of one or more processors

UserAgentProcessorDescriptor<T>

Ingest pipelines are composed of one or more processors

ValidateQueryDescriptor<TDocument>

Descriptor for ValidateQuery

<p>https://docs.opensearch.org/latest/</p>

ValidateQueryRequest

Request for ValidateQuery

<p>https://docs.opensearch.org/latest/</p>

ValidateQueryRequest<TDocument>

ValidateQueryResponse

ValidationExplanation

ValueAggregate

ValueCountAggregation

ValueCountAggregationDescriptor<T>

Values

ValuesDescriptor

VariableWidthHistogramAggregation

VariableWidthHistogramAggregationDescriptor<T>

VariableWidthHistogramBucket

VerbatimPropagatingVisitor

VerifyRepositoryDescriptor

Descriptor for VerifyRepository

<p>https://docs.opensearch.org/latest/api-reference/snapshots/verify-snapshot-repository/</p>

VerifyRepositoryRequest

Request for VerifyRepository

<p>https://docs.opensearch.org/latest/api-reference/snapshots/verify-snapshot-repository/</p>

VerifyRepositoryResponse

WarmerStats

WeightFunction

WeightFunctionDescriptor<T>

WeightedAverageAggregation

WeightedAverageAggregationDescriptor<T>

WeightedAverageValue

WeightedAverageValueDescriptor<T>

WhitespaceAnalyzer

WhitespaceAnalyzerDescriptor

WhitespaceTokenizer

A tokenizer of type whitespace that divides text at whitespace.

WhitespaceTokenizerDescriptor

A tokenizer of type whitespace that divides text at whitespace.

WildcardAttribute

WildcardProperty

A wildcard field stores values optimised for wildcard grep-like queries.

WildcardPropertyDescriptor<T>

A wildcard field stores values optimised for wildcard grep-like queries.

WildcardQuery

WildcardQueryDescriptor<T>

WildcardQuery<T, TValue>

WordDelimiterGraphTokenFilter

WordDelimiterGraphTokenFilterDescriptor

WordDelimiterTokenFilter

WordDelimiterTokenFilterDescriptor

WriteResponseBase

Interfaces

IAddAgenticMemoryRequest

IAddIndexBlockRequest

A request to the indices add block API

IAdditionalConfig

IAdditionalInfo

IAdjacencyMatrixAggregation

IAgenticContextResponseProcessor

IAgenticQueryTranslatorRequestProcessor

IAggregate

Aggregation response for an aggregation request

IAggregation

An aggregation on the request

IAggregationContainer

IAggregationRange

Range that defines a bucket for either the RangeAggregation or GeoDistanceAggregation. If you are looking to store ranges as part of your document please use explicit range class e.g DateRange, FloatRange etc

IAggregationVisitor

IAlgorithmOperations

IAlias

An alias to one or more indices

IAliasAction

Marker interface for alias operation

IAliasAddAction

IAliasExistsRequest

IAliasRemoveAction

IAliasRemoveIndexAction

IAliases

IAllocateClusterRerouteCommand

IAllocateEmptyPrimaryRerouteCommand

IAllocateReplicaClusterRerouteCommand

IAllocateStalePrimaryRerouteCommand

IAllocationAttributes

IAllocationAwarenessSettings

IAllocationFilteringSettings

IAnalysis

IAnalyzeRequest

IAnalyzer

IAnalyzers

IAppendProcessor

IArbitraryBodyHttpRequest<T>

IArbitraryHttpRequest<T>

IAsciiFoldingTokenFilter

A token filter of type asciifolding that converts alphabetic, numeric, and symbolic Unicode characters which are

not in the first 127 ASCII characters (the “Basic Latin” Unicode block) into their ASCII equivalents, if one exists.

IAttachmentProcessor

IAutoDateHistogramAggregation

IAverageAggregation

IAverageBucketAggregation

IAzureRepository

A snapshot repository that stores snapshots in an Azure storage account

Requires the repository-azure plugin to be installed on the cluster

IAzureRepositorySettings

Snapshot repository settings for IAzureRepository

IBM25Similarity

BM25 Similarity. Introduced in Stephen E. Robertson, Steve Walker, Susan Jones, Micheline Hancock-Beaulieu, and Mike Gatford. Okapi at TREC-3. In Proceedings of the Third Text Retrieval Conference (TREC 1994). Gaithersburg, USA, November 1994.

IBinaryProperty

The binary type accepts a binary value as a Base64 encoded string. The field is not stored by default and is not searchable

IBoolQuery

IBooleanProperty

The boolean fields accepts true and false values

IBoostingQuery

IBoundingBox

IBucket

IBucketAggregation

IBucketScriptAggregation

IBucketSelectorAggregation

IBucketSortAggregation

IBuckets

IBucketsPath

IBulkAliasRequest

IBulkAllRequest<T>

IBulkCreateOperation<T>

IBulkDeleteOperation<T>

IBulkIndexOperation<T>

IBulkOperation

IBulkRequest

IBulkStreamRequest

IBulkUpdateOperation<TDocument, TPartialDocument>

IByteBuffer

IBytesProcessor

ICancelClusterRerouteCommand

ICancelTasksRequest

ICardinalityAggregation

ICatAliasesRequest

ICatAllPitSegmentsRequest

ICatAllocationRequest

ICatClusterManagerRequest

ICatCountRequest

ICatFielddataRequest

ICatHealthRequest

ICatHelpRequest

ICatIndicesRequest

ICatMasterRequest

ICatNodeAttributesRequest

ICatNodesRequest

ICatPendingTasksRequest

ICatPitSegmentsRequest

ICatPluginsRequest

ICatRecord

ICatRecoveryRequest

ICatRepositoriesRequest

ICatSegmentReplicationRequest

ICatSegmentsRequest

ICatShardsRequest

ICatSnapshotsRequest

ICatTasksRequest

ICatTemplatesRequest

ICatThreadPoolRequest

ICategorySuggestContext

ICharFilter

ICharFilters

ICharGroupTokenizer

IChiSquareHeuristic

IChildrenAggregation

IChunkModelRequest

ICircleGeoShape

ICircuitBreakerSettings

ICleanupRepositoryRequest

IClearCacheRequest

IClearScrollRequest

IClientConfig

ICloneIndexRequest

A request to the clone index API

ICloneSnapshotRequest

ICloseIndexRequest

IClrPropertyMapping<TDocument>

IClrTypeMapping

IClrTypeMapping<TDocument>

IClusterAllocationExplainRequest

IClusterGetSettingsRequest

IClusterHealthRequest

IClusterModuleSettings

Settings to control where, when, and how shards are allocated to nodes.

IClusterPendingTasksRequest

IClusterPutSettingsRequest

IClusterRerouteCommand

IClusterRerouteRequest

IClusterStateRequest

IClusterStatsRequest

ICollapseResponseProcessor

IColumnMeta

ICombinedFieldsQuery

All queried fields must have the same search analyzer. Only text fields are supported.

ICommonGramsTokenFilter

Token filter that generates bigrams for frequently occuring terms. Single terms are still indexed.

Note, common_words or common_words_path field is required.

ICompletionProperty

ICompletionSuggester

IComponentTemplate

IComponentTemplateExistsRequest

IComposableIndexTemplate

IComposableIndexTemplateExistsRequest

ICompositeAggregation

A multi-bucket aggregation that creates composite buckets from different sources.

ICompositeAggregationSource

A values source for ICompositeAggregation

ICompoundWordTokenFilter

Token filters that allow to decompose compound words.

IConditionTokenFilter

The conditional token filter takes a predicate script and a list of subfilters, and only applies the subfilters to the current token if it matches the predicate.

IConditionlessQuery

IConnectionSettingsValues

Provides the connection settings for OpenSearchClient

IConstantScoreQuery

IContent

IConvertProcessor

Converts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted.

ICoreProperty

Core properties of a mapping for a property type to a document field in OpenSearch

ICountRequest

ICountRequest<TDocument>

ICreateConnectorRequest

ICreateControllerRequest

ICreateIndexRequest

ICreateMemoryContainerRequest

ICreateMemoryContainerSessionRequest

ICreateMemoryRequest

ICreateMessageRequest

ICreateModelMetaRequest

ICreatePitRequest

ICreateRepositoryRequest

Creates a snapshot repository

ICreateRequest<TDocument>

ICredential

ICsvProcessor

Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.

ICumulativeSumAggregation

ICustomAnalyzer

An analyzer of type custom that allows to combine a Tokenizer with zero or more Token Filters, and zero or more Char Filters.

The custom analyzer accepts a logical/registered name of the tokenizer to use, and a list of logical/registered names of token filters.

ICustomNormalizer

Normalizers are similar to analyzers except that they may only emit a single token. As a consequence, they do not have a tokenizer and only accept a subset of the available char filters and token filters. Only the filters that work on a per-character basis are allowed. For instance a lowercasing filter would be allowed, but not a stemming filter, which needs to look at the keyword as a whole.

OpenSearch does not ship with built-in normalizers so far, so the only way to create one is through composing a custom one

ICustomSimilarity

A custom similarity

IDFISimilarity

Similarity that implements the divergence from independence model

IDFRSimilarity

Implements the divergence from randomness (DFR) framework introduced in Gianni Amati and Cornelis Joost Van Rijsbergen. 2002. Probabilistic models of information retrieval based on measuring the divergence from randomness. ACM Trans. Inf. Syst. 20, 4 (October 2002), 357-389. The DFR scoring formula is composed of three separate components: the basic model, the aftereffect and an additional normalization component, represented by the classes BasicModel, AfterEffect and Normalization, respectively.The names of these classes were chosen to match the names of their counterparts in the Terrier IR engine.

IDataAsMap

IDataStreamTemplate

IDateHistogramAggregation

IDateHistogramCompositeAggregationSource

IDateIndexNameProcessor

The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.

IDateMath

IDateNanosProperty

The date nanos datatype is similar to IDateProperty, except that internally, the date is stored with nanosecond resolution. This limits its range of dates from roughly 1970 to 2262.

IDateProcessor

IDateProperty

The date datatype maps a field as a date in OpenSearch.

IDateRangeAggregation

IDateRangeExpression

IDateRangeProperty

A range of date values represented as unsigned 64-bit integer milliseconds elapsed since system epoch.

IDateRangeQuery

IDecayFunction

IDecayFunction<TOrigin, TScale>

IDeleteAgentRequest

IDeleteAgenticMemoryQueryRequest

IDeleteAgenticMemoryRequest

IDeleteAliasRequest

IDeleteAllPitsRequest

IDeleteByQueryRequest

Delete documents that match a given query

IDeleteByQueryRequest<TDocument>

Delete documents that match a given query

IDeleteByQueryRethrottleRequest

Rethrottles a running delete by query

IDeleteComponentTemplateRequest

IDeleteComposableIndexTemplateRequest

IDeleteConnectorRequest

IDeleteControllerRequest

IDeleteDanglingIndexRequest

IDeleteExperimentsRequest

IDeleteIndexRequest

IDeleteIndexTemplateRequest

IDeleteJudgmentsRequest

IDeleteMemoryContainerRequest

IDeleteMemoryRequest

IDeleteModelGroupRequest

IDeleteModelRequest

IDeletePipelineRequest

IDeletePitRequest

IDeleteQuerySetsRequest

IDeleteRepositoryRequest

IDeleteRequest

IDeleteRequest<TDocument>

IDeleteScheduledExperimentsRequest

IDeleteScriptRequest

IDeleteSearchConfigurationsRequest

IDeleteSearchPipelineRequest

IDeleteSnapshotRequest

IDeleteTaskRequest

IDeleteVotingConfigExclusionsRequest

IDelimitedPayloadTokenFilter

Splits tokens into tokens and payload whenever a delimiter character is found.

IDeployModelRequest

IDerivativeAggregation

IDescriptor

IDictionaryDecompounderTokenFilter

IDictionaryResponse<TKey, TValue>

IDirectGenerator

IDisMaxQuery

IDiskBasedShardAllocationSettings

IDissectProcessor

IDistanceFeatureQuery

IDiversifiedSamplerAggregation

IDocValuesProperty

Properties of a mapping for a property type to a document field that has doc_values in OpenSearch

IDocumentExistsRequest

IDocumentExistsRequest<TDocument>

IDocumentPath

IDocumentRequest

Describes a request that serializes the document passed to DocumentPath<T> when calling the fluent API.

IDotExpanderProcessor

IDoubleRangeProperty

A range of double-precision 64-bit IEEE 754 floating point values.

IDropProcessor

Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.

IDynamicIndexSettings

Dynamic index settings

IDynamicResponse

IDynamicTemplate

A Dynamic template that defines custom mappings to be applied to dynamically added fields based on:

the datatype detected by OpenSearch, with MatchMappingType.

the name of the field, with Match and Unmatch or MatchPattern.

the full dotted path to the field, with PathMatch and PathUnmatch.

IDynamicTemplateContainer

IEdgeNGramTokenFilter

A token filter of type edgeNGram.

IEdgeNGramTokenizer

A tokenizer of type edgeNGram.

IElisionTokenFilter

A token filter which removes elisions. For example, “l’avion” (the plane) will tokenized as “avion” (plane).

IEntity

IEnvelopeGeoShape

IEwmaModel

IExecuteAgentRequest

IExecuteAlgorithmRequest

IExecuteAnomalyLocalizationResponse

IExecuteLocalSampleCalculatorResponse

IExecutePainlessScriptRequest

The Painless execute API allows an arbitrary script to be executed and a result to be returned.

IExecutePainlessScriptResponse<TResult>

IExecuteToolRequest

IExistsQuery

IExperimentsSearchRequest

IExplainRequest

IExplainRequest<TDocument>

IExplainResponse<TDocument>

IExtendedStatsAggregation

IExtendedStatsBucketAggregation

IFailProcessor

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

IFieldAliasProperty

An alias mapping defines an alternate name for a field in the index. The alias can be used in place of the target field in search requests, and selected other APIs like field capabilities.

IFieldCapabilitiesRequest

IFieldCollapse

NOTE: The collapsing is applied to the top hits only and does not affect aggregations.

IFieldLookup

IFieldMapping

A document field mapping in OpenSearch

IFieldNameQuery

IFieldNamesField

IFieldSort

IFieldValueFactorFunction

IFielddata

IFielddataFilter

IFielddataFrequencyFilter

IFielddataRegexFilter

IFileSystemRepository

IFileSystemRepositorySettings

Repository settings for IFileSystemRepository

IFilterAggregation

IFilterQueryRequestProcessor

IFiltersAggregation

IFingerprintAnalyzer

The fingerprint analyzer implements a fingerprinting algorithm which is used by the OpenRefine project to assist in clustering.

IFingerprintProcessor

IFingerprintTokenFilter

The fingerprint token filter emits a single token which is useful for fingerprinting a body of text, and/or providing a token that can be clustered on. It does this by sorting the tokens, deduplicating and then concatenating them back into a single token.

IFloatRangeProperty

A range of single-precision 32-bit IEEE 754 floating point values.

IFlushRequest

IForceMergeRequest

IForeachProcessor

IFormattableMetricAggregation

A metric aggregation that can accept a format to use for the output of the aggregation

IFunctionScoreQuery

IFuzziness

IFuzzyDateQuery

IFuzzyNumericQuery

IFuzzyQuery

IFuzzyQuery<TValue, TFuzziness>

IFuzzyStringQuery

IGenericProperty

A generic property to map properties that may be of different types. Not all methods are valid for all types.

IGeoBoundingBoxQuery

IGeoBoundsAggregation

IGeoCentroidAggregation

IGeoDistanceAggregation

IGeoDistanceQuery

IGeoDistanceSort

Allows you to sort based on a proximity to one or more GeoLocation

IGeoHashGridAggregation

IGeoIpProcessor

IGeoLineAggregation

IGeoPointFielddata

IGeoPointProperty

Data type mapping to map a property as a geopoint

IGeoPolygonQuery

IGeoShape

IGeoShapeProperty

Maps a property as a geo_shape field

IGeoShapeQuery

IGeoSuggestContext

IGeoTileGridAggregation

IGeoTileGridCompositeAggregationSource

A values source that is equivalent to a simple Geo aggregation.

IGeometryCollection

A geo shape representing a collection of IGeoShape geometries

IGetAgentRequest

IGetAgenticMemoryRequest

IGetAliasRequest

IGetAllMemoriesRequest

IGetAllMessagesRequest

IGetAllPitsRequest

IGetAllToolsRequest

IGetComponentTemplateRequest

IGetComposableIndexTemplateRequest

IGetConnectorRequest

IGetControllerRequest

IGetExperimentsRequest

IGetFieldMappingRequest

IGetIndexRequest

IGetIndexSettingsRequest

IGetIndexTemplateRequest

IGetJudgmentsRequest

IGetMLTaskRequest

IGetMappingRequest

IGetMemoryContainerRequest

IGetMemoryRequest

IGetMessageRequest

IGetMessageTracesRequest

IGetModelGroupRequest

IGetModelRequest

IGetNodeStatsRequest

IGetPipelineRequest

IGetProfileModelsRequest

IGetProfileRequest

IGetProfileTasksRequest

IGetQuerySetsRequest

IGetRepositoryRequest

IGetRequest

IGetRequest<TDocument>

IGetResponse<TDocument>

IGetScheduledExperimentsRequest

IGetScriptRequest

IGetSearchConfigurationsRequest

IGetSearchPipelineRequest

IGetSearchRelevanceStatsRequest

IGetSnapshotRequest

IGetStatsRequest

IGetTaskRequest

IGetToolRequest

IGlobalAggregation

IGoogleNormalizedDistanceHeuristic

IGrokProcessor

IGrokProcessorPatternsRequest

IGsubProcessor

Converts a string field by applying a regular expression and a replacement. If the field is not a string, the processor will throw an exception.

IGuardrails

IGuardrailsInputOutput

IHDRHistogramMethod

IHasAdditionalProperties

Implemented by generated types whose OpenAPI schema declares additionalProperties: true. The AdditionalProperties dictionary is serialized as top-level sibling keys alongside the typed members, and any unrecognized key during deserialization is stored here.

IHasChildQuery

IHasParentQuery

IHdfsRepository

A snapshot repository that stores snapshot data within a Hadoop HDFS filesystem

Requires the repository-hdfs plugin to be installed on the cluster

IHdfsRepositorySettings

Snapshot repository settings for IHdfsRepository

IHeaders

IHighlight

IHighlightField

IHistogramAggregation

IHistogramCompositeAggregationSource

IHitMetadata<TDocument>

Metadata about a hit matching a query

IHit<TDocument>

A hit matching a query

IHitsMetadata<T>

IHitsTotal

IHoltLinearModel

IHoltWintersModel

IHtmlStripCharFilter

A char filter of type html_strip stripping out HTML elements from an analyzed text.

IHttpDeleteRequest

IHttpGetRequest

IHttpHeadRequest

IHttpPatchRequest

IHttpPostRequest

IHttpPutRequest

IHunspellTokenFilter

Basic support for hunspell stemming.

Hunspell dictionaries will be picked up from a dedicated hunspell directory on the filesystem.

IHybridQuery

A hybrid query.

IHyphenationDecompounderTokenFilter

Token filters that allow to decompose compound words.

IIBSimilarity

IIcuAnalyzer

An ICU analyzer that performs basic normalization, tokenization and character folding, using the IIcuNormalizationCharFilter char filter, IIcuTokenizer and IcuNormalizationTokenFilter token filter

IIcuCollationTokenFilter

IIcuFoldingTokenFilter

Case folding of Unicode characters based on UTR#30, like the ASCII-folding token filter on steroids.

IIcuNormalizationCharFilter

Normalizes as defined here: http://userguide.icu-project.org/transforms/normalization

IIcuNormalizationTokenFilter

Normalizes as defined here: http://userguide.icu-project.org/transforms/normalization

IIcuTokenizer

Tokenizes text into words on word boundaries, as defined in UAX #29: Unicode Text Segmentation. It behaves much like the standard tokenizer, but adds better support for some Asian languages by using a dictionary-based approach to identify words in Thai, Lao, Chinese, Japanese, and Korean, and using custom rules to break Myanmar and Khmer text into syllables.

IIcuTransformTokenFilter

Transforms are used to process Unicode text in many different ways, such as case mapping, normalization, transliteration and bidirectional text handling.

IIdsQuery

IImportDanglingIndexRequest

IIndex

IIndexExistsRequest

IIndexRequest<TDocument>

IIndexSettings

The settings for an index

IIndexState

IIndexTemplateExistsRequest

IIndexedScript

IIndicesModuleSettings

Settings to control where, when, and how shards are allocated to nodes.

IIndicesRecoverySettings

IIndicesStatsRequest

IInferenceFieldMap

IInferenceProcessor

IInferenceResults

IInlineGet<TDocument>

IInlineScript

IInnerHits

IInputQuery

IIntegerRangeProperty

A range of signed 32-bit integers with a minimum value of -231 and maximum of 231-1.

IIntervals

An IIntervalsQuery rule with an optional filter

IIntervalsAllOf

A rule that returns matches that span a combination of other rules.

IIntervalsAnyOf

A rule that emits intervals produced by any of its sub-rules.

IIntervalsContainer

Container for an IIntervalsQuery rule

IIntervalsFilter

Filters intervals produced by any rules by their relation to the intervals produced by another rule

IIntervalsFuzzy

The fuzzy rule matches terms that are similar to the provided term, within an edit distance defined by Fuzziness. If the fuzzy expansion matches more than 128 terms, OpenSearch returns an error.

IIntervalsMatch

Matches the analyzed text

IIntervalsNoFilter

An IIntervalsQuery rule

IIntervalsPrefix

IIntervalsQuery

IIntervalsWildcard

Matches terms using a wildcard pattern. This pattern can expand to match at most 128 terms. If the pattern matches more than 128 terms, OpenSearch returns an error.

IIpProperty

An ip field can index/store either IPv4 or IPv6 addresses.

IIpRangeAggregation

IIpRangeAggregationRange

IIpRangeProperty

A range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.

IIsADictionary

IIsADictionary<TKey, TValue>

IIsAReadOnlyDictionary

IIsAReadOnlyDictionary<TKey, TValue>

IJoinProcessor

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

IJoinProperty

The join datatype is a special field that creates parent/child relation within documents of the same index.

IJsonProcessor

Converts a JSON string into a structured JSON object.

IJudgmentsSearchRequest

IKStemTokenFilter

The kstem token filter is a high performance filter for english.

All terms must already be lowercased (use lowercase filter) for this filter to work correctly.

IKeepTypesTokenFilter

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

IKeepWordsTokenFilter

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

IKeyValueProcessor

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

IKeywordAnalyzer

An analyzer of type keyword that “tokenizes” an entire stream as a single token. This is useful for data like zip codes, ids and so on.

Note, when using mapping definitions, it make more sense to simply mark the field as not_analyzed.

IKeywordMarkerTokenFilter

Protects words from being modified by stemmers. Must be placed before any stemming filters.

IKeywordProperty

A field to index structured content such as IDs, email addresses, hostnames, status codes, zip codes or tags. Used for filtering, sorting, and for aggregations.

Keyword fields are only searchable by their exact value.

IKeywordTokenizer

A tokenizer of type keyword that emits the entire input as a single input.

IKnnMethod

IKnnMethodParameters

IKnnQuery

An approximate k-NN query.

IKnnQueryRescoreContext

Configures rescoring of approximate k-NN search results using full-precision vectors.

IKnnVectorProperty

IKuromojiAnalyzer

An analyzer tailored for japanese that is bootstrapped with defaults. Part of the analysis-kuromoji plugin:

IKuromojiIterationMarkCharFilter

The kuromoji_iteration_mark normalizes Japanese horizontal iteration marks (odoriji) to their expanded form. Part of the analysis-kuromoji plugin:

IKuromojiPartOfSpeechTokenFilter

The kuromoji_part_of_speech token filter removes tokens that match a set of part-of-speech tags. Part of the analysis-kuromoji plugin:

IKuromojiReadingFormTokenFilter

The kuromoji_readingform token filter replaces the token with its reading form in either katakana or romaji. Part of the analysis-kuromoji plugin:

IKuromojiStemmerTokenFilter

The kuromoji_stemmer token filter normalizes common katakana spelling variations ending in a long sound character by removing this character (U+30FC). Only full-width katakana characters are supported. Part of the analysis-kuromoji plugin:

IKuromojiTokenizer

A tokenizer of type pattern that can flexibly separate text into terms via a regular expression. Part of the analysis-kuromoji plugin:

ILLM

ILMDirichletSimilarity

A similarity with Bayesian smoothing using Dirichlet priors.

ILMJelinekMercerSimilarity

A similarity that attempts to capture important patterns in the text, while leaving out noise.

ILanguageAnalyzer

A set of analyzers aimed at analyzing specific language text.

ILaplaceSmoothingModel

ILazyDocument

A lazily deserialized document

ILengthTokenFilter

A token filter of type length that removes words that are too long or too short for the stream.

ILetterTokenizer

A tokenizer of type letter that divides text at non-letters. That’s to say, it defines tokens as maximal strings of adjacent letters.

Note, this does a decent job for most European languages, but does a terrible job for some Asian languages, where words are not separated by spaces.

ILikeDocument

An indexed or artificial document with which to find likeness

ILimitTokenCountTokenFilter

Limits the number of tokens that are indexed per document and field.

ILineStringGeoShape

ILinearInterpolationSmoothingModel

ILinearModel

IListDanglingIndicesRequest

IListTasksRequest

ILoadModelRequest

ILongRangeProperty

A range of signed 64-bit integers with a minimum value of -263 and maximum of 263-1.

ILongRangeQuery

ILowercaseProcessor

Converts a string to its lowercase equivalent.

ILowercaseTokenFilter

A token filter of type lowercase that normalizes token text to lower case.

Lowercase token filter supports Greek and Turkish lowercase token filters through the language parameter.

ILowercaseTokenizer

A tokenizer of type lowercase that performs the function of Letter Tokenizer and Lower Case Token Filter together.

It divides text at non-letters and converts them to lower case.

While it is functionally equivalent to the combination of Letter Tokenizer and Lower Case Token Filter,

there is a performance advantage to doing the two tasks at once, hence this (redundant) implementation.

IMLAction

IMLAggregation

IMLIndexSettings

IMLInferenceRequestProcessor

IMLMetadata

IMLNode

IMLResult

IMLTask

IMappingCharFilter

A char filter of type mapping replacing characters of an analyzed text with given mapping.

IMappingVisitor

IMatchAllQuery

IMatchBoolPrefixQuery

A match_bool_prefix query analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

IMatchNoneQuery

IMatchPhrasePrefixQuery

IMatchPhraseQuery

IMatchQuery

A match query for a single field

IMatrixAggregation

IMatrixStatsAggregation

IMaxAggregation

IMaxBucketAggregation

IMedianAbsoluteDeviationAggregation

This single-value aggregation approximates the median absolute deviation of its search results.

It is calculated as the median of each data point’s deviation from the median of the entire sample. That is, for a random variable

, the median absolute deviation is

median(|median(X) - Xi|).

IMemory

IMemoryContainerConfiguration

IMemoryIndexSettings

IMergePolicySettings

IMergeSchedulerSettings

IMergeSettings

IMessage

IMessages

IMetricAggregation

An aggregation that computes metrics based on values extracted in one way or another from the documents that are being aggregated.

IMinAggregation

IMinBucketAggregation

IMissingAggregation

IModel

IModelConfig

IModelGroup

IModelGroupRegistration

IModelProfile

IModelStats

IMoreLikeThisQuery

IMoveClusterRerouteCommand

IMovingAverageAggregation

IMovingAverageModel

IMovingFunctionAggregation

IMultiBucketsPath

IMultiGetHit<TDocument>

IMultiGetOperation

IMultiGetRequest

IMultiLineStringGeoShape

IMultiMatchQuery

A match query across multiple fields.

IMultiPointGeoShape

IMultiPolygonGeoShape

IMultiSearchRequest

IMultiSearchTemplateRequest

IMultiTermVectorOperation

An operation to define the calculation of term vectors when using Multi termvectors API

IMultiTermVectorsRequest

A Multi termvectors API request

IMultiTermsAggregation

IMultiplexerTokenFilter

IMurmur3HashProperty

IMutualInformationHeuristic

INGramTokenFilter

A token filter of type nGram.

INGramTokenizer

A tokenizer of type nGram.

INamedFiltersContainer

INamespace

INestedAggregation

INestedProperty

A specialised version of the IObjectProperty datatype that allows arrays of objects to be indexed in a way that they can be queried independently of each other, using nested queries and aggregations.

INestedQuery

INestedSort

Sort on a field inside one or more nested objects.

INetworkCommunityIdProcessor

INetworkDirectionProcessor

INeuralQuery

A neural query.

INeuralQueryEnricherRequestProcessor

INodeStatsDetails

INodesHotThreadsRequest

INodesInfoRequest

INodesStatsRequest

INodesUsageRequest

INoriAnalyzer

The nori analyzer consists of the following tokenizer and token filters:

- nori_tokenizer

- nori_part_of_speech token filter

- nori_readingform token filter

- nori_number token filter

- lowercase token filter

INoriPartOfSpeechTokenFilter

The nori_part_of_speech token filter removes tokens that match a set of part-of-speech tags.

INoriTokenizer

Tokenizer that ships with the analysis-nori plugin

INormalizationPhaseResultsProcessor

INormalizer

INormalizers

INumberProperty

A numeric mapping that defaults to float.

INumericFielddata

INumericRangeQuery

IObjectProperty

A mapping for an inner object

IOpenIndexRequest

IOpenSearchClient

OpenSearch high level client

IOutput

IOversampleRequestProcessor

IOwner

IPainlessContextSetup

Sets up contextual scope for the painless script the execute under.

IParameters

IParentAggregation

A special single bucket aggregation that selects parent documents that have the specified type, as defined in a join field.

IParentIdQuery

The parent_id query can be used to find child documents which belong to a particular parent.

IPathHierarchyTokenizer

The path_hierarchy tokenizer takes something like this:

/something/something/else

And produces tokens:

/something

/something/something

/something/something/else

IPatternAnalyzer

An analyzer of type pattern that can flexibly separate text into terms via a regular expression.

IPatternCaptureTokenFilter

The pattern_capture token filter, unlike the pattern tokenizer, emits a token for every capture group in the regular expression.

IPatternReplaceCharFilter

The pattern_replace char filter allows the use of a regex to manipulate the characters in a string before analysis.

IPatternReplaceTokenFilter

The pattern_replace token filter allows to easily handle string replacements based on a regular expression.

IPatternTokenizer

A tokenizer of type pattern that can flexibly separate text into terms via a regular expression.

IPerFieldAnalyzer

IPercentageScoreHeuristic

IPercentileRanksAggregation

IPercentilesAggregation

IPercentilesBucketAggregation

IPercentilesMethod

IPercolateQuery

The percolate query can be used to match queries stored in an index

IPercolatorProperty

The percolator datatype is used to store a query, so that the IPercolateQuery can use it to match provided documents.

IPersonalizeSearchRankingResponseProcessor

IPhaseResultsProcessor

Base interface for all PhaseResultsProcessor variants.

IPhoneticTokenFilter

A token filter that converts tokens to their phonetic representation using Soundex, Metaphone, and a variety of other algorithms.

IPhraseSuggestCollate

Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index.

IPhraseSuggestCollateQuery

A query to run for a phrase suggester collate

IPhraseSuggestHighlight

Highlighting for IPhraseSuggester

IPhraseSuggester

IPingRequest

IPipeline

IPipelineAggregation

IPipelineProcessor

Executes another pipeline.

IPointGeoShape

IPointInTime

IPolygonGeoShape

IPorterStemTokenFilter

A token filter of type porterStem that transforms the token stream as per the Porter stemming algorithm.

IPostQuerySetsRequest

IPostScheduledExperimentsRequest

IPostVotingConfigExclusionsRequest

IPredicateTokenFilter

The predicate_token_filter token filter takes a predicate script, and removes tokens that do not match the predicate.

IPredictModelOutput

IPredictModelRequest

IPredictModelResult

IPredictRequest

IPredictRequestStats

IPredictionResult

IPrefixQuery

IProcessor

Ingest pipelines are composed of one or more processors

IProfileRequest

IPromise<TValue>

IProperties

IPropertiesDescriptor<T, TReturnType>

IProperty

A mapping for a property type to a document field in OpenSearch

IPropertyMapping

Determines how a POCO property maps to the property on a JSON object when serialized

IPropertyMappingProvider

Provides mappings for CLR types

IPropertyVisitor

IPropertyWithClrOrigin

A mapping for a property from a CLR type

IProxyRequest

A request that that does not necessarily (de)serializes itself

IPutAliasRequest

A request to put an alias to one or more indices

IPutComponentTemplateRequest

IPutComposableIndexTemplateRequest

IPutExperimentsRequest

IPutHybridOptimizerExperimentRequest

IPutImportJudgmentsRequest

IPutIndexTemplateRequest

IPutJudgmentsRequest

IPutLLMJudgmentsRequest

IPutMappingRequest

IPutMappingRequest<TDocument>

IPutPairwiseExperimentRequest

IPutPipelineRequest

IPutPointwiseExperimentRequest

IPutQuerySetsRequest

IPutScriptRequest

IPutSearchConfigurationRequest

IPutSearchConfigurationsRequest

IPutSearchPipelineRequest

IPutUBIJudgmentsRequest

IQueriesCacheSettings

IQueriesSettings

IQuery

IQueryContainer

IQuerySetsSearchRequest

IQueryStringQuery

A query that uses a query parser in order to parse its content

IQueryVisitor

IRandomScoreFunction

IRangeAggregation

IRangeProperty

IRangeQuery

IRankFeatureFunction

A function to boost scores in a rank_feature query, using the values of rank features.

IRankFeatureLinearFunction

Gives a score equal to the indexed value of S, where S is the value of the rank feature field.

If a rank feature field is indexed with "positive_score_impact": true, its indexed value is equal to S and rounded to preserve only 9 significant bits for the precision.

If a rank feature field is indexed with "positive_score_impact": false, its indexed value is equal to 1/S and rounded to preserve only 9 significant bits for the precision.

IRankFeatureLogarithmFunction

IRankFeatureProperty

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

IRankFeatureQuery

A query that only works on rank_feature fields and rank_features fields. Its goal is to boost the score of documents based on the values of numeric features. It is typically put in a should clause of a bool query so that its score is added to the score of the query.

Compared to using function_score or other ways to modify the score, this query has the benefit of being able to efficiently skip non-competitive hits when track_total_hits is not set to true. Speedups may be spectacular.

IRankFeatureSaturationFunction

IRankFeatureSigmoidFunction

IRankFeaturesProperty

IRareTermsAggregation

IRateLimiter

IRawQuery

IReadOnlyUrlRepository

IReadOnlyUrlRepositorySettings

Snapshot repository settings for IReadOnlyUrlRepository

IRefreshRequest

IRegexpQuery

Queries documents that contain terms matching a regular expression.

IRegisterAgentsRequest

IRegisterModelGroupRequest

IRegisterModelMetaRequest

IRegisterModelRequest

IReindexDestination

Configures the destination for a reindex API request

IReindexOnServerRequest

A request to Reindex API

IReindexRequest<TSource>

A reindex implementation that uses ScrollAll() BulkAll() to compose a reindex pipeline.

This differs from ReindexOnServer() in that documents are fetched from OpenSearch, transformed on the client side, then sent back to OpenSearch.

This will create the target index if it doesn't exist already. If CreateIndexRequest is not specified and the source of the reindex points to a single index we try and reuse the settings from source. You can completely opt out of all of this using OmitIndexCreation

IReindexRequest<TSource, TTarget>

A reindex implementation that uses ScrollAll() BulkAll() to compose a reindex pipeline.

This differs from ReindexOnServer() in that documents are fetched from OpenSearch, transformed on the client side, then sent back to OpenSearch.

IReindexRethrottleRequest

IReindexSource

Configures the source for a reindex API request

IRelations

IReloadSecureSettingsRequest

IRemoteInfoRequest

IRemoteSource

IRemoveDuplicatesTokenFilter

A token filter that drops identical tokens at the same position

IRemoveProcessor

Removes existing fields. If one field doesn't exist, an exception will be thrown.

IRenameFieldResponseProcessor

IRenameProcessor

Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.

IRenderSearchTemplateRequest

IRepositorySettings

Snapshot repository settings

IRepositoryWithSettings

A snapshot repository with settings

IRepository<TSettings>

A snapshot repository with typed settings

IRequest

IRequestProcessor

Base interface for all RequestProcessor variants.

IRequest<TParameters>

IRerankResponseProcessor

IRescore

IRescoreQuery

IResolveIndexRequest

A request to the resolve index API

IResponse

A response from OpenSearch

IResponseProcessor

Base interface for all ResponseProcessor variants.

IRestoreRequest

Restores a snapshot

IRetrievalAugmentedGenerationResponseProcessor

IReverseNestedAggregation

IReverseTokenFilter

A token filter of type reverse that simply reverses the tokens.

IRolloverConditions

Conditions that must be satisfied for a new index to be created with the rollover index API

IRolloverIndexRequest

IRootNodeInfoRequest

IRoutingField

IRows

IRuntimeField

IRuntimeFields

IS3Repository

A snapshot repository that stores snapshots in an Amazon S3 bucket

Requires the repository-s3 plugin to be installed on the cluster

IS3RepositorySettings

Snapshot repository settings for IS3Repository

ISamplerAggregation

IScoreCombination

IScoreCombinationParameters

IScoreFunction

IScoreNormalization

IScoreRankerCombination

IScoreRankerPhaseResultsProcessor

IScript

A script to execute to provide custom computation

IScriptField

IScriptFields

IScriptProcessor

Allows inline and stored scripts to be executed within ingest pipelines.

IScriptQuery

A query allowing to define a script to execute as a query

IScriptScoreFunction

The script score function allows you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.

IScriptScoreQuery

IScriptSort

IScriptedHeuristic

IScriptedMetricAggregation

IScriptedSimilarity

A similarity that allows a script to be used in order to specify how scores should be computed.

IScrollAllRequest

IScrollAllResponse<T>

A response returned for each scroll in ScrollAll()

IScrollRequest

ISearchAgenticMemoryRequest

ISearchAgentsRequest

ISearchAsYouTypeProperty

A text-like field that is optimized to provide out-of-the-box support for the "search as you type" completion use case.

ISearchConfigurationsSearchRequest

ISearchConnectorsRequest

ISearchHits

ISearchHitsHit

ISearchMemoryContainerRequest

ISearchMemoryRequest

ISearchMessageRequest

ISearchModelGroupRequest

ISearchModelGroupsResponse

ISearchModelsRequest

ISearchPipeline

ISearchPipelineMLOpenSearchReranker

ISearchPipelineRerankContext

ISearchRelevanceSearchRequest

ISearchRequest

ISearchRequest<TInferDocument>

ISearchResponse

ISearchResponse<TDocument>

A response to a search request

ISearchScriptRequestProcessor

ISearchShardsRequest

ISearchShardsRequest<TDocument>

ISearchTasksRequest

ISearchTemplateRequest

ISelector

ISerialDifferencingAggregation

ISetProcessor

Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one.

IShapeQuery

IShardAllocationSettings

IShardBalancingHeuristicsSettings

IShardRebalancingSettings

IShingleTokenFilter

A token filter of type shingle that constructs shingles (token n-grams) from a token stream.

In other words, it creates combinations of tokens as a single token.

IShrinkIndexRequest

ISignificantTermsAggregation

ISignificantTextAggregation

An aggregation that returns interesting or unusual occurrences of free-text terms in a set.

ISimilarities

ISimilarity

A similarity.

ISimpleAnalyzer

An analyzer of type simple that is built using a Lower Case Tokenizer.

ISimpleModel

ISimpleQueryStringQuery

ISimulatePipelineDocument

ISimulatePipelineRequest

ISizeField

ISlicedScroll

ISlowLog

ISlowLogIndexing

ISlowLogSearch

ISlowLogSearchFetch

ISlowLogSearchQuery

ISmoothingModel

ISmoothingModelContainer

ISnapshotRepository

A snapshot repository

ISnapshotRequest

ISnapshotStatusRequest

ISnowballAnalyzer

An analyzer of type snowball that uses the standard tokenizer, with standard filter, lowercase filter, stop filter, and snowball filter.

The Snowball Analyzer is a stemming analyzer from Lucene that is originally based on the snowball project from snowball.tartarus.org.

ISnowballTokenFilter

A filter that stems words using a Snowball-generated stemmer.

ISoftDeleteRetentionSettings

ISoftDeleteSettings

ISort

ISortOrder

ISortProcessor

ISortResponseProcessor

ISortingSettings

ISource

ISourceExistsRequest

ISourceExistsRequest<TDocument>

ISourceField

ISourceFilter

ISourceOnlyRepository

ISourceRequest

ISourceRequest<TDocument>

ISourceResponse<TDocument>

ISpanContainingQuery

ISpanFieldMaskingQuery

ISpanFirstQuery

ISpanGapQuery

ISpanMultiTermQuery

ISpanNearQuery

ISpanNotQuery

ISpanOrQuery

ISpanQuery

ISpanSubQuery

ISpanTermQuery

ISpanWithinQuery

ISplitIndexRequest

A request to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index.

ISplitProcessor

Splits a field into an array using a separator character. Only works on string fields

ISplitResponseProcessor

IStandardAnalyzer

An analyzer of type standard that is built of using Standard Tokenizer, with Standard Token Filter, Lower Case Token Filter, and Stop Token Filter.

IStandardTokenizer

A tokenizer of type standard providing grammar based tokenizer that is a good tokenizer for most European language documents.

The tokenizer implements the Unicode Text Segmentation algorithm, as specified in Unicode Standard Annex #29.

IStatsAggregation

IStatsBucketAggregation

IStemmerOverrideTokenFilter

Overrides stemming algorithms, by applying a custom mapping, then protecting these terms from being modified by stemmers. Must be placed before any stemming filters.

IStemmerTokenFilter

A filter that stems words (similar to snowball, but with more options).

IStopAnalyzer

An analyzer of type stop that is built using a Lower Case Tokenizer, with Stop Token Filter.

IStopTokenFilter

A token filter of type stop that removes stop words from token streams.

IStoredScript

A Stored script

IStrategy

IStrategyConfiguration

IStringFielddata

IStupidBackoffSmoothingModel

ISuggestBucket

ISuggestContainer

ISuggestContext

ISuggestContextQuery

ISuggestDictionary<T>

ISuggestFuzziness

Fuzziness options for a suggester

ISuggestOption<TDocument>

Suggest option

ISuggest<T>

ISuggester

A suggester that suggests similar looking terms based on a provided text

ISumAggregation

ISumBucketAggregation

ISynonymGraphTokenFilter

The synonym_graph token filter allows to easily handle synonyms, including multi-word synonyms correctly during the analysis process.

ISynonymTokenFilter

The synonym token filter allows to easily handle synonyms during the analysis process.

ITDigestMethod

ITemplate

ITemplateMapping

ITerm

ITermQuery

ITermRangeQuery

ITermSuggester

ITermVectorFilter

Filter terms returned based on their TF-IDF scores. This can be useful in order find out a good characteristic vector of a document.

ITermVectors

ITermVectorsRequest<TDocument>

ITermsAggregation

ITermsCompositeAggregationSource

A values source that is equivalent to a simple terms aggregation. The values are extracted from a field or a script exactly like the terms aggregation.

ITermsQuery

ITermsSetQuery

ITextEmbeddingProcessor

The text_embedding processor is used to generate vector embeddings from text fields for semantic search.

ITextIndexPrefixes

ITextProperty

Text fields are not used for sorting and seldom used for aggregations

ITimestampField

ITokenCountProperty

A field of type token_count is really an integer field which accepts string values, analyzes them, then indexes the number of tokens in the string.

ITokenFilter

ITokenFilters

ITokenizer

ITokenizers

ITool

IToolAttributes

IToolItems

ITopHitsAggregation

ITrainParameters

ITrainPredictRequest

ITrainRequest

ITranslogFlushSettings

ITranslogSettings

ITrimProcessor

Trims whitespace from field. This only works on leading and trailing whitespace

ITrimTokenFilter

The trim token filter trims surrounding whitespaces around a token.

ITruncateHitsResponseProcessor

ITruncateTokenFilter

The truncate token filter can be used to truncate tokens into a specific length. This can come in handy with keyword (single token)

based mapped fields that are used for sorting in order to reduce memory usage.

ITypeExistsRequest

ITypeMapping

ITypedSearchRequest

Signals the type to deserialize hits into

IUaxEmailUrlTokenizer

A tokenizer of type uax_url_email which works exactly like the standard tokenizer, but tokenizes emails and urls as single tokens

IUndeployModelNode

IUndeployModelNodeStats

IUndeployModelRequest

IUniqueTokenFilter

The unique token filter can be used to only index unique tokens during analysis. By default it is applied on all the token stream

IUnloadModelNode

IUnloadModelNodeStats

IUnloadModelRequest

IUpdateAgenticMemoryRequest

IUpdateByQueryRequest

IUpdateByQueryRequest<TDocument>

IUpdateByQueryRethrottleRequest

IUpdateConnectorRequest

IUpdateControllerRequest

IUpdateIndexSettingsRequest

IUpdateMemoryContainerRequest

IUpdateMemoryRequest

IUpdateMessageRequest

IUpdateModelGroupRequest

IUpdateModelRequest

IUpdateRequest<TDocument, TPartialDocument>

IUpdateResponse<TDocument>

IUploadChunkRequest

IUploadModelRequest

IUppercaseProcessor

Converts a string to its uppercase equivalent.

IUppercaseTokenFilter

A token filter of type uppercase that normalizes token text to upper case.

IUriPartsProcessor

IUrlDecodeProcessor

URL-decodes a string

IUserAgentProcessor

The user_agent processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the user_agent field. The ingest-user-agent plugin ships by default with the regexes.yaml made available by uap-java with an Apache 2.0 license.

IValidateQueryRequest

IValidateQueryRequest<TDocument>

IValueCountAggregation

IValues

IVariableWidthHistogramAggregation

IVerifyRepositoryRequest

IWeightFunction

IWeightedAverageAggregation

IWeightedAverageValue

The configuration for a field or script that provides a value or weight for WeightedAverageAggregation

IWhitespaceAnalyzer

An analyzer of type whitespace that is built using a Whitespace Tokenizer.

IWhitespaceTokenizer

A tokenizer of type whitespace that divides text at whitespace.

IWildcardProperty

A wildcard field stores values optimised for wildcard grep-like queries.

IWildcardQuery

IWordDelimiterGraphTokenFilter

Named word_delimiter, it Splits words into subwords and performs optional transformations on subword groups. Unlike the word_delimiter this token filter named word_delimiter_graph correctly handles multi terms expansion at query time.

IWordDelimiterTokenFilter

Named word_delimiter, it Splits words into subwords and performs optional transformations on subword groups.

Enums

ActionType

AgentType

AggregationVisitorScope

AllocationEnable

AllocationExplainDecision

AllowRebalance

BoundaryScanner

ByteOrder

ChildScoreMode

ClusterStatus

ColumnType

ConnectorProtocol

ConvertProcessorType

DFIIndependenceMeasure

IDFISimilarity independence measure

DFRAfterEffect

DFRBasicModel

DateInterval

DateMathOperation

DateMathTimeUnit

DateRounding

Decision

DelimitedPayloadEncoding

DistanceUnit

DiversifiedSamplerAggregationExecutionHint

DynamicMapping

EdgeNGramSide

FieldType

Define the type of field content.

FieldValueFactorModifier

FielddataLoading

FileSystemStorageImplementation

The store module allows you to control how index data is stored and accessed on disk.

FunctionBoostMode

FunctionName

FunctionScoreMode

GapPolicy

GeoDistanceType

GeoExecution

GeoHashPrecision

GeoOrientation

GeoPointFielddataFormat

GeoShapeRelation

GeoStrategy

GeoTilePrecision

GeoTree

GeoValidationMethod

GuardrailsType

HighlighterEncoder

Indicates if the highlighted text should be HTML encoded

HighlighterFragmenter

Fragmenter can control how text should be broken up in highlight snippets. However, this option is applicable only for the Plain Highlighter

HighlighterOrder

Sorts highlighted fragments

HighlighterTagsSchema

Use a built-in tag schema

HighlighterType

Type of highlighter

HoltWintersType

IBDistribution

IBLambda

IcuCollationAlternate

Sets the alternate handling for strength quaternary to be either shifted or non-ignorable. Which boils down to ignoring punctuation and whitespace.

IcuCollationCaseFirst

Controls which case is sorted first when case is not ignored for strength tertiary. The default depends on the collation.

IcuCollationDecomposition

Setting this decomposition property to canonical allows the Collator to handle unnormalized text properly, producing the same results as if the text were normalized. If no is set, it is the user’s responsibility to insure that all text is already in the appropriate form before a comparison or before getting a CollationKey. Adjusting decomposition mode allows the user to select between faster and more complete collation behavior. Since a great many of the world’s languages do not require text normalization, most locales set no as the default decomposition mode.

Delegates

ConnectionSettings.SourceSerializerFactory

A delegate used to construct a serializer to serialize CLR types representing documents and other types related to documents. By default, the internal serializer will be used to serializer all types.