GET
/
v2
/
get_job_scope
cURL
curl --request GET \
  --url http://127.0.0.1:9550/v2/get_job_scope
{
  "local_vrkai": [
    {
      "vrkai": {
        "metadata": {},
        "resource": {
          "Document": {
            "created_datetime": "2023-12-25",
            "data_tag_index": {
              "index": {}
            },
            "description": "<string>",
            "distribution_info": {
              "datetime": "2023-12-25",
              "origin": {}
            },
            "embedding_model_used_string": "<string>",
            "embeddings": [
              {}
            ],
            "keywords": {
              "keyword_list": [
                "<any>"
              ],
              "keywords_embedding": {}
            },
            "last_written_datetime": "2023-12-25",
            "merkle_root": "<string>",
            "metadata_index": {
              "index": {}
            },
            "name": "<string>",
            "node_count": 1,
            "nodes": [
              {}
            ],
            "resource_base_type": "Document",
            "resource_embedding": {
              "id": "<any>",
              "vector": "<any>"
            },
            "resource_id": "<string>",
            "source": {
              "Standard": {}
            }
          }
        },
        "sfm": {
          "map": {},
          "source_files_count": 1
        },
        "version": "V1"
      }
    }
  ],
  "local_vrpack": [
    {
      "vrpack": {
        "embedding_models_used": {},
        "folder_count": 1,
        "metadata": {},
        "name": "<string>",
        "resource": {
          "Document": {
            "created_datetime": "2023-12-25",
            "data_tag_index": {
              "index": {}
            },
            "description": "<string>",
            "distribution_info": {
              "datetime": "2023-12-25",
              "origin": {}
            },
            "embedding_model_used_string": "<string>",
            "embeddings": [
              {}
            ],
            "keywords": {
              "keyword_list": [
                "<any>"
              ],
              "keywords_embedding": {}
            },
            "last_written_datetime": "2023-12-25",
            "merkle_root": "<string>",
            "metadata_index": {
              "index": {}
            },
            "name": "<string>",
            "node_count": 1,
            "nodes": [
              {}
            ],
            "resource_base_type": "Document",
            "resource_embedding": {
              "id": "<any>",
              "vector": "<any>"
            },
            "resource_id": "<string>",
            "source": {
              "Standard": {}
            }
          }
        },
        "version": "V1",
        "vrkai_count": 1
      }
    }
  ],
  "network_folders": [
    {
      "external_identity": {
        "full_name": "<string>",
        "node_name": "<string>",
        "profile_name": "<string>",
        "subidentity_name": "<string>",
        "subidentity_type": "Agent"
      },
      "name": "<string>",
      "path": {
        "path_ids": [
          "<string>"
        ]
      }
    }
  ],
  "vector_fs_folders": [
    {
      "name": "<string>",
      "path": {
        "path_ids": [
          "<string>"
        ]
      }
    }
  ],
  "vector_fs_items": [
    {
      "name": "<string>",
      "path": {
        "path_ids": [
          "<string>"
        ]
      },
      "source": {
        "Standard": {}
      }
    }
  ]
}
Fetch the defined scope or boundaries of a particular job.

Query Parameters

job_id
string
required

Job ID to retrieve scope for

Response

Successfully retrieved job scope

Job's scope which includes both Local entries (vrkai stored locally only in job) and VecFS entries (source/vector resource stored in the FS, accessible to all jobs)