Ranking Class

  • Article

Provides an entry point to adjust the settings used for query-independent rank computation for calculating the relevance of Enterprise Search results.

Inheritance Hierarchy

System.Object
  Microsoft.Office.Server.Search.Administration.Ranking

Namespace:  Microsoft.Office.Server.Search.Administration
Assembly:  Microsoft.Office.Server.Search (in Microsoft.Office.Server.Search.dll)

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public NotInheritable Class Ranking

'Usage
Dim instance As Ranking

[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public sealed class Ranking

Remarks

Use the Ranking constructor of the Ranking class to initialize an object that provides an entry point to the Relevance object model.

For more information about search relevance, see Enterprise Search Relevance Architecture Overview.

Examples

The following code example writes out the ranking parameter names and built-in values to the console window.

Prerequisites

Ensure a Shared Services Provider is already created.

Project References

Add the following Project References in your console application code project before running this sample:

  • Microsoft.SharePoint

  • Microsoft.Office.Server

  • Microsoft.Office.Server.Search

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Office.Server.Search.Administration;
using Microsoft.SharePoint;
namespace RankingParameterSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                /*
                Replace <SiteName> with the name of a site 
                using the Shared Services Provider.
                */
                string strURL = "http://<SiteName>";
                SearchContext context;
                using (SPSite site = new SPSite("http://yourSiteName"))
                {
                    context = SearchContext.GetContext(site);
                }
                Ranking sRanking = new Ranking(context);
                RankParamCollection rankParams = sRanking.RankingParameters;

                foreach (RankingParameter rankParam in rankParams)
                {
                    Console.WriteLine("NAME: " + rankParam.Name + "...VALUE: " + rankParam.Value);
                }
            }

            catch (Exception ex)
            {
                Console.WriteLine(ex.ToString());
            }
        }
    }
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Ranking Members

Microsoft.Office.Server.Search.Administration Namespace