Search Results for

    Show / Hide Table of Contents

    Class LowLevelSearchRelevanceNamespace

    Search Relevance APIs.

    Not intended to be instantiated directly. Use the SearchRelevance property on IOpenSearchLowLevelClient.

    Inheritance
    object
    NamespacedClientProxy
    LowLevelSearchRelevanceNamespace
    Inherited Members
    NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)
    NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)
    NamespacedClientProxy.Url(FormattableString)
    NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)
    NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)
    NamespacedClientProxy.ContentType
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net.Specification.SearchRelevanceApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class LowLevelSearchRelevanceNamespace : NamespacedClientProxy

    Methods

    | Edit this page View Source

    DeleteExperimentsAsync<TResponse>(string, DeleteExperimentsRequestParameters, CancellationToken)

    DELETE on /_plugins/_search_relevance/experiments/{experiment_id}

    Declaration
    public Task<TResponse> DeleteExperimentsAsync<TResponse>(string experimentId, DeleteExperimentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string experimentId

    The experiment id.

    DeleteExperimentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    DeleteExperiments<TResponse>(string, DeleteExperimentsRequestParameters)

    DELETE on /_plugins/_search_relevance/experiments/{experiment_id}

    Declaration
    public TResponse DeleteExperiments<TResponse>(string experimentId, DeleteExperimentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string experimentId

    The experiment id.

    DeleteExperimentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    DeleteJudgmentsAsync<TResponse>(string, DeleteJudgmentsRequestParameters, CancellationToken)

    DELETE on /_plugins/_search_relevance/judgments/{judgment_id}

    Declaration
    public Task<TResponse> DeleteJudgmentsAsync<TResponse>(string judgmentId, DeleteJudgmentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string judgmentId

    The judgment id.

    DeleteJudgmentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    DeleteJudgments<TResponse>(string, DeleteJudgmentsRequestParameters)

    DELETE on /_plugins/_search_relevance/judgments/{judgment_id}

    Declaration
    public TResponse DeleteJudgments<TResponse>(string judgmentId, DeleteJudgmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string judgmentId

    The judgment id.

    DeleteJudgmentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    DeleteQuerySetsAsync<TResponse>(string, DeleteQuerySetsRequestParameters, CancellationToken)

    DELETE on /_plugins/_search_relevance/query_sets/{query_set_id}

    Declaration
    public Task<TResponse> DeleteQuerySetsAsync<TResponse>(string querySetId, DeleteQuerySetsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string querySetId

    The query set id.

    DeleteQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    DeleteQuerySets<TResponse>(string, DeleteQuerySetsRequestParameters)

    DELETE on /_plugins/_search_relevance/query_sets/{query_set_id}

    Declaration
    public TResponse DeleteQuerySets<TResponse>(string querySetId, DeleteQuerySetsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string querySetId

    The query set id.

    DeleteQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    DeleteSearchConfigurationsAsync<TResponse>(string, DeleteSearchConfigurationsRequestParameters, CancellationToken)

    DELETE on /_plugins/_search_relevance/search_configurations/{search_configuration_id}

    Declaration
    public Task<TResponse> DeleteSearchConfigurationsAsync<TResponse>(string searchConfigurationId, DeleteSearchConfigurationsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string searchConfigurationId

    The search configuration id.

    DeleteSearchConfigurationsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    DeleteSearchConfigurations<TResponse>(string, DeleteSearchConfigurationsRequestParameters)

    DELETE on /_plugins/_search_relevance/search_configurations/{search_configuration_id}

    Declaration
    public TResponse DeleteSearchConfigurations<TResponse>(string searchConfigurationId, DeleteSearchConfigurationsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string searchConfigurationId

    The search configuration id.

    DeleteSearchConfigurationsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetExperimentsAsync<TResponse>(GetExperimentsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/experiments

    Declaration
    public Task<TResponse> GetExperimentsAsync<TResponse>(GetExperimentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetExperimentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetExperimentsAsync<TResponse>(string, GetExperimentsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/experiments/{experiment_id}

    Declaration
    public Task<TResponse> GetExperimentsAsync<TResponse>(string experimentId, GetExperimentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string experimentId

    The experiment id.

    GetExperimentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetExperiments<TResponse>(GetExperimentsRequestParameters)

    GET on /_plugins/_search_relevance/experiments

    Declaration
    public TResponse GetExperiments<TResponse>(GetExperimentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetExperimentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetExperiments<TResponse>(string, GetExperimentsRequestParameters)

    GET on /_plugins/_search_relevance/experiments/{experiment_id}

    Declaration
    public TResponse GetExperiments<TResponse>(string experimentId, GetExperimentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string experimentId

    The experiment id.

    GetExperimentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetJudgmentsAsync<TResponse>(GetJudgmentsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/judgments

    Declaration
    public Task<TResponse> GetJudgmentsAsync<TResponse>(GetJudgmentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetJudgmentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetJudgmentsAsync<TResponse>(string, GetJudgmentsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/judgments/{judgment_id}

    Declaration
    public Task<TResponse> GetJudgmentsAsync<TResponse>(string judgmentId, GetJudgmentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string judgmentId

    The judgment id.

    GetJudgmentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetJudgments<TResponse>(GetJudgmentsRequestParameters)

    GET on /_plugins/_search_relevance/judgments

    Declaration
    public TResponse GetJudgments<TResponse>(GetJudgmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetJudgmentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetJudgments<TResponse>(string, GetJudgmentsRequestParameters)

    GET on /_plugins/_search_relevance/judgments/{judgment_id}

    Declaration
    public TResponse GetJudgments<TResponse>(string judgmentId, GetJudgmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string judgmentId

    The judgment id.

    GetJudgmentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetNodeStatsAsync<TResponse>(string, GetNodeStatsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/{node_id}/stats

    Declaration
    public Task<TResponse> GetNodeStatsAsync<TResponse>(string nodeId, GetNodeStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    The node id.

    GetNodeStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetNodeStatsAsync<TResponse>(string, string, GetNodeStatsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/{node_id}/stats/{stat}

    Declaration
    public Task<TResponse> GetNodeStatsAsync<TResponse>(string nodeId, string stat, GetNodeStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    The node id.

    string stat

    The statistic to return.

    GetNodeStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetNodeStats<TResponse>(string, GetNodeStatsRequestParameters)

    GET on /_plugins/_search_relevance/{node_id}/stats

    Declaration
    public TResponse GetNodeStats<TResponse>(string nodeId, GetNodeStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    The node id.

    GetNodeStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetNodeStats<TResponse>(string, string, GetNodeStatsRequestParameters)

    GET on /_plugins/_search_relevance/{node_id}/stats/{stat}

    Declaration
    public TResponse GetNodeStats<TResponse>(string nodeId, string stat, GetNodeStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    The node id.

    string stat

    The statistic to return.

    GetNodeStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetQuerySetsAsync<TResponse>(GetQuerySetsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/query_sets

    Declaration
    public Task<TResponse> GetQuerySetsAsync<TResponse>(GetQuerySetsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetQuerySetsAsync<TResponse>(string, GetQuerySetsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/query_sets/{query_set_id}

    Declaration
    public Task<TResponse> GetQuerySetsAsync<TResponse>(string querySetId, GetQuerySetsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string querySetId

    The query set id.

    GetQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetQuerySets<TResponse>(GetQuerySetsRequestParameters)

    GET on /_plugins/_search_relevance/query_sets

    Declaration
    public TResponse GetQuerySets<TResponse>(GetQuerySetsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetQuerySets<TResponse>(string, GetQuerySetsRequestParameters)

    GET on /_plugins/_search_relevance/query_sets/{query_set_id}

    Declaration
    public TResponse GetQuerySets<TResponse>(string querySetId, GetQuerySetsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string querySetId

    The query set id.

    GetQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetSearchConfigurationsAsync<TResponse>(GetSearchConfigurationsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/search_configurations

    Declaration
    public Task<TResponse> GetSearchConfigurationsAsync<TResponse>(GetSearchConfigurationsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetSearchConfigurationsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetSearchConfigurationsAsync<TResponse>(string, GetSearchConfigurationsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/search_configurations/{search_configuration_id}

    Declaration
    public Task<TResponse> GetSearchConfigurationsAsync<TResponse>(string searchConfigurationId, GetSearchConfigurationsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string searchConfigurationId

    The search configuration id.

    GetSearchConfigurationsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetSearchConfigurations<TResponse>(GetSearchConfigurationsRequestParameters)

    GET on /_plugins/_search_relevance/search_configurations

    Declaration
    public TResponse GetSearchConfigurations<TResponse>(GetSearchConfigurationsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetSearchConfigurationsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetSearchConfigurations<TResponse>(string, GetSearchConfigurationsRequestParameters)

    GET on /_plugins/_search_relevance/search_configurations/{search_configuration_id}

    Declaration
    public TResponse GetSearchConfigurations<TResponse>(string searchConfigurationId, GetSearchConfigurationsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string searchConfigurationId

    The search configuration id.

    GetSearchConfigurationsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetStatsAsync<TResponse>(GetStatsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/stats

    Declaration
    public Task<TResponse> GetStatsAsync<TResponse>(GetStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetStatsAsync<TResponse>(string, GetStatsRequestParameters, CancellationToken)

    GET on /_plugins/_search_relevance/stats/{stat}

    Declaration
    public Task<TResponse> GetStatsAsync<TResponse>(string stat, GetStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string stat

    The statistic to return.

    GetStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetStats<TResponse>(GetStatsRequestParameters)

    GET on /_plugins/_search_relevance/stats

    Declaration
    public TResponse GetStats<TResponse>(GetStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    GetStats<TResponse>(string, GetStatsRequestParameters)

    GET on /_plugins/_search_relevance/stats/{stat}

    Declaration
    public TResponse GetStats<TResponse>(string stat, GetStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string stat

    The statistic to return.

    GetStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PostQuerySetsAsync<TResponse>(PostData, PostQuerySetsRequestParameters, CancellationToken)

    POST on /_plugins/_search_relevance/query_sets

    Declaration
    public Task<TResponse> PostQuerySetsAsync<TResponse>(PostData body, PostQuerySetsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PostQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PostQuerySets<TResponse>(PostData, PostQuerySetsRequestParameters)

    POST on /_plugins/_search_relevance/query_sets

    Declaration
    public TResponse PostQuerySets<TResponse>(PostData body, PostQuerySetsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PostQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PutExperimentsAsync<TResponse>(PostData, PutExperimentsRequestParameters, CancellationToken)

    PUT on /_plugins/_search_relevance/experiments

    Declaration
    public Task<TResponse> PutExperimentsAsync<TResponse>(PostData body, PutExperimentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PutExperimentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PutExperiments<TResponse>(PostData, PutExperimentsRequestParameters)

    PUT on /_plugins/_search_relevance/experiments

    Declaration
    public TResponse PutExperiments<TResponse>(PostData body, PutExperimentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PutExperimentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PutJudgmentsAsync<TResponse>(PostData, PutJudgmentsRequestParameters, CancellationToken)

    PUT on /_plugins/_search_relevance/judgments

    Declaration
    public Task<TResponse> PutJudgmentsAsync<TResponse>(PostData body, PutJudgmentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PutJudgmentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PutJudgments<TResponse>(PostData, PutJudgmentsRequestParameters)

    PUT on /_plugins/_search_relevance/judgments

    Declaration
    public TResponse PutJudgments<TResponse>(PostData body, PutJudgmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PutJudgmentsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PutQuerySetsAsync<TResponse>(PostData, PutQuerySetsRequestParameters, CancellationToken)

    PUT on /_plugins/_search_relevance/query_sets

    Declaration
    public Task<TResponse> PutQuerySetsAsync<TResponse>(PostData body, PutQuerySetsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PutQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PutQuerySets<TResponse>(PostData, PutQuerySetsRequestParameters)

    PUT on /_plugins/_search_relevance/query_sets

    Declaration
    public TResponse PutQuerySets<TResponse>(PostData body, PutQuerySetsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PutQuerySetsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PutSearchConfigurationsAsync<TResponse>(PostData, PutSearchConfigurationsRequestParameters, CancellationToken)

    PUT on /_plugins/_search_relevance/search_configurations

    Declaration
    public Task<TResponse> PutSearchConfigurationsAsync<TResponse>(PostData body, PutSearchConfigurationsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PutSearchConfigurationsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    PutSearchConfigurations<TResponse>(PostData, PutSearchConfigurationsRequestParameters)

    PUT on /_plugins/_search_relevance/search_configurations

    Declaration
    public TResponse PutSearchConfigurations<TResponse>(PostData body, PutSearchConfigurationsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    PutSearchConfigurationsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • DeleteExperimentsAsync<TResponse>(string, DeleteExperimentsRequestParameters, CancellationToken)
      • DeleteExperiments<TResponse>(string, DeleteExperimentsRequestParameters)
      • DeleteJudgmentsAsync<TResponse>(string, DeleteJudgmentsRequestParameters, CancellationToken)
      • DeleteJudgments<TResponse>(string, DeleteJudgmentsRequestParameters)
      • DeleteQuerySetsAsync<TResponse>(string, DeleteQuerySetsRequestParameters, CancellationToken)
      • DeleteQuerySets<TResponse>(string, DeleteQuerySetsRequestParameters)
      • DeleteSearchConfigurationsAsync<TResponse>(string, DeleteSearchConfigurationsRequestParameters, CancellationToken)
      • DeleteSearchConfigurations<TResponse>(string, DeleteSearchConfigurationsRequestParameters)
      • GetExperimentsAsync<TResponse>(GetExperimentsRequestParameters, CancellationToken)
      • GetExperimentsAsync<TResponse>(string, GetExperimentsRequestParameters, CancellationToken)
      • GetExperiments<TResponse>(GetExperimentsRequestParameters)
      • GetExperiments<TResponse>(string, GetExperimentsRequestParameters)
      • GetJudgmentsAsync<TResponse>(GetJudgmentsRequestParameters, CancellationToken)
      • GetJudgmentsAsync<TResponse>(string, GetJudgmentsRequestParameters, CancellationToken)
      • GetJudgments<TResponse>(GetJudgmentsRequestParameters)
      • GetJudgments<TResponse>(string, GetJudgmentsRequestParameters)
      • GetNodeStatsAsync<TResponse>(string, GetNodeStatsRequestParameters, CancellationToken)
      • GetNodeStatsAsync<TResponse>(string, string, GetNodeStatsRequestParameters, CancellationToken)
      • GetNodeStats<TResponse>(string, GetNodeStatsRequestParameters)
      • GetNodeStats<TResponse>(string, string, GetNodeStatsRequestParameters)
      • GetQuerySetsAsync<TResponse>(GetQuerySetsRequestParameters, CancellationToken)
      • GetQuerySetsAsync<TResponse>(string, GetQuerySetsRequestParameters, CancellationToken)
      • GetQuerySets<TResponse>(GetQuerySetsRequestParameters)
      • GetQuerySets<TResponse>(string, GetQuerySetsRequestParameters)
      • GetSearchConfigurationsAsync<TResponse>(GetSearchConfigurationsRequestParameters, CancellationToken)
      • GetSearchConfigurationsAsync<TResponse>(string, GetSearchConfigurationsRequestParameters, CancellationToken)
      • GetSearchConfigurations<TResponse>(GetSearchConfigurationsRequestParameters)
      • GetSearchConfigurations<TResponse>(string, GetSearchConfigurationsRequestParameters)
      • GetStatsAsync<TResponse>(GetStatsRequestParameters, CancellationToken)
      • GetStatsAsync<TResponse>(string, GetStatsRequestParameters, CancellationToken)
      • GetStats<TResponse>(GetStatsRequestParameters)
      • GetStats<TResponse>(string, GetStatsRequestParameters)
      • PostQuerySetsAsync<TResponse>(PostData, PostQuerySetsRequestParameters, CancellationToken)
      • PostQuerySets<TResponse>(PostData, PostQuerySetsRequestParameters)
      • PutExperimentsAsync<TResponse>(PostData, PutExperimentsRequestParameters, CancellationToken)
      • PutExperiments<TResponse>(PostData, PutExperimentsRequestParameters)
      • PutJudgmentsAsync<TResponse>(PostData, PutJudgmentsRequestParameters, CancellationToken)
      • PutJudgments<TResponse>(PostData, PutJudgmentsRequestParameters)
      • PutQuerySetsAsync<TResponse>(PostData, PutQuerySetsRequestParameters, CancellationToken)
      • PutQuerySets<TResponse>(PostData, PutQuerySetsRequestParameters)
      • PutSearchConfigurationsAsync<TResponse>(PostData, PutSearchConfigurationsRequestParameters, CancellationToken)
      • PutSearchConfigurations<TResponse>(PostData, PutSearchConfigurationsRequestParameters)
    • Extension Methods
    Back to top Generated by DocFX