groundx 2.0.15__py3-none-any.whl → 2.7.7__py3-none-any.whl

groundx/types/{process_status_response_ingest_progress_processing.py → ingest_status_progress_processing.py}

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .document_detail import DocumentDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .document_detail import DocumentDetail
 
 
-class ProcessStatusResponseIngestProgressProcessing(UniversalBaseModel):
+class IngestStatusProgressProcessing(UniversalBaseModel):
     documents: typing.Optional[typing.List[DocumentDetail]] = None
     total: typing.Optional[int] = None
 

groundx/types/message_response.py

@@ -1,9 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class MessageResponse(UniversalBaseModel):

groundx/types/meter_detail.py

@@ -1,11 +1,11 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
+
 import pydantic
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class MeterDetail(UniversalBaseModel):

groundx/types/process_level.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProcessLevel = typing.Union[typing.Literal["none", "full"], typing.Any]

groundx/types/{process_status_response.py → processes_status_response.py}

@@ -1,14 +1,17 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-from .process_status_response_ingest import ProcessStatusResponseIngest
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .ingest_status_light import IngestStatusLight
 
 
-class ProcessStatusResponse(UniversalBaseModel):
-    ingest: ProcessStatusResponseIngest
+class ProcessesStatusResponse(UniversalBaseModel):
+    processes: typing.List[IngestStatusLight] = pydantic.Field()
+    """
+    Processes
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

groundx/types/processing_status.py

@@ -2,4 +2,6 @@
 
 import typing
 
-ProcessingStatus = typing.Union[typing.Literal["queued", "processing", "error", "complete", "cancelled"], typing.Any]
+ProcessingStatus = typing.Union[
+    typing.Literal["queued", "processing", "error", "complete", "cancelled", "active", "inactive"], typing.Any
+]

groundx/types/search_response.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-from .search_response_search import SearchResponseSearch
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .search_response_search import SearchResponseSearch
 
 
 class SearchResponse(UniversalBaseModel):

groundx/types/search_response_search.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
+
 import pydantic
-from .search_result_item import SearchResultItem
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from .search_result_item import SearchResultItem
 
 
 class SearchResponseSearch(UniversalBaseModel):

groundx/types/search_result_item.py

@@ -1,12 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
 import typing
-from .bounding_box_detail import BoundingBoxDetail
-from ..core.serialization import FieldMetadata
+
 import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .bounding_box_detail import BoundingBoxDetail
+from .search_result_item_pages_item import SearchResultItemPagesItem
 
 
 class SearchResultItem(UniversalBaseModel):
@@ -55,6 +56,7 @@ class SearchResultItem(UniversalBaseModel):
     page_images: typing_extensions.Annotated[typing.Optional[typing.List[str]], FieldMetadata(alias="pageImages")] = (
         None
     )
+    pages: typing.Optional[typing.List[SearchResultItemPagesItem]] = None
     score: typing.Optional[float] = pydantic.Field(default=None)
     """
     Confidence score in the search result

groundx/types/search_result_item_pages_item.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class SearchResultItemPagesItem(UniversalBaseModel):
+    height: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The height of the page image
+    """
+
+    image_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="imageUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    A jpg of the page the chunk appears on
+    """
+
+    number: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The page number
+    """
+
+    width: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The width of the page image
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/subscription_detail.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .subscription_detail_meters import SubscriptionDetailMeters
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .subscription_detail_meters import SubscriptionDetailMeters
 
 
 class SubscriptionDetail(UniversalBaseModel):

groundx/types/subscription_detail_meters.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
 import typing
-from .meter_detail import MeterDetail
-from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .meter_detail import MeterDetail
 
 
 class SubscriptionDetailMeters(UniversalBaseModel):

groundx/{documents/types/website_crawl_request_websites_item.py → types/website_source.py}

@@ -1,17 +1,17 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
-from ...core.serialization import FieldMetadata
-import pydantic
 import typing
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
 
 
-class WebsiteCrawlRequestWebsitesItem(UniversalBaseModel):
+class WebsiteSource(UniversalBaseModel):
     bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")] = pydantic.Field()
     """
