A script enabled browser is required for this page to function properly
Oracle® Beehive RESTful Web Services API Reference
Release 2 (2.0.1.7)
E16658-04
Overview
Include in type ExpertiseTopicClauses to generate topics based on
ExpertiseSearchClauses derived from search text supplied in a search request.
Topics are built based on keywords extracted from the ExpertiseSearchClauses.
The ExpertiseSearchClauses are supplied in a ExpertiseSearchClauseList. Refer
to expertiseTopicClauses , expertiseSearchClause , and
expertiseSearchClauseList for more details.
Members
Show inherited members
Name
Type
Required
Description
applyStopWords
boolean
Whether to apply stop words to the topic's keywords
clauseList
expertiseSearchClauseList
The search clauses to use to search and base the keywords from. Topics
based off of these keywords will be built.
matchingBand
int
Index of the ExpertiseSearchBand in ExpertiseSearchClauseList that was a
match
matchingSearchClause
int
Index of search's ExpertiseSearchClause within the ExpertiseSearchBand that
was a match
mustMatchSearch
boolean
Parameter indicating if true that all topics must satisfy the boolean logic
of the search, or if false that they must be based around words in the
search but that each Topic need not satisfy the search expression. For
example, consider a search containing the expression "search and engine".
If this parameter is true, only topics containing both words "search" and
"engine" will be returned. Otherwise, additional topics related only to
"search" and only to "engine" can be generated.
orderByStrength
expertiseMatchStrength
The manner to order matching profile's strengths.
pageSpec
numericPagingOptions
Which "page" of search results are considered
profileScopeFilter
beeId <expertiseUserScope >[]
Criteria limiting the profiles being searched
relativeWeight
int
The relative weight/importance of this clause. This integer value acts as a multiplier
on the clause's weight. For example, if "2", the clause's weight is doubled. Any value
larger than 1 can be supplied.
reviewed
boolean
The boolean identifying which terms are being considered when building topics
based on the term's reviewed status.
termVisibility
visibility []
The object identifying which terms are being considered when building
topics based on the term visibility.
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:expertiseTopicSearchClause xsi:type="obh:expertiseTopicSearchClause" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<obh:applyStopWords>your_boolean_0 </obh:applyStopWords>
<obh:clauseList>your_expertiseSearchClauseList_0 </obh:clauseList>
<obh:matchingBand>your_int_0 </obh:matchingBand>
<obh:matchingSearchClause>your_int_0 </obh:matchingSearchClause>
<obh:mustMatchSearch>your_boolean_0 </obh:mustMatchSearch>
<obh:orderByStrength>your_expertiseMatchStrength_0 </obh:orderByStrength>
<obh:pageSpec>your_numericPagingOptions_0 </obh:pageSpec>
<obh:profileScopeFilter>your_beeId_0 </obh:profileScopeFilter>
<obh:profileScopeFilter>your_beeId_1 </obh:profileScopeFilter>
<obh:profileScopeFilter>your_beeId_2 </obh:profileScopeFilter>
<obh:relativeWeight>your_int_0 </obh:relativeWeight>
<obh:reviewed>your_boolean_0 </obh:reviewed>
<obh:termVisibility>your_visibility_0 </obh:termVisibility>
<obh:termVisibility>your_visibility_1 </obh:termVisibility>
<obh:termVisibility>your_visibility_2 </obh:termVisibility>
</obh:expertiseTopicSearchClause>
JSON Example
(show inherited members)
{
"beeType":"expertiseTopicSearchClause",
"applyStopWords":your_{http://www.oracle.com/beehive}applyStopWords_as_boolean0,
"clauseList":{ your_{http://www.oracle.com/beehive}clauseList_as_expertiseSearchClauseList0 },
"matchingBand":your_{http://www.oracle.com/beehive}matchingBand_as_int0,
"matchingSearchClause":your_{http://www.oracle.com/beehive}matchingSearchClause_as_int0,
"mustMatchSearch":your_{http://www.oracle.com/beehive}mustMatchSearch_as_boolean0,
"orderByStrength":{ your_{http://www.oracle.com/beehive}orderByStrength_as_expertiseMatchStrength0 },
"pageSpec":{ your_{http://www.oracle.com/beehive}pageSpec_as_numericPagingOptions0 },
"profileScopeFilter":[
{ your_{http://www.oracle.com/beehive}profileScopeFilter_as_beeId0 },
{ your_{http://www.oracle.com/beehive}profileScopeFilter_as_beeId1 },
{ your_{http://www.oracle.com/beehive}profileScopeFilter_as_beeId2 }
],
"relativeWeight":your_{http://www.oracle.com/beehive}relativeWeight_as_int0,
"reviewed":your_{http://www.oracle.com/beehive}reviewed_as_boolean0,
"termVisibility":[
{ your_{http://www.oracle.com/beehive}termVisibility_as_visibility0 },
{ your_{http://www.oracle.com/beehive}termVisibility_as_visibility1 },
{ your_{http://www.oracle.com/beehive}termVisibility_as_visibility2 }
]
}
XML Schema
<xs:complexType name="expertiseTopicSearchClause">
<xs:complexContent>
<xs:extension base="tns:expertiseTopicClause">
<xs:sequence>
<xs:element name="applyStopWords" type="xs:boolean"/>
<xs:element minOccurs="0" name="clauseList" type="tns:expertiseSearchClauseList"/>
<xs:element name="matchingBand" type="xs:int"/>
<xs:element name="matchingSearchClause" type="xs:int"/>
<xs:element name="mustMatchSearch" type="xs:boolean"/>
<xs:element minOccurs="0" name="orderByStrength" type="tns:expertiseMatchStrength"/>
<xs:element minOccurs="0" name="pageSpec" type="tns:numericPagingOptions"/>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="profileScopeFilter" nillable="true" type="tns:beeId"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
References
The following data represents the references to expertiseTopicSearchClause
Referenced By Resources
Referenced By Representaions
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices