コネクタパイプラインAPIの更新

この機能はベータ版であり、変更される可能性があります。設計とコードは公式GA機能よりも成熟しておらず、保証なしでそのまま提供されています。ベータ機能は公式GA機能のサポートSLAの対象外です。

コネクタのpipeline設定を更新します。

新しいコネクタを作成すると、インジェストパイプラインの設定はデフォルト設定で自動的に設定されます。

コネクタAPIを始めるには、チュートリアルを確認してください。

リクエスト

PUT _connector/<connector_id>/_pipeline

前提条件

  • 自己管理のコネクタを使用してデータを同期するには、独自のインフラストラクチャにElasticコネクタサービスをデプロイする必要があります。このサービスは、ネイティブコネクタ用にElastic Cloud上で自動的に実行されます。
  • connector_idパラメータは、既存のコネクタを参照する必要があります。

パスパラメータ

  • <connector_id>
  • (必須、文字列)

リクエストボディ

  • pipeline
  • (必須、オブジェクト)コネクタのパイプライン設定。パイプラインは、Elasticsearchへのインジェスト中にデータがどのように処理されるかを決定します。

パイプライン設定には、以下の属性が含まれている必要があります:

  • extract_binary_content(必須、ブール値)インジェスト中にバイナリコンテンツを抽出するかどうかを示すフラグ。
  • name(必須、文字列)インジェストパイプラインの名前。
  • reduce_whitespace(必須、ブール値)インジェストされたコンテンツの余分な空白を削減するかどうかを示すフラグ。
  • run_ml_inference(必須、ブール値)インジェストされたコンテンツに対して機械学習推論を実行するかどうかを示すフラグ。

レスポンスコード

  • 200
  • コネクタpipelineフィールドが正常に更新されました。
  • 400
  • connector_idが提供されていないか、リクエストペイロードが不正です。
  • 404(リソースが不足しています)
  • connector_idに一致するコネクタが見つかりませんでした。

次の例は、ID my-connectorのコネクタのpipelineプロパティを更新します。

Python

  1. resp = client.connector.update_pipeline(
  2. connector_id="my-connector",
  3. pipeline={
  4. "extract_binary_content": True,
  5. "name": "my-connector-pipeline",
  6. "reduce_whitespace": True,
  7. "run_ml_inference": True
  8. },
  9. )
  10. print(resp)

Ruby

  1. response = client.connector.update_pipeline(
  2. connector_id: 'my-connector',
  3. body: {
  4. pipeline: {
  5. extract_binary_content: true,
  6. name: 'my-connector-pipeline',
  7. reduce_whitespace: true,
  8. run_ml_inference: true
  9. }
  10. }
  11. )
  12. puts response

Js

  1. const response = await client.connector.updatePipeline({
  2. connector_id: "my-connector",
  3. pipeline: {
  4. extract_binary_content: true,
  5. name: "my-connector-pipeline",
  6. reduce_whitespace: true,
  7. run_ml_inference: true,
  8. },
  9. });
  10. console.log(response);

コンソール

  1. PUT _connector/my-connector/_pipeline
  2. {
  3. "pipeline": {
  4. "extract_binary_content": true,
  5. "name": "my-connector-pipeline",
  6. "reduce_whitespace": true,
  7. "run_ml_inference": true
  8. }
  9. }

コンソール-結果

  1. {
  2. "result": "updated"
  3. }