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

Contents

Overview

This type provides tremendous control over how topics are generated via a buildTopics request. Changes made to the parameters in this object can affect both the quality of topics generated as well as system performance.

Members

Name Type Required Description

allowUncoveredWords

boolean

Whether or not topics are allowed to contain words that are not represented in their matching terms. If true, allow words even if there are no terms containing that word. Otherwise, only words represented in terms are returned. This parameter is ignored if terms are not requested for topics.

allwordsClauseWeight

double

If terms are to be returned with a dynamic topic, the weight of all keywords used in the search expression created to find matching terms. The default is "1.0".

defaultMinTopNConf

float

The value that if not specified in the TopNClause then what should the default minimum confidence be that is considered when getting the top keywords.

groupingAcceptanceMinimum

double

The minimum separation between a keyword and a sibling word required for the sibling to be considered for inclusion as an associated word.

groupingUniqueAssocWords

boolean

Whether topic groupings will have any repeated associated words. If true, topics do not have any associated words.

keywordClauseWeight

double

If terms are to be returned with a dynamic topic, gets the weight of a single keyword used in the search expression created to find matching terms. The default value is "1.1".

languageProperties

expertiseLanguageProperties[]

ExpertiseLanguageProperties objects supplied with this object.

maxAnyPaths

int

The maximum number of AnyPath calculations to use, per keyword, when building topics. This value will be ignored if set higher than the site-wide setting, which will be used instead. The default value is "250". Note that increasing this value will increase the workload on the Confidence Update role, which calculates the strength of relationships between words in topics. As such, increasing this value may affect system performance.

maxMatchingThreshold

int

The maximum number of keywords to match against when performing database queries to get keywords.

maxNeighborAvgCoh

float

The maximum average separation allowed between any neighboring words for those words to be considered for use in multi-keyword topics.

For example, if a user where to search for "Unix administrator", the words Unix and administrator could be combinded in a multi-work keyword in the topic title, i.e. Unix administrator, if the separation between the words fell below this threshold. Otherwise, one of the words could be included in the topic as an associated word, i.e. Unix (administrator).

The default value is "2.0". The edges radiating from the keyword in the word graph are used for this determination. These must have a minimum occurrence of 2.

maxNeighbors

int

If maxNeighborAvgCoh is non-0.0, the maximum number of words to consider as neighboring words.

maxSiblings

int

The maximum number of sibling words that can be used as associated words with each topic's keyword. The default value is "50". Note: This value will be ignored if set higher than the site-wide setting, which will be used instead. Modifying this value may affect system performance. Note that increasing this value will increase the workload on the Confidence Update role, which calculates the strength of relationships between words in topics. As such, increasing this value may affect system performance.

maxTermsForMatching

int

The maximum number of matching terms to retrieve for inclusion in a topic.

maxWordsPerTopicMatchingClause

int

The number of words (not counting the keywords) to add to a SearchClause that will be used for the topic to term matching

staticClauseWeight

double

If terms are to be returned with a Static Topic, gets the default weight of the clause created to find matching terms. The default is "10.0", giving precedence to this clause in topic results.

ungroupedWordsClauseWeight

double

If terms are to be returned with an aggregate or dynamic topic, the weight of the associated words that could not be grouped into the topic in the search expression created to find matching terms. The default is "0.1".

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:expertiseTopicsBuildProperties xsi:type="obh:expertiseTopicsBuildProperties" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:allowUncoveredWords>your_boolean_0</obh:allowUncoveredWords>
        <obh:allwordsClauseWeight>your_double_0</obh:allwordsClauseWeight>
        <obh:defaultMinTopNConf>your_float_0</obh:defaultMinTopNConf>
        <obh:groupingAcceptanceMinimum>your_double_0</obh:groupingAcceptanceMinimum>
        <obh:groupingUniqueAssocWords>your_boolean_0</obh:groupingUniqueAssocWords>
        <obh:keywordClauseWeight>your_double_0</obh:keywordClauseWeight>
        <obh:languageProperties>your_expertiseLanguageProperties_0</obh:languageProperties>
        <obh:languageProperties>your_expertiseLanguageProperties_1</obh:languageProperties>
        <obh:languageProperties>your_expertiseLanguageProperties_2</obh:languageProperties>
        <obh:maxAnyPaths>your_int_0</obh:maxAnyPaths>
        <obh:maxMatchingThreshold>your_int_0</obh:maxMatchingThreshold>
        <obh:maxNeighborAvgCoh>your_float_0</obh:maxNeighborAvgCoh>
        <obh:maxNeighbors>your_int_0</obh:maxNeighbors>
        <obh:maxSiblings>your_int_0</obh:maxSiblings>
        <obh:maxTermsForMatching>your_int_0</obh:maxTermsForMatching>
        <obh:maxWordsPerTopicMatchingClause>your_int_0</obh:maxWordsPerTopicMatchingClause>
        <obh:staticClauseWeight>your_double_0</obh:staticClauseWeight>
        <obh:ungroupedWordsClauseWeight>your_double_0</obh:ungroupedWordsClauseWeight>
</obh:expertiseTopicsBuildProperties>

JSON Example

(show inherited members)

{
    "beeType":"expertiseTopicsBuildProperties",
        "allowUncoveredWords":your_{http://www.oracle.com/beehive}allowUncoveredWords_as_boolean0,
        "allwordsClauseWeight":your_{http://www.oracle.com/beehive}allwordsClauseWeight_as_double0,
        "defaultMinTopNConf":your_{http://www.oracle.com/beehive}defaultMinTopNConf_as_float0,
        "groupingAcceptanceMinimum":your_{http://www.oracle.com/beehive}groupingAcceptanceMinimum_as_double0,
        "groupingUniqueAssocWords":your_{http://www.oracle.com/beehive}groupingUniqueAssocWords_as_boolean0,
        "keywordClauseWeight":your_{http://www.oracle.com/beehive}keywordClauseWeight_as_double0,
        "languageProperties":[
            { your_{http://www.oracle.com/beehive}languageProperties_as_expertiseLanguageProperties0 },
            { your_{http://www.oracle.com/beehive}languageProperties_as_expertiseLanguageProperties1 },
            { your_{http://www.oracle.com/beehive}languageProperties_as_expertiseLanguageProperties2 }
        ],
        "maxAnyPaths":your_{http://www.oracle.com/beehive}maxAnyPaths_as_int0,
        "maxMatchingThreshold":your_{http://www.oracle.com/beehive}maxMatchingThreshold_as_int0,
        "maxNeighborAvgCoh":your_{http://www.oracle.com/beehive}maxNeighborAvgCoh_as_float0,
        "maxNeighbors":your_{http://www.oracle.com/beehive}maxNeighbors_as_int0,
        "maxSiblings":your_{http://www.oracle.com/beehive}maxSiblings_as_int0,
        "maxTermsForMatching":your_{http://www.oracle.com/beehive}maxTermsForMatching_as_int0,
        "maxWordsPerTopicMatchingClause":your_{http://www.oracle.com/beehive}maxWordsPerTopicMatchingClause_as_int0,
        "staticClauseWeight":your_{http://www.oracle.com/beehive}staticClauseWeight_as_double0,
        "ungroupedWordsClauseWeight":your_{http://www.oracle.com/beehive}ungroupedWordsClauseWeight_as_double0
}

XML Schema


<xs:complexType name="expertiseTopicsBuildProperties">
    <xs:sequence>
        <xs:element minOccurs="0" name="allowUncoveredWords" type="xs:boolean"/>
        <xs:element name="allwordsClauseWeight" type="xs:double"/>
        <xs:element name="defaultMinTopNConf" type="xs:float"/>
        <xs:element name="groupingAcceptanceMinimum" type="xs:double"/>
        <xs:element name="groupingUniqueAssocWords" type="xs:boolean"/>
        <xs:element name="keywordClauseWeight" type="xs:double"/>
        <xs:element maxOccurs="unbounded" minOccurs="0"
            name="languageProperties" nillable="true" type="tns:expertiseLanguageProperties"/>
        <xs:element name="maxAnyPaths" type="xs:int"/>
        <xs:element name="maxMatchingThreshold" type="xs:int"/>
        <xs:element name="maxNeighborAvgCoh" type="xs:float"/>
        <xs:element name="maxNeighbors" type="xs:int"/>
        <xs:element name="maxSiblings" type="xs:int"/>
        <xs:element name="maxTermsForMatching" type="xs:int"/>
        <xs:element name="maxWordsPerTopicMatchingClause" type="xs:int"/>
        <xs:element name="staticClauseWeight" type="xs:double"/>
        <xs:element name="ungroupedWordsClauseWeight" type="xs:double"/>
    </xs:sequence>
</xs:complexType>

        

References

The following data represents the references to expertiseTopicsBuildProperties

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions