usecortex-ai 0.3.6__py3-none-any.whl → 0.4.0__py3-none-any.whl

usecortex_ai/types/memory_item.py

@@ -0,0 +1,82 @@
+# 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 .user_assistant_pair import UserAssistantPair
+
+
+class MemoryItem(UniversalBaseModel):
+    """
+    Represents a single memory item for ingestion.
+    Supports raw text, markdown, and user/assistant conversation pairs.
+    """
+
+    source_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Optional unique identifier. Auto-generated if not provided.
+    """
+
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Display title for this memory item.
+    """
+
+    text: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Raw text or markdown content to be indexed.
+    """
+
+    user_assistant_pairs: typing.Optional[typing.List[UserAssistantPair]] = pydantic.Field(default=None)
+    """
+    Array of user/assistant conversation pairs to store as memory.
+    """
+
+    is_markdown: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the text is markdown formatted.
+    """
+
+    infer: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If true, process and extract additional insights/inferences from the content before indexing. Useful for extracting implicit information from conversations.
+    """
+
+    custom_instructions: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Custom instructions to guide inference processing.
+    """
+
+    user_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    User's name for personalization in conversation pairs.
+    """
+
+    expiry_time: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Optional TTL in seconds for this memory.
+    """
+
+    tenant_metadata: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+    
+    Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+    """
+
+    document_metadata: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+    
+    Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+    """
+
+    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

usecortex_ai/types/memory_result_item.py

@@ -0,0 +1,47 @@
+# 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 .source_status import SourceStatus
+
+
+class MemoryResultItem(UniversalBaseModel):
+    """
+    Result for a single ingested memory item.
+    """
+
+    source_id: str = pydantic.Field()
+    """
+    Unique identifier for the ingested source.
+    """
+
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Title of the memory if provided.
+    """
+
+    status: typing.Optional[SourceStatus] = pydantic.Field(default=None)
+    """
+    Initial processing status.
+    """
+
+    infer: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether inference was requested for this memory.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message if ingestion failed.
+    """
+
+    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

usecortex_ai/types/milvus_data_type.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+MilvusDataType = typing.Union[
+    typing.Literal[
+        "BOOL",
+        "INT8",
+        "INT16",
+        "INT32",
+        "INT64",
+        "FLOAT",
+        "DOUBLE",
+        "VARCHAR",
+        "JSON",
+        "ARRAY",
+        "FLOAT_VECTOR",
+        "SPARSE_FLOAT_VECTOR",
+    ],
+    typing.Any,
+]

usecortex_ai/types/path_triplet.py

@@ -9,24 +9,9 @@ from .relation_evidence import RelationEvidence
 
 
 class PathTriplet(UniversalBaseModel):
-    """
-    Single triplet within a path (without score, as the path is scored as a whole)
-    """
-
-    source: Entity = pydantic.Field()
-    """
-    Source entity
-    """
-
-    target: Entity = pydantic.Field()
-    """
-    Target entity
-    """
-
-    relation: RelationEvidence = pydantic.Field()
-    """
-    Relation between entities
-    """
+    source: Entity
+    relation: RelationEvidence
+    target: Entity
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/processing_status.py

@@ -4,6 +4,7 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .processing_status_indexing_status import ProcessingStatusIndexingStatus
 
 
 class ProcessingStatus(UniversalBaseModel):
@@ -12,9 +13,9 @@ class ProcessingStatus(UniversalBaseModel):
     Identifier for the file whose status is being retrieved
     """
 
-    indexing_status: str = pydantic.Field()
+    indexing_status: ProcessingStatusIndexingStatus = pydantic.Field()
     """
-    Current status of the file. Possible values are 'queued', 'processing', 'completed', 'errored'
+    Current status of the file. Possible values are 'queued', 'processing', 'completed', 'errored', 'graph_creation', 'success'. 'graph_creation' indicates the file is indexed but the knowledge graph is still being created. 'success' is an alias for 'completed'.
     """
 
     error_code: typing.Optional[str] = pydantic.Field(default=None)

usecortex_ai/types/processing_status_indexing_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProcessingStatusIndexingStatus = typing.Union[
+    typing.Literal["queued", "processing", "completed", "errored", "graph_creation", "success"], typing.Any
+]

usecortex_ai/types/qn_a_search_response.py

@@ -0,0 +1,49 @@
+# 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 .graph_context import GraphContext
+from .vector_store_chunk import VectorStoreChunk
+
+
+class QnASearchResponse(UniversalBaseModel):
+    """
+    Response model for the QnA search API.
+    """
+
+    success: typing.Optional[bool] = None
+    answer: str = pydantic.Field()
+    """
+    The AI-generated answer based on retrieved context
+    """
+
+    chunks: typing.Optional[typing.List[VectorStoreChunk]] = pydantic.Field(default=None)
+    """
+    Retrieved context chunks used to generate the answer
+    """
+
+    graph_context: typing.Optional[GraphContext] = pydantic.Field(default=None)
+    """
+    Knowledge graph context (entity paths and chunk relations)
+    """
+
+    model_used: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The LLM model used for answer generation
+    """
+
+    timing: typing.Optional[typing.Dict[str, float]] = pydantic.Field(default=None)
+    """
+    Timing information (retrieval_ms, answer_generation_ms, total_ms)
+    """
+
+    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

