H2h2o
Extractors

Fetch an extractor by ID

This endpoint retrieves information about a specific extractor based on its unique ID. It requires an authenticated user and returns a JSON response containing the extractor's details.

get/extractors/{extractor_id}

Request

Path parameters

extractor_idstring required

ID of the extractor to get.

Response

OK

namestring required

Human-readable name

descriptionstring required

What this extractor does

llmstring

(Optional) Identifier or version of the language model the extractor uses

schemastring

(Optional) JSONSchema (or other spec) that the extractor outputs

promptstring

(Optional) Prompt text for the extractor

pre_prompt_summarystring

(Optional) Pre-prompt summary text for the extractor

keep_intermediate_resultsboolean

(Optional) Flag indicating whether to keep intermediate results during extraction

system_promptstring

(Optional) System prompt text for the extractor

max_num_chunksinteger

(Optional) Maximum number of chunks to process

visionstring

(Optional) Vision mode setting

vision_llmstring

(Optional) Vision LLM model identifier

image_batch_image_promptstring

(Optional) Image batch processing prompt

image_batch_final_promptstring

(Optional) Final prompt for image batch processing

idstring required

Unique identifier of the extractor

is_publicboolean required

Flag indicating if the extractor is public

created_atstring date-time required

When the extractor definition was created

Example response

{
  "guardrails_settings": {
    "disallowed_regex_patterns": [
      "secret_disallowed_word",
      "(?!0{3})(?!6{3})[0-8]\\d{2}-(?!0{2})\\d{2}-(?!0{4})\\d{4}"
    ],
    "presidio_labels_to_flag": [
      "IBAN_CODE",
      "US_SSN"
    ],
    "pii_labels_to_flag": [
      "IBAN",
      "SSN"
    ],
    "prompt_guard_labels_to_flag": [
      "JAILBREAK"
    ],
    "guardrails_labels_to_flag": [
      "Violent Crimes",
      "Non-Violent Crimes",
      "Intellectual Property",
      "Code Interpreter Abuse"
    ],
    "guardrails_llm": "h2oai/h2o-danube3-4b-chat",
    "guardrails_safe_category": "Safe",
    "column_redaction_custom_entities_to_flag": [
      "Mother's Maiden Name"
    ],
    "column_redaction_custom_entities": {
      "Mother's Maiden Name": "Mother's maiden name"
    },
    "custom_pii_entities_to_flag": [
      "Mother's Maiden Name"
    ],
    "custom_pii_entities": {
      "Mother's Maiden Name": "Mother's maiden name"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.