-    the bucketId of the bucket which this website will be ingested to.
+    The bucketId of the bucket which this website will be ingested into.
     """
 
     cap: typing.Optional[int] = pydantic.Field(default=None)

groundx/types/workflow_apply_request.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class WorkflowApplyRequest(UniversalBaseModel):
+    workflow_id: typing_extensions.Annotated[str, FieldMetadata(alias="workflowId")] = pydantic.Field()
+    """
+    The id of the workflow that is being applied.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_detail.py

@@ -0,0 +1,59 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .workflow_detail_chunk_strategy import WorkflowDetailChunkStrategy
+from .workflow_detail_relationships import WorkflowDetailRelationships
+from .workflow_steps import WorkflowSteps
+
+
+class WorkflowDetail(UniversalBaseModel):
+    """
+    Workflow information
+    """
+
+    chunk_strategy: typing_extensions.Annotated[
+        typing.Optional[WorkflowDetailChunkStrategy], FieldMetadata(alias="chunkStrategy")
+    ] = None
+    document_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="documentId")] = pydantic.Field(
+        default=None
+    )
+    """
+    The documentId associated with the workflow
+    """
+
+    id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The bucketId or groupId associated with the workflow
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The human-readable name of the workflow
+    """
+
+    steps: typing.Optional[WorkflowSteps] = None
+    relationships: typing.Optional[WorkflowDetailRelationships] = pydantic.Field(default=None)
+    """
+    Information describing what the workflow is associated with
+    """
+
+    workflow_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="workflowId")] = pydantic.Field(
+        default=None
+    )
+    """
+    Unique system generated ID for the workflow
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_detail_chunk_strategy.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+WorkflowDetailChunkStrategy = typing.Union[typing.Literal["element", "size"], typing.Any]

groundx/types/workflow_detail_relationships.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class WorkflowDetailRelationships(UniversalBaseModel):
+    """
+    Information describing what the workflow is associated with
+    """
+
+    account: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    A boolean indicating whether the workflow is associated with the account
+    """
+
+    documents: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    An array of documentIds associated with the workflow
+    """
+
+    ids: typing.Optional[typing.List[int]] = pydantic.Field(default=None)
+    """
+    An array of bucketIds or groupIds associated with the workflow
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_engine.py

@@ -0,0 +1,58 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .workflow_engine_reasoning_effort import WorkflowEngineReasoningEffort
+from .workflow_engine_service import WorkflowEngineService
+
+
+class WorkflowEngine(UniversalBaseModel):
+    """
+    Configurations for the LLM an agent uses in a workflow
+    """
+
+    api_key: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="apiKey")] = pydantic.Field(
+        default=None
+    )
+    """
+    A token that is added to the header of a request as an authorization bearer token
+    """
+
+    base_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="baseURL")] = pydantic.Field(
+        default=None
+    )
+    """
+    The base URL that precedes '/chat/completion' for an OpenAI chat completion-compatible endpoint
+    """
+
+    engine_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="engineID")] = pydantic.Field(
+        default=None
+    )
+    """
+    The model name that will be included in the request
+    """
+
+    reasoning_effort: typing_extensions.Annotated[
+        typing.Optional[WorkflowEngineReasoningEffort], FieldMetadata(alias="reasoningEffort")
+    ] = pydantic.Field(default=None)
+    """
+    An enumerated value that conforms to OpenAI '/chat/completion' specifications
+    """
+
+    service: typing.Optional[WorkflowEngineService] = pydantic.Field(default=None)
+    """
+    An enumerated descriptor of the service type, impacts how the requests are configured
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_engine_reasoning_effort.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+WorkflowEngineReasoningEffort = typing.Union[typing.Literal["minimal", "low", "medium", "high"], typing.Any]

groundx/types/workflow_engine_service.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+WorkflowEngineService = typing.Union[
+    typing.Literal["openai", "openai-base64", "azure", "deep-infra", "hosted"], typing.Any
+]

groundx/types/workflow_prompt.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_prompt_role import WorkflowPromptRole
+
+
+class WorkflowPrompt(UniversalBaseModel):
+    """
+    Configurations for the prompt an agent uses in a workflow
+    """
+
+    abbreviated: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    A short version of the prompt that is included in historical chat transcripts as part of the prompt context
+    """
+
+    prompt: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The prompt that is sent to the LLM
+    """
+
+    role: typing.Optional[WorkflowPromptRole] = pydantic.Field(default=None)
+    """
+    An enumerated value that conforms to OpenAI '/chat/completion' specifications
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_prompt_group.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_prompt import WorkflowPrompt
+
+
+class WorkflowPromptGroup(UniversalBaseModel):
+    """
+    A grouping of system task and request prompts
+    """
+
+    request: typing.Optional[WorkflowPrompt] = None
+    task: typing.Optional[WorkflowPrompt] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_prompt_role.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+WorkflowPromptRole = typing.Union[typing.Literal["assistant", "developer", "system", "user"], typing.Any]

groundx/types/workflow_request.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .workflow_request_chunk_strategy import WorkflowRequestChunkStrategy
+from .workflow_steps import WorkflowSteps
+
+
+class WorkflowRequest(UniversalBaseModel):
+    chunk_strategy: typing_extensions.Annotated[
+        typing.Optional[WorkflowRequestChunkStrategy], FieldMetadata(alias="chunkStrategy")
+    ] = None
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the workflow being created.
+    """
+
+    steps: typing.Optional[WorkflowSteps] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_request_chunk_strategy.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+WorkflowRequestChunkStrategy = typing.Union[typing.Literal["element", "size"], typing.Any]

groundx/types/workflow_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_detail import WorkflowDetail
+
+
+class WorkflowResponse(UniversalBaseModel):
+    workflow: WorkflowDetail
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_step.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .workflow_step_config import WorkflowStepConfig
+
+
+class WorkflowStep(UniversalBaseModel):
+    """
+    Configurations for an agent, including LLM information and prompts
+    """
+
+    all_: typing_extensions.Annotated[typing.Optional[WorkflowStepConfig], FieldMetadata(alias="all")] = None
+    figure: typing.Optional[WorkflowStepConfig] = None
+    json_: typing_extensions.Annotated[typing.Optional[WorkflowStepConfig], FieldMetadata(alias="json")] = None
+    paragraph: typing.Optional[WorkflowStepConfig] = None
+    table: typing.Optional[WorkflowStepConfig] = None
+    table_figure: typing_extensions.Annotated[
+        typing.Optional[WorkflowStepConfig], FieldMetadata(alias="table-figure")
+    ] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_step_config.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_engine import WorkflowEngine
+from .workflow_prompt_group import WorkflowPromptGroup
+from .workflow_step_config_field import WorkflowStepConfigField
+
+
+class WorkflowStepConfig(UniversalBaseModel):
+    """
+    Configurations for an agent, including LLM information and prompts
+    """
+
+    engine: typing.Optional[WorkflowEngine] = None
+    field: typing.Optional[WorkflowStepConfigField] = pydantic.Field(default=None)
+    """
+    The field where agent output will be saved
+    """
+
+    includes: typing.Optional[typing.Dict[str, bool]] = None
+    prompt: typing.Optional[WorkflowPromptGroup] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/workflow_step_config_field.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+WorkflowStepConfigField = typing.Union[
+    typing.Literal["doc-sum", "doc-keys", "sect-sum", "sect-keys", "chunk-sum", "chunk-keys", "chunk-instruct", "text"],
+    typing.Any,
+]