dester_python package

dester_python module

dester_python.exec_dester_cmd(execType, inputPath, configPath=None, outputPath=None, configParam=None, defaultHeap=None, maxHeap=None, showHelp=False)

「NEC Advanced Analytics - テキスト分析」が提供する

コマンドラインインタフェースを実行します。

Note

環境変数$DESTER_HOMEの値は「/opt/nec/dester」になります。

Parameters:

execType : {‘dester-classify-csv-csv’, ‘dester-classify-csv-asfs’, ‘dester-classify-asfs-csv’, ‘dester-extract-csv-csv’, ‘dester-extract-csv-asfs’, ‘dester-extract-asfs-csv’, ‘dester-thrusent-asfs-asfs’, ‘dester-thrudoc-asfs-asfs’, ‘dester-span-cluster-asfs’, ‘dester-span-cluster-csv’, ‘dester-span-cluster-extracted-asfs’, ‘dester-doc-cluster-asfs’, ‘dester-doc-cluster-csv’, ‘dester-doc-cluster-classified-asfs’, ‘dester-classify-training’, ‘dester-classify-training-asfs’, ‘dester-extract-training’, ‘dester-extract-training-asfs’, ‘dester-classify-evaluation’, ‘dester-classify-evaluation-asfs’, ‘dester-extract-evaluation’, ‘dester-extract-evaluation-asfs’, ‘dester-analyze-csv-asfs’, ‘dester-keyphrase-asfs’, ‘dester-search-index-build-asfs’,’dester-feature-csv-csv’}

Problem execType;

‘dester-classify-csv-csv’:

分析対象のCSVファイルパスを入力として文書判別を行い、 判別結果をCSVファイルに出力します。

‘dester-classify-csv-asfs’:

分析対象のCSVファイルパスを入力として文書判別を行い、 判別結果をASFファイルに出力します。

‘dester-classify-asfs-csv’:

分析対象のASFファイルパスを入力として文書判別を行い、 判別結果をASFファイルとCSVファイルの両方に出力します。 ※オプション : outputPathは指定不可

‘dester-extract-csv-csv’:

分析対象のCSVファイルパスを入力としてスパン抽出を行い、 抽出結果をCSVファイルに出力します。

‘dester-extract-csv-asfs’:

分析対象のCSVファイルパスを入力としてスパン抽出を行い、 抽出結果をASFファイルに出力します。

‘dester-extract-asfs-csv’:

分析対象のASFファイルパスを入力としてスパン抽出を行い、 抽出結果をASFファイルとCSVファイルの両方に出力します。 ※オプション : outputPathは指定不可

‘dester-thrusent-asfs-asfs’:

分析対象のASFファイルパスを入力として 文クラスタリング用のスパンを設定するスパン抽出を行い、 抽出結果をASFファイルに出力します。

‘dester-thrudoc-asfs-asfs’:

分析対象のASFファイルパスを入力として文書クラスタリング用の スパンを設定するスパン抽出を行い、 抽出結果をASFファイルに出力します。

‘dester-span-cluster-asfs’:

分析対象のASFファイルが格納されたディレクトリパスを入力として 文クラスタリングを行い、結果をクラスタリング結果ファイルに出力します。

‘dester-span-cluster-csv’:

分析対象のCSVファイルパスを入力として文クラスタリングを行い、 結果をクラスタリング結果ファイルに出力します。

‘dester-span-cluster-extracted-asfs’:

スパン抽出済みのASFファイルパスを入力として文クラスタリングを行い、 結果をクラスタリング結果ファイルに出力します。

‘dester-doc-cluster-asfs’:

分析対象のASFファイルが格納されたディレクトリパスを入力として 文書クラスタリングを行い、 結果をクラスタリング結果ファイルに出力します。

‘dester-doc-cluster-csv’:

分析対象のCSVファイルパスを入力として文書クラスタリングを行い、 結果をクラスタリング結果ファイルに出力します。

‘dester-doc-cluster-classified-asfs’:

文書判別済みのASFファイルパスを入力として文書クラスタリングを行い、 結果をクラスタリング結果ファイルに出力します。

‘dester-classify-training’:

文書判別用の正解付きCSVファイルパスを入力として文書判別学習を行い、 分析モデルファイルを出力します。

‘dester-classify-training-asfs’:

文書判別用の正解付きASFファイルパスを入力として文書判別学習を行い、 分析モデルファイルを出力します。

‘dester-extract-training’:

スパン抽出用の正解付きCSVファイルパスを入力としてスパン抽出学習を行い、 分析モデルファイルを出力します。

‘dester-extract-training-asfs’:

スパン抽出用の正解付きASFファイルパスを入力としてスパン抽出学習を行い、 分析モデルファイルを出力します。

‘dester-classify-evaluation’:

文書判別用の正解付きCSVファイルパスを入力として文書判別評価を行い、 評価結果を出力します。

‘dester-classify-evaluation-asfs’:

文書判別用の正解付きASFファイルパスを入力として文書判別評価を行い、 評価結果を出力します。

‘dester-extract-evaluation’:

スパン抽出用の正解付きCSVファイルパスを入力としてスパン抽出モデルの評価を行い、 評価結果を出力します。

‘dester-extract-evaluation-asfs’:

スパン抽出用の正解付きASFファイルパスを入力としてスパン抽出評価を行い、 評価結果を出力します。

‘dester-analyze-csv-asfs’:

解析対象のCSVファイルパスを入力として言語解析を行い、 結果をASFファイルに出力します。

‘dester-keyphrase-asfs’:

文書判別用の正解付きASFファイルパスを入力として特徴表現抽出を行い、 結果を特徴表現辞書ファイルに出力します。

‘dester-search-index-build-asfs’:

スパン抽出済みのASFファイルが格納されたディレクトリパスを入力として、 含意検索インデックスを構築します。 ※オプション : outputPathは指定不可

‘dester-feature-csv-csv’:

分析対象のCSVファイルパスを入力として素性抽出を行い、 判別結果をCSVファイルに出力します。

inputPath : str

分析対象のファイルパスを指定します。相対パスで指定した場合は、 環境変数$DESTER_HOMEからの相対パスになります。

configPath : str or None, default: None

個別コンフィグレーションファイルパスを指定します。 相対パスで指定した場合は、環境変数$DESTER_HOMEからの相対パスになります。 本オプションを省略した場合は、共通コンフィグレーションファイル (default.conf)のみを使用します。

outputPath : str or None, default: None

出力パスを指定します。（ファイルパス、または、ディレクトリパス） ※dester-classify-asfs-csv、dester-extract-asfs-csv、

dester-search-index-build-asfs では指定不可となります。

configParam : list or None, default: None

実行時のみ変更したい設定を指定します。（複数指定可）

例）[‘WRITE_CSV.PATH=path/to/output.csv’]

defaultHeap : str or None, default: None

内部で実行するjavaコマンドがデフォルトで確保するヒープ領域のサイズを指定します。 指定可能な値は1024の倍数の数値または、 整数値の末尾に「k,K,m,M」の何れかの文字(単位)を付加したものとします。

maxHeap : str or None, default: None

内部で実行するjavaコマンドが確保するヒープ領域の最大サイズを指定します。 指定可能な値は1024の倍数の数値または、 整数値の末尾に「k,K,m,M」の何れかの文字(単位)を付加したものとします。

showHelp : bool or None, default: None

ヘルプメッセージを表示します。 ※当オプションが指定されている場合、処理は実行しません。

Returns:

None

Raises:

ValueError

execTypeの値が不正の場合。

RuntimeError

コマンドラインインタフェースの実行が異常終了した場合。

dester_python.createDeSTERCSVReadingProcess(properties)

DeSTERCSVReadingProcessクラスのコンストラクタです。 DeSTERCSVReadingProcessはCSVファイルの読み込み処理を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERCSVReadingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERCSVReadingProcess

DeSTERCSVReadingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERCSVReadingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERCSVWritingProcess(properties)

DeSTERCSVWritingProcessクラスのコンストラクタです。 DeSTERCSVWritingProcessはCSVファイルの書き込み処理を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERCSVWritingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERCSVWritingProcess

DeSTERCSVWritingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERCSVWritingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERASFReadingProcess(properties)

DeSTERASFReadingProcessクラスのコンストラクタです。 DeSTERASFReadingProcessはASFファイルの読み込み処理を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERASFReadingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERASFReadingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERASFReadingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERASFWritingProcess(properties)

DeSTERASFWritingProcessクラスのコンストラクタです。 DeSTERASFWritingProcessはASFファイルの書き込み処理を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERASFWritingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERASFWritingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERASFWritingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERDirectoryReadingProcess(properties)

DeSTERDirectoryReadingProcessクラスのコンストラクタです。 DeSTERDirectoryReadingProcessは、 ASFファイルが格納されたディレクトリの読み込み処理を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERDirectoryReadingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERDirectoryReadingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERDirectoryReadingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERClusterWritingProcess(properties)

DeSTERClusterWritingProcessクラスのコンストラクタです。 DeSTERClusterWritingProcessは、クラスタリング結果ファイル(JSON形式）の 書き込み処理を行うプロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERClusterWritingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERClusterWritingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERClusterWritingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTEREvaluatorWritingProcess(properties)

DeSTEREvaluatorWritingProcessクラスのコンストラクタです。 DeSTEREvaluatorWritingProcessは、 評価結果が含まれたEvaluatorクラスのオブジェクトから、 評価結果ファイルを出力するプロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTEREvaluatorWritingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTEREvaluatorWritingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTEREvaluatorWritingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERAnalyzingProcess(properties)

DeSTERAnalyzingProcessクラスのコンストラクタです。 DeSTERAnalyzingProcessは、言語解析を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERAnalyzingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERAnalyzingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERAnalyzingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERClassificationProcess(properties, modelPath=None)

DeSTERClassificationProcessクラスのコンストラクタです。 DeSTERClassificationProcessは、文書判別を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERClassificationProcessクラスのインスタンス初期化を行います。 文書判別で使用する分析モデルを直接指定する場合は、’modelPath’を 指定して使用します。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

modelPath : str or None, default: None

文書判別で使用するモデルファイルが格納されたディレクトリパス。 Noneの場合、コンフィグファイルに設定されたディレクトリパスが 指定されたものとみなします。空文字等の不正な文字列が指定された場合、 エラーになります。

Returns:

DeSTERClassificationProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERClassificationProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERExtractionProcess(properties, modelPath=None)

DeSTERExtractionProcessクラスのコンストラクタです。 DeSTERExtractionProcessは、スパン抽出を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERExtractionProcessクラスのインスタンス初期化を行います。 スパン抽出で使用する分析モデルを直接指定する場合は、’modelPath’を 指定して使用します。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

modelPath : str or None, default: None

スパン抽出で使用するモデルファイルが格納されたディレクトリパス。 Noneの場合、コンフィグファイルに設定されたディレクトリパスが 指定されたものとみなします。空文字等の不正な文字列が指定された場合、 エラーになります。

Returns:

DeSTERExtractionProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERExtractionProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERSpanClusteringProcess(properties)

DeSTERSpanClusteringProcessクラスのコンストラクタです。 DeSTERSpanClusteringProcessは、文クラスタリングを行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERSpanClusteringProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERSpanClusteringProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERSpanClusteringProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERDocumentClusteringProcess(properties)

DeSTERDocumentClusteringProcessクラスのコンストラクタです。 DeSTERDocumentClusteringProcessは、文書クラスタリングを行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERDocumentClusteringProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERDocumentClusteringProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERDocumentClusteringProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERClassifierEvaluationProcess(properties)

DeSTERClassifierEvaluationProcessクラスのコンストラクタです。 DeSTERClassifierEvaluationProcessは、文書判別評価を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERClassifierEvaluationProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERClassifierEvaluationProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERClassifierEvaluationProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERExtractorEvaluationProcess(properties)

DeSTERExtractorEvaluationProcessクラスのコンストラクタです。 DeSTERExtractorEvaluationProcessは、スパン抽出評価を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERExtractorEvaluationProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERExtractorEvaluationProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERExtractorEvaluationProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERClassifierTrainingProcess(properties, modelPath=None)

DeSTERClassifierTrainingProcessクラスのコンストラクタです。 DeSTERClassifierTrainingProcessは、文書判別器の学習を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERClassifierTrainingProcessクラスのインスタンス初期化を行います。 分析モデルファイルの出力先を直接指定する場合は、’modelPath’を 指定して使用します。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

modelPath : str or None, default: None

モデルファイルを格納するディレクトリパス。

Returns:

DeSTERClassifierTrainingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERClassifierTrainingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERExtractorTrainingProcess(properties, modelPath=None)

DeSTERExtractorTrainingProcessクラスのコンストラクタです。 DeSTERExtractorTrainingProcessは、スパン抽出器の学習を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERExtractorTrainingProcessクラスのインスタンス初期化を行います。 分析モデルファイルの出力先を直接指定する場合は、’modelPath’を 指定して使用します。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

modelPath : str or None, default: None

モデルファイルを格納するディレクトリパス。

Returns:

DeSTERExtractorTrainingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERExtractorTrainingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERKeyphraseExtractionProcess(properties)

DeSTERKeyphraseExtractionProcessクラスのコンストラクタです。 DeSTERKeyphraseExtractionProcessは、特徴表現抽出を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERKeyphraseExtractionProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERKeyphraseExtractionProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERKeyphraseExtractionProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERKeyphraseWritingProcess(properties)

DeSTERKeyphraseWritingProcessクラスのコンストラクタです。 DeSTERKeyphraseWritingProcessは、特徴表現抽出処理の結果を 特徴表現辞書ファイルに出力するプロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERKeyphraseWritingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERKeyphraseWritingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERKeyphraseWritingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERSearchIndexManagementProcess(properties)

DeSTERSearchIndexManagementProcessクラスのコンストラクタです。 DeSTERSearchIndexManagementProcessは、含意検索のインデックスを 管理するプロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERSearchIndexManagementProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERSearchIndexManagementProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERSearchIndexManagementProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERSearchingProcess(properties)

DeSTERSearchingProcessクラスのコンストラクタです。 DeSTERSearchingProcessは、含意検索を行う プロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERSearchingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERSearchingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERSearchingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERSearchResultWritingProcess(properties)

DeSTERSearchResultWritingProcessクラスのコンストラクタです。 DeSTERSearchResultWritingProcessは、含意検索の結果を ファイルに出力するプロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERSearchResultWritingProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERSearchResultWritingProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERSearchResultWritingProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERFeatureOutputProcess(properties)

DeSTERFeatureOutputProcessクラスのコンストラクタです。 DeSTERFeatureOutputProcessは、素性抽出を行うプロセスAPIクラスです。 引数に指定したDeSTERPropertiesクラスオブジェクトの設定内容に従って DeSTERFeatureOutputProcessクラスのインスタンス初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

properties : DeSTERProperties

コンフィグレーションファイル解析結果が含まれた DeSTERPropertiesクラスのオブジェクト。

Returns:

DeSTERFeatureOutputProcessクラスのオブジェクト。

Raises:

RuntimeError

DeSTERFeatureOutputProcessクラスのインスタンス初期化に失敗した場合。

dester_python.createDeSTERProperties(configPath=None)

DeSTERPropertiesクラスのコンストラクタです。 DeSTERPropertiesは、プロセスAPIが実行する 各「NEC AdvancedAnalytics - テキスト分析」の機能、動作の設定が行われる コンフィグレーションファイルの内容を読み込み、保持するためのクラスです。 DeSTERPropertiesクラスのインスタンス初期化を行い、 共通コンフィグレーションファイル(default.conf)と引数に指定された 個別コンフィグレーションファイルを読み込みます。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

configPath : str or None, default: None

個別コンフィグレーションファイルのパスを指定します。相対パスで 指定した場合は、環境変数$DESTER_HOMEからの相対パスになります。

Returns:

DeSTERProperties

DeSTERPropertiesクラスのオブジェクト。

Raises:

RuntimeError

コンフィグレーションファイル読み込みに失敗した場合。

dester_python.createRawDocument(documentId, text)

RawDocumentクラスのコンストラクタです。 RawDocumentは、言語解析前の文書を管理するクラスです。 引数documentId、textをスーパークラスBaseDocumentのコンストラクタに渡して、 メンバ変数の初期化を行います。

Note

本メソッド内の処理で「dester_python.get_java_gateway()」を呼び出します。

Parameters:

documentId : str

RawDocumentクラスのオブジェクトに設定するドキュメントID。

text : str

RawDocumentクラスのオブジェクトに設定する未加工の 文字列データ。

Returns:

RawDocument

RawDocumentクラスのオブジェクト。

Raises:

RuntimeError

引数documentIdに英数字、アンダースコア、ピリオド以外の文字が含まれる場合。

引数documentIdが255文字を超える場合。

引数textがnullまたは空の場合。

dester_python.get_java_gateway()

「NEC Advanced Analytics - テキスト分析」が提供するAPIを利用するためのサーバ （以降「Gatewayサーバ」と称する）を起動します。 Gatewayサーバが既に起動中の場合は、新規起動は行いません。

Note

各クラスのコンストラクタの内部で自動的に呼び出しが行われるため、 基本的には、本メソッドをユーザが明示的に呼び出す必要はありません。

Returns:

py4j.java_gateway.JavaGateway

Gatewayサーバにアクセスするためのオブジェクト。

Raises:

RuntimeError

Gatewayサーバの起動に失敗した場合。

dester_python.shutdown()

起動中のGatewayサーバを停止します。

本メソッドを実行すると、dester_pythonのモジュールで作成した オブジェクトは全て解放されます。 使用中のオブジェクトがある場合に本メソッドを実行すると、 以下のエラーが表示されることがありますが、処理には影響ありません。

• ERROR:root:Exception while sending command.

継続して他の処理を行いたい場合は、各クラスのコンストラクタの再生成を 行ってください。

Note

基本的には、本メソッドをユーザが明示的に呼び出す必要はありません。

Returns:

None

Raises:

RuntimeError

Gatewayサーバの停止に失敗した場合。

class dester_python.JavaStartParam

Bases: object

Java実行時のオプションを設定するクラスです。

Note

設定の適用はGatewayサーバ起動時に設定します。 すでにGatewayサーバが起動している場合は一度Gatewayサーバを停止してから 新たにGatewayサーバを起動してください。

get_param()

設定中のJavaオプションを取得します。

Returns:list : 設定中のJavaオプションのリスト Raises:None

set_param(p)

引数pで指定したJavaオプションを設定します。

Note

例:

dester_python.JavaStartParam().set_param([‘-Xmx512m’,’-Xms6m’])

Parameters:p : Javaオプションを格納したリスト Returns:None Raises:None