usecortex_ai/types/{retrieve_response.py → raw_embedding_document.py}

@@ -4,24 +4,27 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .chunk_graph_relations_response import ChunkGraphRelationsResponse
-from .search_chunk import SearchChunk
+from .raw_embedding_vector import RawEmbeddingVector
 
 
-class RetrieveResponse(UniversalBaseModel):
-    chunks: typing.Optional[typing.List[SearchChunk]] = pydantic.Field(default=None)
+class RawEmbeddingDocument(UniversalBaseModel):
     """
-    Retrieved content chunks
+    A raw embedding document for direct insert/upsert operations.
     """
 
-    graph_relations: typing.Optional[ChunkGraphRelationsResponse] = pydantic.Field(default=None)
+    source_id: str = pydantic.Field()
     """
-    Graph relations with chunk_relations (by chunk_id) and entity_relations (top entity matches)
+    Source identifier for the embedding
     """
 
     metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
     """
-    Additional metadata about the retrieval run
+    Metadata to store
+    """
+
+    embeddings: typing.List[RawEmbeddingVector] = pydantic.Field()
+    """
+    Embedding payloads containing ids and vectors
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/raw_embedding_search_result.py

@@ -0,0 +1,47 @@
+# 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 .raw_embedding_vector import RawEmbeddingVector
+
+
+class RawEmbeddingSearchResult(UniversalBaseModel):
+    """
+    Search result for raw embedding collections.
+    """
+
+    source_id: str = pydantic.Field()
+    """
+    Source identifier
+    """
+
+    embedding: typing.Optional[RawEmbeddingVector] = pydantic.Field(default=None)
+    """
+    Embedding payload with chunk id and vector (if set)
+    """
+
+    score: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Similarity score
+    """
+
+    distance: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Vector distance
+    """
+
+    metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Metadata associated with the embedding
+    """
+
+    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

usecortex_ai/types/{user_memory.py → raw_embedding_vector.py}

@@ -6,19 +6,19 @@ import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class UserMemory(UniversalBaseModel):
+class RawEmbeddingVector(UniversalBaseModel):
     """
-    Represents a user memory stored in the system.
+    Embedding payload containing the chunk identifier and vector.
     """
 
-    memory_id: str = pydantic.Field()
+    chunk_id: str = pydantic.Field()
     """
-    Unique identifier for the user memory
+    Primary key / chunk identifier
     """
 
-    memory_content: str = pydantic.Field()
+    embedding: typing.List[float] = pydantic.Field()
     """
-    The actual memory content text that was stored
+    Embedding vector
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/relation_evidence.py

@@ -8,9 +8,8 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class RelationEvidence(UniversalBaseModel):
-    relationship_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Unique identifier for this specific relationship edge in the graph. The combination of source entity, target entity, and relationship_id allows disambiguation between multiple relations between the same source and target entities.
+    Single piece of evidence for a relationship between two entities
     """
 
     canonical_predicate: str = pydantic.Field()
@@ -28,19 +27,39 @@ class RelationEvidence(UniversalBaseModel):
     Rich contextual description of the relationship with surrounding information, details about how/why/when, and any relevant background. Should be comprehensive enough to understand the relationship without referring back to source.
     """
 
+    confidence: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Confidence score
+    """
+
     temporal_details: typing.Optional[str] = pydantic.Field(default=None)
     """
     Temporal timing information extracted from text (e.g., 'last week', 'in 2023', 'yesterday')
     """
 
+    timestamp: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when this relation was introduced
+    """
+
+    relationship_id: str = pydantic.Field()
+    """
+    Unique ID for this relationship from graph database
+    """
+
     chunk_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    The chunk_id this relation came from
+    ID of the chunk this relation was extracted from
     """
 
-    timestamp: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    source_entity_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Timestamp when this relation was introduced
+    The entity ID of source node
+    """
+
+    target_entity_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The entity ID of target node
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/retrieval_result.py

@@ -0,0 +1,26 @@
+# 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 .graph_context import GraphContext
+from .vector_store_chunk import VectorStoreChunk
+
+
+class RetrievalResult(UniversalBaseModel):
+    """
+    Result of a hybrid search retrieval operation.
+    """
+
+    chunks: typing.Optional[typing.List[VectorStoreChunk]] = None
+    graph_context: typing.Optional[GraphContext] = 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

usecortex_ai/types/scored_path_response.py

@@ -8,26 +8,12 @@ from .path_triplet import PathTriplet
 
 
 class ScoredPathResponse(UniversalBaseModel):
+    triplets: typing.List[PathTriplet]
+    relevancy_score: float
+    combined_context: typing.Optional[str] = None
+    group_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    A multi-hop path (chain of triplets) with a relevancy score.
-
-    Represents connected paths like: A --rel1--> B --rel2--> C
-    The triplets list preserves the chain order.
-    """
-
-    combined_context: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Merged context from all triplets in the path
-    """
-
-    triplets: typing.List[PathTriplet] = pydantic.Field()
-    """
-    Ordered list of triplets forming the path chain
-    """
-
-    relevancy_score: typing.Optional[float] = pydantic.Field(default=None)
-    """
-    Relevancy score for the entire path
+    Path group identifier (e.g., 'p_0') for chunk mapping
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/search_mode.py

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

usecortex_ai/types/{batch_upload_data.py → source_delete_response.py}

@@ -4,22 +4,22 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .file_upload_result import FileUploadResult
+from .source_delete_result_item import SourceDeleteResultItem
 
 
-class BatchUploadData(UniversalBaseModel):
-    uploaded: typing.List[FileUploadResult] = pydantic.Field()
+class SourceDeleteResponse(UniversalBaseModel):
     """
-    List of successfully uploaded files for processing
+    Response for delete request.
     """
 
-    message: str = pydantic.Field()
+    success: typing.Optional[bool] = None
+    message: typing.Optional[str] = None
+    results: typing.Optional[typing.List[SourceDeleteResultItem]] = None
+    deleted_count: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Status message indicating batch document parsing scheduled
+    Number of sources deleted.
     """
 
-    success: typing.Optional[bool] = None
-
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

usecortex_ai/types/{list_user_memories_response.py → source_delete_result_item.py}

@@ -4,22 +4,26 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .user_memory import UserMemory
 
 
-class ListUserMemoriesResponse(UniversalBaseModel):
+class SourceDeleteResultItem(UniversalBaseModel):
     """
-    Response model for listing all user memories.
+    Result for a single source deletion.
     """
 
-    success: bool = pydantic.Field()
+    source_id: str = pydantic.Field()
     """
-    Indicates whether the memory listing operation was successful
+    ID of the source.
     """
 
-    user_memories: typing.Optional[typing.List[UserMemory]] = pydantic.Field(default=None)
+    deleted: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Array of all user memories associated with your tenant
+    Whether deletion succeeded.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message if deletion failed.
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/source_fetch_response.py

@@ -0,0 +1,70 @@
+# 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 SourceFetchResponse(UniversalBaseModel):
+    """
+    Response for file fetch request.
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the fetch was successful
+    """
+
+    source_id: str = pydantic.Field()
+    """
+    Source ID of the fetched file
+    """
+
+    content: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    File content as string (if mode includes 'content')
+    """
+
+    content_base_64: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="content_base64")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    File content as base64 encoded string (for binary files, if mode includes 'content')
+    """
+
+    presigned_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Presigned URL to access the file (if mode includes 'url')
+    """
+
+    content_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Content type of the file
+    """
+
+    size_bytes: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Size of the file in bytes
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Response message
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message if fetch failed
+    """
+
+    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

usecortex_ai/types/{graph_relations_response.py → source_graph_relations_response.py}

@@ -4,11 +4,11 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .triple_with_evidence import TripleWithEvidence
+from .triplet_with_evidence import TripletWithEvidence
 
 
-class GraphRelationsResponse(UniversalBaseModel):
-    relations: typing.List[typing.Optional[TripleWithEvidence]] = pydantic.Field()
+class SourceGraphRelationsResponse(UniversalBaseModel):
+    relations: typing.List[typing.Optional[TripletWithEvidence]] = pydantic.Field()
     """
     List of relations retrieved
     """