5.2.1.14.8. RaR用インデックスの生成¶

IBM Watson Document Conversionサービスで、各種ドキュメントから IBM Watson が識別可能なRetrieve and Rank用インデックスを作成するタスクです。

入力値、出力値に関する詳細は、以下のAPIドキュメントを参照してください。

Document Conversion API Reference - IBM Watson Developer Cloud

コラム

APIバージョンについて

このタスクで実行可能なDocument ConversionサービスのAPIバージョンは「2015-12-15」です。

5.2.1.14.8.1. プロパティ¶

項目名	必須/任意	型	初期値	説明
エラーハンドリング	任意	flag	false	エラー発生時に処理を継続する場合は、チェックボックスをオンにします。

5.2.1.14.8.2. 入力値¶

im_watsonDocPostIndexDocument <object>
  ├─ config <object>
  │    ├─ convertDocument <object>
  │    │    └─ normalizedHtml <object>
  │    │          ├─ excludeContent <map>
  │    │          ├─ excludeTagAttributes <string[]>
  │    │          ├─ excludeTagsCompletely <string[]>
  │    │          ├─ excludeTagsKeepContent <string[]>
  │    │          ├─ keepContent <map>
  │    │          └─ keepTagAttributes <string[]>
  │    └─ retrieveAndRank <object>
  │          ├─ clusterId <string>
  │          ├─ dryRun <boolean>
  │          ├─ fields <object>
  │          │    ├─ exclude <string[]>
  │          │    ├─ include <string[]>
  │          │    └─ mappings <object[]>
  │          │          ├─ from <string>
  │          │          └─ to <string>
  │          ├─ searchCollection <string>
  │          └─ serviceInstanceId <string>
  ├─ file <binary> *
  └─ metadata <object>
        ├─ name <string>
        └─ value <string>

項目名	必須/任意	型	配列/リスト	説明
im_watsonDocPostIndexDocument	任意	object	なし
config	任意	object	なし	抽出オプション
convertDocument	任意	object	なし	構造を定義するオプション
normalizedHtml	任意	object	なし	変換オプション
excludeContent	任意	map	なし	変換されていないメインのコンテンツを識別する値
excludeTagAttributes	任意	string	リスト	HTMLタグに含めない属性名の一覧「keepTagAttributes」と排他指定です。
excludeTagsCompletely	任意	string	リスト	コンテンツから削除する対象のタグ一覧
excludeTagsKeepContent	任意	string	リスト	コンテンツから削除する対象のタグ一覧（コンテンツ内容は保持）
keepContent	任意	map	なし	コンテンツとして識別する対象
keepTagAttributes	任意	string	リスト	HTMLタグに含める属性名の一覧「excludeTagAttributes」と排他指定です。
retrieveAndRank	任意	object	なし	Retrieve and Rankサービスとの連携オプション
clusterId	任意	string	なし	Retrieve and RankサービスのSolrクラスタID
dryRun	任意	boolean	なし	どのようにインデックスされるのかテストする場合は `true`
fields	任意	object	なし	ドキュメントのメタデータとSolrのフィールドを接続するオプション
exclude	任意	object	リスト	除外するフィールド名の一覧
include	任意	object	リスト	含めるフィールド名の一覧
mappings	任意	object	リスト	ドキュメントのフィールドとSolrのフィールド間のマッピング
from	任意	string	なし	ドキュメントのフィールド名
to	任意	string	なし	Solrのフィールド名
searchCollection	条件付必須（※1）	string	なし	Retrieve and Rankサービスの「collection_name」値
serviceInstanceId	条件付必須（※1）	string	なし	Retrieve and Rankサービスの識別ID
file	必須	binary	なし	インデックスを抽出する元データ
metadata	任意	object	なし	メタデータの一覧
name	任意	string	なし	メタデータの名前
value	任意	string	なし	メタデータの値

（※1）config/retrieveAndRank/dryRun に null, false を指定する場合のみ必須。

5.2.1.14.8.3. 出力値¶

im_watsonDocPostIndexDocument <object>
  ├─ convertedDocument <object>
  │    ├─ answerUnits <object[]>
  │    │    ├─ content <object[]>
  │    │    │    ├─ mediaType <string>
  │    │    │    └─ text <string>
  │    │    ├─ direction <string>
  │    │    ├─ id <string>
  │    │    ├─ parentId <string>
  │    │    ├─ title <string>
  │    │    └─ type <string>
  │    ├─ mediaTypeDetected <string>
  │    └─ metadata <object[]>
  │          ├─ content <string>
  │          └─ name <string>
  ├─ solrDocument <map>
  ├─ status <string>
  └─ warnings <object[]>
        ├─ description <string>
        ├─ phase <string>
        └─ warningId <string>

項目名	型	配列/リスト	説明
im_watsonDocPostIndexDocument	object	なし
answerUnits	object	リスト	分割単位
content	object	リスト	コンテンツ
mediaType	string	なし	メディアタイプ
text	string	なし	抽出されたテキストデータ
direction	string	なし	記述方向 `ltr` または `rtl`
id	string	なし	単位ID
parentId	string	なし	親の単位ID
title	string	なし	タイトル
type	string	なし	種別
mediaTypeDetected	string	なし	認識された元データのメディアタイプ
metadata	object	リスト	メタデータの一覧
content	string	なし	メタデータの名称
name	string	なし	メタデータの値
solrDocument	map	なし	Retrieve and Rankサービスにどのように登録されるのかを表すデータ入力値の config/retrieveAndRank/dryRun に `true` を指定した場合のみ出力されます。
status	string	なし	インデックス作成要求のステータス入力値の config/retrieveAndRank/dryRun に `null`, `false` を指定した場合のみ出力されます。
warnings	object	リスト	警告情報
description	string	なし	警告の詳細
phase	string	なし	警告が生成された際の変換プロセスを示す文字列
warningId	string	なし	警告ID

目次

5.2.1.14.8. RaR用インデックスの生成¶

5.2.1.14.8.1. プロパティ¶

5.2.1.14.8.2. 入力値¶

5.2.1.14.8.3. 出力値¶

目次