---

relevanceRanking

Relevance ranking controls the importance given to various document attributes when ordering the search results. By customizing the ranking rules, you can produce more relevant search results for your enterprise.

In Oracle SES 11.1.2 and earlier releases, these parameters were stored in a file named ranking.xml.

Object Type

Universal

State Properties

None

Supported Operations

export
update

Administration GUI Page

None

XML Description

The <search:relevanceRanking> element describes the relevance ranking of search attributes:

<search:relevanceRanking>
   <search:defaultFactors>
      <search:defaultFactor>
         <search:name>
         <search:weight>
   <search:customFactors>
      <search:customFactor>
         <search:attributeName>
         <search:attributeType>
         <search:factorType>
            <search:queryFactor>
               <search:weight>
            <search:staticFactor>
               <search:matches>
                  <search:match>
                     <search:value>
                     <search:weight>

Element Descriptions 

<search:relevanceRanking>

Contains these elements:

<search:defaultFactors>
<search:customFactors>

<search:defaultFactors>

Sets the weights for the default attributes used for ranking. It contains one or more <search:defaultFactor> elements.

Attribute	Value
enabled	Set to true to enable default factors (default), or set to false otherwise. Required.

<search:defaultFactor>

Identifies a default search attribute and its weight. It contains these elements:

<search:name>
<search:weight>

The following table lists the default attributes and weights:

Attribute	Weight
Title	High
Description	Medium
Reftext	High
Keywords	Medium
Subject	Low
Author	Medium
H1headline	Low
H2headline	Very low
Url	Low
Urldepth	High
Language Match	High
Linkscore	High

<search:name>

Name of the attribute, such as Title or Description.

<search:weight>

Contains the weight assigned to an attribute: very high, high, medium, low, very low, and none. If the weight is not specified, the default weight for the attribute is used.

<search:customFactors>

Adds other attributes for ranking. It contains one or more <search:customFactor> elements.

<search:customFactor>

Describes an attribute used for ranking. Any indexed search attribute can be a custom ranking attribute. This element contains these child elements:

<search:attributeName>
<search:attributeType>
<search:factorType>

<search:attributeName>

The exact name of a search attribute defined in Oracle SES. This name is case-insensitive.

<search:attributeType>

The data type of the attribute. Only String is supported.

<search:factorType>

Identifies the type of ranking. It contains one of these elements:

<search:queryFactor>
<search:staticFactor>

<search:queryFactor>

Matches the attribute value against query terms. For example, if a custom attribute has the value "Terry Francona," then a query for "Terry Francona" is given the relevancy ranking of the attribute.

This element contains a <search:weight> element.

<search:staticFactor>

Matches the attribute value against an attribute of the documents. For example, assume a company identifies its documents as good or poor and defines a custom search attribute for quality. If a custom attribute for quality ranks good documents very high and poor documents low, then a good document appears higher than a poor document in the list of search results.

This element contains a <search:matches> element.

<search:matches>

Contains one or more <search:match> elements.

<search:match>

Identifies a matching search attribute and value. It contains these elements:

<search:value>
<search:weight>

<search:value>

The value of the search attribute specified in <search:name> being given a weight.

Example

This XML document describes relevance ranking:

<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:relevanceRanking>
      <search:defaultFactors enabled="true">
         <search:defaultFactor>
            <search:name>TITLE</search:name>
            <search:weight>MEDIUM</search:weight>
         </search:defaultFactor>
      </search:defaultFactors>
   </search:relevanceRanking>
</search:config>