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

Contents

Overview

Contains properties that make it possible to generate topics that are ideal for each specific language enabled within a site. This is passed in with a buildTopics request within a ExpertiseTopicsBuildProperties.

This provides tremendous control over how topics are generated, making it possible to fine-tune topic generation for each language. For example, multi-word keywords, while acceptable in English, may not be in German. With this class, you could allow such keywords to be created for English-language topics, but prevent their creation in German.

Refer to ExpertiseSearchControl.buildTopics(ExpertiseTopicClauses, ExpertiseTopicsBuildProperties), and expertiseTopicsBuildProperties for more information.,

Members

Name Type Required Description

defaultMaxTermsPerTopic

int

Default number of terms to get per topic when terms are required and an value has not been specified. note:if 0, then it will be filled in with the site properties setting for this property

groupingMaxAnyPathInclusionRatio

double

Ratio of the number existing grouping words covered by a set of AnyPaths for a candidate word

groupingMaxAssocWords

int

Maximum number of associated or "sibling" words to include before the topic grouping is considered full.

If 0, the value specified in the site properties will be used for this property.

groupingMaxAvgCohForAsPhrase

float

Maximum the avg. cohesiveness can be before the keywords in a multi-keyword topic can no longer be considered a 'phrase' and must be comma-separated. note:if 0.0, then it will be filled in with the site properties setting for this property

groupingMaxAvgRatioForInclusion

double

Ratio of the avg candidate AnyPaths wanting to be be added and the avg of the grouping

groupingMaxEdgeCombineAvgCoh

float

Maximum average separation allowed between words to be considered for use in multi-keyword topics. This parameter is only used for topics generated in response to a search request. The default is "1.5".

groupingMaxKeywordsPerSet

int

Maximum number of keywords that can be included within a topic. For example, keyword keyword (associated word).

groupingMaxPeakRatioForInclusion

double

Ratio of the peak candidate AnyPaths wanting to be be added and the peak of the grouping

groupingMaxWeight

double

Maximum strength a topic can attain.

If 0, the value specified in the site properties will be used for this property.

groupingMinEdgeCombineOcc

int

Minimum number of occurrence the edge must have in order for it to be considered when combining keywords note:if 0, then it will be filled in with the site properties setting for this property

groupingMinEdgeCombineWeight

float

Minimum weight that an edge's weight can be in order for it to be used to combine keywords note:if 0.0, then it will be filled in with the site properties setting for this property

groupingMinUngroupableDiscard

int

Minimum number of ungroupable siblings the topic is allowed to have before being discarded

groupingMinWordsForAcceptance

int

Minimum number of words - keywords and associated words - a topic must have in order for the topic to be considered valid. Topics below this threshold will be dropped. The default value of "0" indicates no minimum threshold.

languageCode

int

bit-masked language(s) this ExpertiseLanguageProperties applies to. Values are:
  • ENGLISH (1)
  • FRENCH (2)
  • GERMAN (4)
  • ALL (32767): All languages enabled for the site.

Note that if "0", the system will use the language value defined for the site properties setting for this property.

minCoveredWordsToDisqualify

int

Minimum words not covered in a topic before the terms being matched to it are disqualified.

precedence

int

Rank of this ExpertiseLanguageProperties versus any others supplied. The default is "0", indicating the lowest possible rank.

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:expertiseLanguageProperties xsi:type="obh:expertiseLanguageProperties" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:defaultMaxTermsPerTopic>your_int_0</obh:defaultMaxTermsPerTopic>
        <obh:groupingMaxAnyPathInclusionRatio>your_double_0</obh:groupingMaxAnyPathInclusionRatio>
        <obh:groupingMaxAssocWords>your_int_0</obh:groupingMaxAssocWords>
        <obh:groupingMaxAvgCohForAsPhrase>your_float_0</obh:groupingMaxAvgCohForAsPhrase>
        <obh:groupingMaxAvgRatioForInclusion>your_double_0</obh:groupingMaxAvgRatioForInclusion>
        <obh:groupingMaxEdgeCombineAvgCoh>your_float_0</obh:groupingMaxEdgeCombineAvgCoh>
        <obh:groupingMaxKeywordsPerSet>your_int_0</obh:groupingMaxKeywordsPerSet>
        <obh:groupingMaxPeakRatioForInclusion>your_double_0</obh:groupingMaxPeakRatioForInclusion>
        <obh:groupingMaxWeight>your_double_0</obh:groupingMaxWeight>
        <obh:groupingMinEdgeCombineOcc>your_int_0</obh:groupingMinEdgeCombineOcc>
        <obh:groupingMinEdgeCombineWeight>your_float_0</obh:groupingMinEdgeCombineWeight>
        <obh:groupingMinUngroupableDiscard>your_int_0</obh:groupingMinUngroupableDiscard>
        <obh:groupingMinWordsForAcceptance>your_int_0</obh:groupingMinWordsForAcceptance>
        <obh:languageCode>your_int_0</obh:languageCode>
        <obh:minCoveredWordsToDisqualify>your_int_0</obh:minCoveredWordsToDisqualify>
        <obh:precedence>your_int_0</obh:precedence>
</obh:expertiseLanguageProperties>

JSON Example

(show inherited members)

{
    "beeType":"expertiseLanguageProperties",
        "defaultMaxTermsPerTopic":your_{http://www.oracle.com/beehive}defaultMaxTermsPerTopic_as_int0,
        "groupingMaxAnyPathInclusionRatio":your_{http://www.oracle.com/beehive}groupingMaxAnyPathInclusionRatio_as_double0,
        "groupingMaxAssocWords":your_{http://www.oracle.com/beehive}groupingMaxAssocWords_as_int0,
        "groupingMaxAvgCohForAsPhrase":your_{http://www.oracle.com/beehive}groupingMaxAvgCohForAsPhrase_as_float0,
        "groupingMaxAvgRatioForInclusion":your_{http://www.oracle.com/beehive}groupingMaxAvgRatioForInclusion_as_double0,
        "groupingMaxEdgeCombineAvgCoh":your_{http://www.oracle.com/beehive}groupingMaxEdgeCombineAvgCoh_as_float0,
        "groupingMaxKeywordsPerSet":your_{http://www.oracle.com/beehive}groupingMaxKeywordsPerSet_as_int0,
        "groupingMaxPeakRatioForInclusion":your_{http://www.oracle.com/beehive}groupingMaxPeakRatioForInclusion_as_double0,
        "groupingMaxWeight":your_{http://www.oracle.com/beehive}groupingMaxWeight_as_double0,
        "groupingMinEdgeCombineOcc":your_{http://www.oracle.com/beehive}groupingMinEdgeCombineOcc_as_int0,
        "groupingMinEdgeCombineWeight":your_{http://www.oracle.com/beehive}groupingMinEdgeCombineWeight_as_float0,
        "groupingMinUngroupableDiscard":your_{http://www.oracle.com/beehive}groupingMinUngroupableDiscard_as_int0,
        "groupingMinWordsForAcceptance":your_{http://www.oracle.com/beehive}groupingMinWordsForAcceptance_as_int0,
        "languageCode":your_{http://www.oracle.com/beehive}languageCode_as_int0,
        "minCoveredWordsToDisqualify":your_{http://www.oracle.com/beehive}minCoveredWordsToDisqualify_as_int0,
        "precedence":your_{http://www.oracle.com/beehive}precedence_as_int0
}

XML Schema


<xs:complexType name="expertiseLanguageProperties">
    <xs:sequence>
        <xs:element name="defaultMaxTermsPerTopic" type="xs:int"/>
        <xs:element name="groupingMaxAnyPathInclusionRatio" type="xs:double"/>
        <xs:element name="groupingMaxAssocWords" type="xs:int"/>
        <xs:element name="groupingMaxAvgCohForAsPhrase" type="xs:float"/>
        <xs:element name="groupingMaxAvgRatioForInclusion" type="xs:double"/>
        <xs:element name="groupingMaxEdgeCombineAvgCoh" type="xs:float"/>
        <xs:element name="groupingMaxKeywordsPerSet" type="xs:int"/>
        <xs:element name="groupingMaxPeakRatioForInclusion" type="xs:double"/>
        <xs:element name="groupingMaxWeight" type="xs:double"/>
        <xs:element name="groupingMinEdgeCombineOcc" type="xs:int"/>
        <xs:element name="groupingMinEdgeCombineWeight" type="xs:float"/>
        <xs:element name="groupingMinUngroupableDiscard" type="xs:int"/>
        <xs:element name="groupingMinWordsForAcceptance" type="xs:int"/>
        <xs:element name="languageCode" type="xs:int"/>
        <xs:element name="minCoveredWordsToDisqualify" type="xs:int"/>
        <xs:element name="precedence" type="xs:int"/>
    </xs:sequence>
</xs:complexType>

        

References

The following data represents the references to expertiseLanguageProperties

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions