<a id="extraction_policy-operations"></a>

# Operações de `extraction_policy`

<!-- i18n: source=docs/reference/operations/extraction_policy.md blob=28a735779ebc56e685a83b284c4e4f5f7f959a2e model=claude-sonnet-5-5 -->
> Esta página é uma tradução automática da [página em inglês](https://github.com/ClickHouse/loom/blob/main/docs/reference/operations/extraction_policy.md), que prevalece.
> Machine-translated from the [English page](https://github.com/ClickHouse/loom/blob/main/docs/reference/operations/extraction_policy.md), which is authoritative.


Os campos exatos que cada operação `extraction_policy.*` recebe e retorna.

<!-- Generated by `python scripts/codegen/docs_reference.py` from the op registry; edit the models, not this page. -->

Toda op é `POST /v1/<op>` via HTTP e a ferramenta MCP `loom_<op>`. Os campos de identidade (`org`, `namespace`, `agent`, `user_id`, `session_id`) são preenchidos a partir do token e da sessão MCP quando o transporte consegue; em uma chamada HTTP sem token em um servidor de usuário único, usa-se a org da instalação em todas as ops, exceto `code.*` e `tracker.*` (que mantêm a do seu plano), e, em [algumas ops](https://github.com/ClickHouse/loom/blob/main/docs/reference/http-api.md#request), o seu namespace e agente; veja [identidades e namespaces](/pt-BR/concepts/identities-and-namespaces). O [índice de operações](https://github.com/ClickHouse/loom/blob/main/docs/reference/operations.md) explica role, kind e a listagem `all` do MCP. Campos de entrada desconhecidos são atendidos e listados em `ignored_args`.

<!-- prettier-ignore-start -->

<a id="extraction_policyclear"></a>

## `extraction_policy.clear`

Remove a política do escopo.

`POST /v1/extraction_policy.clear` · MCP `loom_extraction_policy_clear` · role `org_admin` · idempotente · auditada · não listada no toolset `all` do MCP

| Campo de entrada | Tipo | Padrão | Significado |
| --- | --- | --- | --- |
| `org` | `str` | obrigatório | O tenant (primeiro elemento da tupla de identidade). |
| `scope` | `Literal['org', 'namespace']` | obrigatório | `org` remove a política da própria org; `namespace` remove a desse namespace, mantendo a da org em vigor. |
| `namespace` | `str` | `''` | O namespace cuja política será removida; ignorado para o escopo `org`. |

| Campo de saída | Tipo | Significado |
| --- | --- | --- |
| `org` | `str` | O tenant (primeiro elemento da tupla de identidade). |
| `scope` | `Literal['org', 'namespace']` | `org` ou `namespace`, conforme solicitado. |
| `namespace` | `str` | O namespace para o escopo `namespace`; "" para o escopo `org`. |
| `policy` | `str` | A política deste escopo; "" quando não há nenhuma definida. |
| `updated_by` | `str` | Quem a definiu; "" quando não há nenhuma definida. |
| `updated_at` | `datetime \| None` | Quando foi definida (UTC); None quando não há nenhuma definida. |
| `effective` | `str` | Sob qual política as extrações neste escopo são executadas: a da org, depois a do namespace; "" quando nenhuma das duas está definida. |
| `namespace_policies` | `list[NamespacePolicy]` | Para o escopo `org`: todo namespace da org que possui uma política própria, por nome, incluindo a de um namespace excluído, que continua contando para LOOM_EXTRACTION_POLICY_MAX_NAMESPACES até ser removida. |

<a id="extraction_policyget"></a>

## `extraction_policy.get`

A política do escopo e aquela sob a qual suas extrações são executadas.

`POST /v1/extraction_policy.get` · MCP `loom_extraction_policy_get` · role `org_admin` · idempotente · não listada no toolset `all` do MCP

| Campo de entrada | Tipo | Padrão | Significado |
| --- | --- | --- | --- |
| `org` | `str` | obrigatório | O tenant (primeiro elemento da tupla de identidade). |
| `scope` | `Literal['org', 'namespace']` | obrigatório | `org` lê a política da própria org; `namespace` lê a de `namespace`. |
| `namespace` | `str` | `''` | O namespace cuja política será lida; ignorado para o escopo `org`. |

| Campo de saída | Tipo | Significado |
| --- | --- | --- |
| `org` | `str` | O tenant (primeiro elemento da tupla de identidade). |
| `scope` | `Literal['org', 'namespace']` | `org` ou `namespace`, conforme solicitado. |
| `namespace` | `str` | O namespace para o escopo `namespace`; "" para o escopo `org`. |
| `policy` | `str` | A política deste escopo; "" quando não há nenhuma definida. |
| `updated_by` | `str` | Quem a definiu; "" quando não há nenhuma definida. |
| `updated_at` | `datetime \| None` | Quando foi definida (UTC); None quando não há nenhuma definida. |
| `effective` | `str` | Sob qual política as extrações neste escopo são executadas: a da org, depois a do namespace; "" quando nenhuma das duas está definida. |
| `namespace_policies` | `list[NamespacePolicy]` | Para o escopo `org`: todo namespace da org que possui uma política própria, por nome, incluindo a de um namespace excluído, que continua contando para LOOM_EXTRACTION_POLICY_MAX_NAMESPACES até ser removida. |

<a id="extraction_policyset"></a>

## `extraction_policy.set`

Define a política do escopo, substituindo a que ele tinha.

`POST /v1/extraction_policy.set` · MCP `loom_extraction_policy_set` · role `org_admin` · idempotente · auditada · não listada no toolset `all` do MCP

| Campo de entrada | Tipo | Padrão | Significado |
| --- | --- | --- | --- |
| `org` | `str` | obrigatório | O tenant (primeiro elemento da tupla de identidade). |
| `scope` | `Literal['org', 'namespace']` | obrigatório | `org` define a política da própria org, que todo namespace segue (`namespace` é ignorado); `namespace` define as regras que esse namespace acrescenta a ela. |
| `namespace` | `str` | `''` | O namespace ao qual uma política de escopo `namespace` se destina; ignorado para o escopo `org`. |
| `policy` | `str` | obrigatório | As regras em linguagem simples, no máximo 4,096 caracteres; substitui a política do escopo. |

| Campo de saída | Tipo | Significado |
| --- | --- | --- |
| `org` | `str` | O tenant (primeiro elemento da tupla de identidade). |
| `scope` | `Literal['org', 'namespace']` | `org` ou `namespace`, conforme solicitado. |
| `namespace` | `str` | O namespace para o escopo `namespace`; "" para o escopo `org`. |
| `policy` | `str` | A política deste escopo; "" quando não há nenhuma definida. |
| `updated_by` | `str` | Quem a definiu; "" quando não há nenhuma definida. |
| `updated_at` | `datetime \| None` | Quando foi definida (UTC); None quando não há nenhuma definida. |
| `effective` | `str` | Sob qual política as extrações neste escopo são executadas: a da org, depois a do namespace; "" quando nenhuma das duas está definida. |
| `namespace_policies` | `list[NamespacePolicy]` | Para o escopo `org`: todo namespace da org que possui uma política própria, por nome, incluindo a de um namespace excluído, que continua contando para LOOM_EXTRACTION_POLICY_MAX_NAMESPACES até ser removida. |

<!-- prettier-ignore-end -->
