値検索問合せの形式

値検索問合せを作成するには、ValueSearchConfigタイプを使用して、SearchTerm要素と、オプションで検索する属性を指定します。

ValueSearchConfigはContentElementConfig複合タイプ要素のタイプです。ValueSearchConfigは、単一の値検索問合せの動作を制御します。

SearchTerm要素は、値検索可能なすべての属性、またはRestrictToPropertiesで指定する属性のいずれかに対する検索のために、Oracle Endeca Serverによって使用される検索語を指定します。オプションで、MaxPerPropertyを使用して、各属性に対して返される検索一致の数を制限できます。

ValueSearchConfigタイプには、次のパラメータがあります(一部はオプションです)。

パラメータ	説明
`HandlerFunction`	必須属性。`ValueSearchConfig`に対して、`ValueSearchHandler`ハンドラ関数を指定します。
`HandlerNamespace`	必須属性。ハンドラ関数のネームスペースを指定します。
`Id`	オプション。この問合せ構成の識別子。
`Mode`	オプション。`Any`や`AllPartial`などの検索モードを指定します。`Mode`を使用しない場合、問合せはデフォルトで`All`検索モードの使用に設定されます。
`MaxPerProperty`	オプション。レコード属性当たりで返される一致の数を制限します。この属性が省略された場合、レコード属性に対して検出されたすべての一致が返されます。
`RelevanceRankingStrategy`	オプション。結果で使用する関連性ランキングの方針を指定します。この属性を省略して関連性ランキングの方針を指定しない場合、DIMSEARCH_CONFIG構成ドキュメントに指定された方針の値が使用されます。ドキュメントで方針を指定しない場合、(同順位をなくすために) `interp`、`exact`および`static`の3つの方針をこの順序で使用して結果をランク付けします。
`RestrictToProperties`	オプション。指定しない場合、リクエストはすべての属性内で検索します。指定した場合、リクエストは指定した属性内で検索します。
`SearchTerm`	必須です。値検索を実行するために使用する検索語(キーワードとも呼ばれます)を含めます。
`Language`	オプション。検索の言語IDを指定します。有効な言語IDは、「サポートされる言語」トピックにリストされています。

値検索問合せの例

次の例では、対話Webサービスでの通常の値検索リクエストの形式を示しています。

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Request xmlns="http://www.endeca.com/MDEX/conversation/2/0">
      <State />
      <Operator xsi:type="RecordKindOperator" 
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <RecordKind>data</RecordKind>
      </Operator>
      <ContentElementConfig xsi:type="ValueSearchConfig" 
         Id="ValueSearch" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         HandlerNamespace="http://www.endeca.com/MDEX/conversation/2/0"
         HandlerFunction="ValueSearchHandler"
         MaxPerProperty="5"
         RelevanceRankingStrategy="static (nbins,descending)"
         Mode="Any"
         Language="en">
         <SearchTerm>envoy</SearchTerm>
         <RestrictToProperties>
            <Property>PROD_NAME</Property>
         </RestrictToProperties>
      </ContentElementConfig>
    </Request>
  </soap:Body>
</soap:Envelope>

このリクエストでは、検索はPROD_NAME属性内で語envoyに対して実行されます。属性当たりで返されるリクエストされた結果の数は、5に設定されていて、英語(en)は検索用の言語です。