nucliadb-models 6.2.1.post3316__py3-none-any.whl → 6.2.1.post3326__py3-none-any.whl

nucliadb_models/agents/ingestion.py

@@ -0,0 +1,96 @@
+# Copyright (C) 2021 Bosutech XXI S.L.
+#
+# nucliadb is offered under the AGPL v3.0 and as commercial software.
+# For commercial licensing, contact us at info@nuclia.com.
+#
+# AGPL:
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+from nucliadb_models.common import QuestionAnswers
+from nucliadb_models.extracted import FieldMetadata
+from nucliadb_models.text import FieldText
+
+
+class AgentType(Enum):
+    graph = "graph"
+    label = "label"
+    ask = "ask"
+    qa = "qa"
+    extract = "extract"
+    prompt_guard = "prompt_guard"
+    llama_guard = "llama_guard"
+
+
+class AgentsFilter(BaseModel):
+    type: AgentType
+    task_names: list[str] = Field(
+        default_factory=list,
+        description="list of task names. If None or empty, all tasks for that operation are applied.",
+    )
+
+
+class ResourceAgentsRequest(BaseModel):
+    filters: Optional[list[AgentsFilter]] = Field(
+        default=None,
+        description="Filters to apply to the agents. If None, all curently configured agents are applied.",
+    )
+
+
+class NewTextField(BaseModel):
+    text_field: FieldText
+    destination: str
+
+
+class AppliedDataAugmentation(BaseModel):
+    qas: Optional[QuestionAnswers] = Field(
+        default=None,
+        description="Question and answers generated by the Question Answers agent",
+    )
+    new_text_fields: list[NewTextField] = Field(
+        default_factory=list,
+        description="New text fields. Only generated by the Generator agent as of now.",
+    )
+    changed: bool = Field(
+        default=True,
+        description="Indicates if the FieldMetadata was changed by the agents",
+    )
+
+
+class AugmentedField(BaseModel):
+    metadata: FieldMetadata = Field(
+        ...,
+        title="The updated metadata of the field",
+    )
+    applied_data_augmentation: AppliedDataAugmentation = Field(
+        ..., title="The results of the Applied Data Augmentation"
+    )
+    input_nuclia_tokens: float = Field(
+        ..., title="The number of input Nuclia tokens consumed for the field"
+    )
+    output_nuclia_tokens: float = Field(
+        ..., title="The number of output Nuclia tokens consumed for the field"
+    )
+    time: float = Field(..., title="The time taken to execute the Data Augmentation agents to the field")
+
+
+class ResourceAgentsResponse(BaseModel):
+    results: dict[str, AugmentedField] = Field(
+        ...,
+        title="Pairs of augmented FieldMetadata and Data Augmentation results by field id",
+    )

{nucliadb_models-6.2.1.post3316.dist-info → nucliadb_models-6.2.1.post3326.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: nucliadb_models
-Version: 6.2.1.post3316
+Version: 6.2.1.post3326
 Author-email: Nuclia <nucliadb@nuclia.com>
 License: AGPL
 Project-URL: Homepage, https://nuclia.com

{nucliadb_models-6.2.1.post3316.dist-info → nucliadb_models-6.2.1.post3326.dist-info}/RECORD

@@ -24,10 +24,11 @@ nucliadb_models/utils.py,sha256=ndsLMxu9XWvJcCTT-1THJasr3EfZVAx2JtxmcU6F7mA,2651
 nucliadb_models/vectors.py,sha256=hDrvUag4WpmQkM8rN5v868IlKSNpVc9OEddJxaxuYws,748
 nucliadb_models/vectorsets.py,sha256=avxwO9JPX2k5sCniuNhh2MSsP7aRNvf1eB1-h3-Ju1o,1040
 nucliadb_models/writer.py,sha256=OLtCGmicpVf56pXi2_myTAvStpnaBKKOVNtZzHkKKtw,8472
+nucliadb_models/agents/ingestion.py,sha256=mV7gV6VpYg4VNpc59K3275TMUJZbUzeUnp3SZzO5uxY,3137
 nucliadb_models/internal/__init__.py,sha256=cp15ZcFnHvpcu_5-aK2A4uUyvuZVV_MJn4bIXMa20ks,835
 nucliadb_models/internal/predict.py,sha256=5rgUPrH_98gerySOZ-TR2PX_qzCGF1_8VxyOu3bGhis,2281
 nucliadb_models/internal/shards.py,sha256=uZLsMkYWrJDHq3xy_w7snSeV2X3aDBuht9GC_MG3sKc,1976
-nucliadb_models-6.2.1.post3316.dist-info/METADATA,sha256=qjGl-82ybCrasNGYbh2wk_42JLtIhF88JvWY5tvHDhg,759
-nucliadb_models-6.2.1.post3316.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-nucliadb_models-6.2.1.post3316.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
-nucliadb_models-6.2.1.post3316.dist-info/RECORD,,
+nucliadb_models-6.2.1.post3326.dist-info/METADATA,sha256=YXTdL1guOZOWK__8lJQ5cph3mCbBJ3c0B4MyeVbZM20,759
+nucliadb_models-6.2.1.post3326.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+nucliadb_models-6.2.1.post3326.dist-info/top_level.txt,sha256=UrY1I8oeovIRwkXLYplssTrxQdUjhSEFDFbnwaIV3tA,16
+nucliadb_models-6.2.1.post3326.dist-info/RECORD,,