Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Overview

Represents a list of ExpertiseSearchClause, split into one or more bands, which allow the weighting applied to different types of clauses to be controlled.

Separating clauses into different bands is optional, because it is only useful for controlling the weight of different clauses extracted from a large body of text. Bands are specified using ClauseGenerationSpec.

Typically, clauses generated from text such as keywords or "quoted phrases" submitted in a search can be put into the same band, because they all contribute equally to the search.

However, in the case of a Context Search, the weighting of clauses extracted from a large body of text could result in one type of clause completely dominating the search. Putting clauses into different bands allows you to "even the field" among them by controlling how much each type of SearchClause contributes to the search.

For example, a set of clauses from a 50 page report would have much more effect on a search than clauses generated from 10 one-page resumes. Or that a set of associated keywords could be overpowered by a single heavily weighted Phrase-match clause.

You can specify which clauses should be included in each band, and put a cap on how much these clauses contribute to the search. This gives you tremendous flexibility in specifying how much different types of clauses contribute to the search, regardless of weight.

This can optionally contain positional information indicating from where in the search text each clause was generated.

Refer to expertiseSearchClause for more information

Members

Name Type Required Description

bands

expertiseSearchBand[]

A list of bands, each containing one or more clause within a clause weighting band.

enforcement

int

Set the enforcement for all the clauses. Values are:

ignoredTextStartPos

int

The starting position of the source text that was not used to gather words to search for because it exceeded the maximum length of the expression. Only returned when the requested search type is ExpertiseTextProcessingSearchType.WORDEXPR.

-1 is returned if there is no ignored section.

skippedCommonWords

string[]

The list of words that were not searched for because they are too common. Only returned when the requested search type is ExpertiseTextProcessingSearchType.WORDEXPR.

termPositions

expertiseClauseTermPosition[]

Contains a list of term positions indicating from where in the List of search terms each clause was generated if positional info in ExpertiseTextClauseGenParam type is true.

textPositions

expertiseClauseTextPosition[]

Contains a List of text positions indicating from where in the search text each Clause was generated if positional info is set in the ExpertiseTextClauseGenParam type provided is true.

Hierarchy

Examples

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:expertiseSearchClauseList xsi:type="obh:expertiseSearchClauseList" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:bands>your_expertiseSearchBand_0</obh:bands>
        <obh:bands>your_expertiseSearchBand_1</obh:bands>
        <obh:bands>your_expertiseSearchBand_2</obh:bands>
        <obh:enforcement>your_int_0</obh:enforcement>
        <obh:ignoredTextStartPos>your_int_0</obh:ignoredTextStartPos>
        <obh:skippedCommonWords>your_string_0</obh:skippedCommonWords>
        <obh:skippedCommonWords>your_string_1</obh:skippedCommonWords>
        <obh:skippedCommonWords>your_string_2</obh:skippedCommonWords>
        <obh:termPositions>your_expertiseClauseTermPosition_0</obh:termPositions>
        <obh:termPositions>your_expertiseClauseTermPosition_1</obh:termPositions>
        <obh:termPositions>your_expertiseClauseTermPosition_2</obh:termPositions>
        <obh:textPositions>your_expertiseClauseTextPosition_0</obh:textPositions>
        <obh:textPositions>your_expertiseClauseTextPosition_1</obh:textPositions>
        <obh:textPositions>your_expertiseClauseTextPosition_2</obh:textPositions>
</obh:expertiseSearchClauseList>

JSON Example

(show inherited members)

{
    "beeType":"expertiseSearchClauseList",
        "bands":[
            { your_{http://www.oracle.com/beehive}bands_as_expertiseSearchBand0 },
            { your_{http://www.oracle.com/beehive}bands_as_expertiseSearchBand1 },
            { your_{http://www.oracle.com/beehive}bands_as_expertiseSearchBand2 }
        ],
        "enforcement":your_{http://www.oracle.com/beehive}enforcement_as_int0,
        "ignoredTextStartPos":your_{http://www.oracle.com/beehive}ignoredTextStartPos_as_int0,
        "skippedCommonWords":[
            "your_{http://www.oracle.com/beehive}skippedCommonWords_as_string0",
            "your_{http://www.oracle.com/beehive}skippedCommonWords_as_string1",
            "your_{http://www.oracle.com/beehive}skippedCommonWords_as_string2"
        ],
        "termPositions":[
            { your_{http://www.oracle.com/beehive}termPositions_as_expertiseClauseTermPosition0 },
            { your_{http://www.oracle.com/beehive}termPositions_as_expertiseClauseTermPosition1 },
            { your_{http://www.oracle.com/beehive}termPositions_as_expertiseClauseTermPosition2 }
        ],
        "textPositions":[
            { your_{http://www.oracle.com/beehive}textPositions_as_expertiseClauseTextPosition0 },
            { your_{http://www.oracle.com/beehive}textPositions_as_expertiseClauseTextPosition1 },
            { your_{http://www.oracle.com/beehive}textPositions_as_expertiseClauseTextPosition2 }
        ]
}

XML Schema


<xs:complexType name="expertiseSearchClauseList">
    <xs:sequence>
        <xs:element maxOccurs="unbounded" minOccurs="0" name="bands"
            nillable="true" type="tns:expertiseSearchBand"/>
        <xs:element name="enforcement" type="xs:int"/>
        <xs:element name="ignoredTextStartPos" type="xs:int"/>
        <xs:element maxOccurs="unbounded" minOccurs="0"
            name="skippedCommonWords" nillable="true" type="xs:string"/>
        <xs:element maxOccurs="unbounded" minOccurs="0"
            name="termPositions" nillable="true" type="tns:expertiseClauseTermPosition"/>
        <xs:element maxOccurs="unbounded" minOccurs="0"
            name="textPositions" nillable="true" type="tns:expertiseClauseTextPosition"/>
    </xs:sequence>
</xs:complexType>

        

References

The following data represents the references to expertiseSearchClauseList

Referenced By Resources

Usage Resource Method
Response Expertise Management Get Search Clauses

Referenced By Representaions