vellum-ai 0.6.5__py3-none-any.whl → 0.6.6__py3-none-any.whl

vellum/__init__.py

@@ -295,6 +295,9 @@ from .types import (
     PaginatedSlimWorkflowDeploymentList,
     PaginatedTestSuiteRunExecutionList,
     PaginatedTestSuiteTestCaseList,
+    PdfEnum,
+    PdfSearchResultMetaSource,
+    PdfSearchResultMetaSourceRequest,
     ProcessingFailureReasonEnum,
     ProcessingStateEnum,
     PromptDeploymentExpandMetaRequestRequest,
@@ -341,6 +344,12 @@ from .types import (
     SearchResultDocument,
     SearchResultDocumentRequest,
     SearchResultMergingRequest,
+    SearchResultMeta,
+    SearchResultMetaRequest,
+    SearchResultMetaSource,
+    SearchResultMetaSourceRequest,
+    SearchResultMetaSourceRequest_Pdf,
+    SearchResultMetaSource_Pdf,
     SearchResultRequest,
     SearchResultsEnum,
     SearchWeightsRequest,
@@ -915,6 +924,9 @@ __all__ = [
     "PaginatedSlimWorkflowDeploymentList",
     "PaginatedTestSuiteRunExecutionList",
     "PaginatedTestSuiteTestCaseList",
+    "PdfEnum",
+    "PdfSearchResultMetaSource",
+    "PdfSearchResultMetaSourceRequest",
     "ProcessingFailureReasonEnum",
     "ProcessingStateEnum",
     "PromptDeploymentExpandMetaRequestRequest",
@@ -961,6 +973,12 @@ __all__ = [
     "SearchResultDocument",
     "SearchResultDocumentRequest",
     "SearchResultMergingRequest",
+    "SearchResultMeta",
+    "SearchResultMetaRequest",
+    "SearchResultMetaSource",
+    "SearchResultMetaSourceRequest",
+    "SearchResultMetaSourceRequest_Pdf",
+    "SearchResultMetaSource_Pdf",
     "SearchResultRequest",
     "SearchResultsEnum",
     "SearchWeightsRequest",

vellum/core/client_wrapper.py

@@ -18,7 +18,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "0.6.5",
+            "X-Fern-SDK-Version": "0.6.6",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

vellum/types/__init__.py

@@ -342,6 +342,9 @@ from .paginated_slim_document_list import PaginatedSlimDocumentList
 from .paginated_slim_workflow_deployment_list import PaginatedSlimWorkflowDeploymentList
 from .paginated_test_suite_run_execution_list import PaginatedTestSuiteRunExecutionList
 from .paginated_test_suite_test_case_list import PaginatedTestSuiteTestCaseList
+from .pdf_enum import PdfEnum
+from .pdf_search_result_meta_source import PdfSearchResultMetaSource
+from .pdf_search_result_meta_source_request import PdfSearchResultMetaSourceRequest
 from .processing_failure_reason_enum import ProcessingFailureReasonEnum
 from .processing_state_enum import ProcessingStateEnum
 from .prompt_deployment_expand_meta_request_request import PromptDeploymentExpandMetaRequestRequest
@@ -390,6 +393,10 @@ from .search_result import SearchResult
 from .search_result_document import SearchResultDocument
 from .search_result_document_request import SearchResultDocumentRequest
 from .search_result_merging_request import SearchResultMergingRequest
+from .search_result_meta import SearchResultMeta
+from .search_result_meta_request import SearchResultMetaRequest
+from .search_result_meta_source import SearchResultMetaSource, SearchResultMetaSource_Pdf
+from .search_result_meta_source_request import SearchResultMetaSourceRequest, SearchResultMetaSourceRequest_Pdf
 from .search_result_request import SearchResultRequest
 from .search_results_enum import SearchResultsEnum
 from .search_weights_request import SearchWeightsRequest
@@ -974,6 +981,9 @@ __all__ = [
     "PaginatedSlimWorkflowDeploymentList",
     "PaginatedTestSuiteRunExecutionList",
     "PaginatedTestSuiteTestCaseList",
+    "PdfEnum",
+    "PdfSearchResultMetaSource",
+    "PdfSearchResultMetaSourceRequest",
     "ProcessingFailureReasonEnum",
     "ProcessingStateEnum",
     "PromptDeploymentExpandMetaRequestRequest",
@@ -1020,6 +1030,12 @@ __all__ = [
     "SearchResultDocument",
     "SearchResultDocumentRequest",
     "SearchResultMergingRequest",
+    "SearchResultMeta",
+    "SearchResultMetaRequest",
+    "SearchResultMetaSource",
+    "SearchResultMetaSourceRequest",
+    "SearchResultMetaSourceRequest_Pdf",
+    "SearchResultMetaSource_Pdf",
     "SearchResultRequest",
     "SearchResultsEnum",
     "SearchWeightsRequest",

vellum/types/pdf_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PdfEnum = typing.Literal["PDF"]

vellum/types/pdf_search_result_meta_source.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class PdfSearchResultMetaSource(pydantic_v1.BaseModel):
+    """
+    The source of a search result from a PDF document.
+    """
+
+    start_page_num: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types.
+    """
+
+    end_page_num: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types.
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/pdf_search_result_meta_source_request.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class PdfSearchResultMetaSourceRequest(pydantic_v1.BaseModel):
+    """
+    The source of a search result from a PDF document.
+    """
+
+    start_page_num: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types.
+    """
+
+    end_page_num: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types.
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result.py

@@ -6,6 +6,7 @@ import typing
 from ..core.datetime_utils import serialize_datetime
 from ..core.pydantic_utilities import pydantic_v1
 from .search_result_document import SearchResultDocument
+from .search_result_meta import SearchResultMeta
 
 
 class SearchResult(pydantic_v1.BaseModel):
@@ -25,6 +26,11 @@ class SearchResult(pydantic_v1.BaseModel):
     The document that contains the chunk that matched the search query.
     """
 
+    meta: typing.Optional[SearchResultMeta] = pydantic_v1.Field(default=None)
+    """
+    Additional information about the search result.
+    """
+
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
         return super().json(**kwargs_with_defaults)

vellum/types/search_result_meta.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .search_result_meta_source import SearchResultMetaSource
+
+
+class SearchResultMeta(pydantic_v1.BaseModel):
+    source: SearchResultMetaSource
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result_meta_request.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .search_result_meta_source_request import SearchResultMetaSourceRequest
+
+
+class SearchResultMetaRequest(pydantic_v1.BaseModel):
+    source: SearchResultMetaSourceRequest
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result_meta_source.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from .pdf_search_result_meta_source import PdfSearchResultMetaSource
+
+
+class SearchResultMetaSource_Pdf(PdfSearchResultMetaSource):
+    document_type: typing.Literal["PDF"] = "PDF"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+SearchResultMetaSource = typing.Union[SearchResultMetaSource_Pdf]

vellum/types/search_result_meta_source_request.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from .pdf_search_result_meta_source_request import PdfSearchResultMetaSourceRequest
+
+
+class SearchResultMetaSourceRequest_Pdf(PdfSearchResultMetaSourceRequest):
+    document_type: typing.Literal["PDF"] = "PDF"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+SearchResultMetaSourceRequest = typing.Union[SearchResultMetaSourceRequest_Pdf]

vellum/types/search_result_request.py

@@ -6,6 +6,7 @@ import typing
 from ..core.datetime_utils import serialize_datetime
 from ..core.pydantic_utilities import pydantic_v1
 from .search_result_document_request import SearchResultDocumentRequest
+from .search_result_meta_request import SearchResultMetaRequest
 
 
 class SearchResultRequest(pydantic_v1.BaseModel):
@@ -25,6 +26,11 @@ class SearchResultRequest(pydantic_v1.BaseModel):
     The document that contains the chunk that matched the search query.
     """
 
+    meta: typing.Optional[SearchResultMetaRequest] = pydantic_v1.Field(default=None)
+    """
+    Additional information about the search result.
+    """
+
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
         return super().json(**kwargs_with_defaults)

{vellum_ai-0.6.5.dist-info → vellum_ai-0.6.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.6.5
+Version: 0.6.6
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3

{vellum_ai-0.6.5.dist-info → vellum_ai-0.6.6.dist-info}/RECORD

@@ -1,8 +1,8 @@
-vellum/__init__.py,sha256=7aKsuZge9dDZncC299GYskQc1AJ1GUkJ64doEDqHmS4,44855
+vellum/__init__.py,sha256=Gu91YntxNpNqfin3Nksl7cQnB-JxuOX65CVPClG-Wo4,45407
 vellum/client.py,sha256=FklbOzCaDTPP_EQn0HJXUq1_ZFOHuSePt6_nVQ_YLgY,97463
 vellum/core/__init__.py,sha256=1pNSKkwyQvMl_F0wohBqmoQAITptg3zlvCwsoSSzy7c,853
 vellum/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-vellum/core/client_wrapper.py,sha256=qDiIYijRBOToj6MOYVMjrOKpLovjDPs7PkLNsbJSgGM,1697
+vellum/core/client_wrapper.py,sha256=atwV8644mcBgTajVkL1azFJjenaU8WVxc0OOXZo459A,1697
 vellum/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 vellum/core/file.py,sha256=sy1RUGZ3aJYuw998bZytxxo6QdgKmlnlgBaMvwEKCGg,1480
 vellum/core/http_client.py,sha256=5ok6hqgZDJhg57EHvMnr0BBaHdG50QxFPKaCZ9aVWTc,5059
@@ -60,7 +60,7 @@ vellum/terraform/document_index/__init__.py,sha256=qq2zENI22bUvqGk_a1lmsoTr5O_xC
 vellum/terraform/provider/__init__.py,sha256=K1yLlTZkYBxhD4bhUV1v23hxDGgbfsAIGsSyeB54dNQ,10298
 vellum/terraform/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 vellum/terraform/versions.json,sha256=STW6Mg3BKDacFmbWHXziHxE90GWncZf4AIzCLiXm_7o,56
-vellum/types/__init__.py,sha256=m_bPT573NbzP7hGs8Ykc-qbN9XnIT3pSO0Mox1iwH_8,60130
+vellum/types/__init__.py,sha256=-vziB5tUZm3fLSs-t0zN8mHg3oQVV7J6F5e6SkUg1Lo,60913
 vellum/types/add_openai_api_key_enum.py,sha256=GB7sLK_Ou7-Xn73sKJHUo6Gx3TjyhU7uJvWZAg4UeaI,92
 vellum/types/api_node_result.py,sha256=SvYIi1T-N_P3FVjzv9I91PaCT0IN958A3easp5Q7jqE,983
 vellum/types/api_node_result_data.py,sha256=KFBmmizcEg73GwQMXUtEdJ4e9YGFpRLYAnalwxIcDug,1161
@@ -253,6 +253,9 @@ vellum/types/paginated_slim_document_list.py,sha256=L8RyvP1ADem7HUnNjDr4KyoQjIJt
 vellum/types/paginated_slim_workflow_deployment_list.py,sha256=1NfPIuU_NgWgJsXcUpCBtOPj7MqZlblbcCXCjzGXwWc,1111
 vellum/types/paginated_test_suite_run_execution_list.py,sha256=mVhD_un8RCqnJbH9yWliNQPf5E3C0jcH0ManhH6gxZc,1060
 vellum/types/paginated_test_suite_test_case_list.py,sha256=Ak_plmBTt72atM2uC1PWm8uVffi3tPAozolApJ7LYS4,1044
+vellum/types/pdf_enum.py,sha256=pFnB6Uv7AbPbZPXlEtQ9O4qNNVeQX0kNLxz1sdkxvVM,112
+vellum/types/pdf_search_result_meta_source.py,sha256=qEwl2y_RN1XUShidjaH5zm8kp-4PRKm9hNk2_Jf29RY,1377
+vellum/types/pdf_search_result_meta_source_request.py,sha256=ft-qjTtiSxvo3KVTdzF88QkOCc4sOq46gEyb7ICjBOI,1384
 vellum/types/processing_failure_reason_enum.py,sha256=R_KIW7TcQejhc-vLhtNf9SdkYADgoZCn4ch4_RRIvsI,195
 vellum/types/processing_state_enum.py,sha256=lIEunnCpgYQExm2bGyTb12KyjQ3O7XOx636aWXb_Iwo,190
 vellum/types/prompt_deployment_expand_meta_request_request.py,sha256=r7xmsEaFZWLXKE1Y7GGjUXbaYyMnIdpdgFy3QvMEl8M,2044
@@ -286,11 +289,15 @@ vellum/types/search_node_result.py,sha256=ylJR6lICVahKvr4eGZxDxdLbHkxnu3zaHEV-GW
 vellum/types/search_node_result_data.py,sha256=bixMDjtlOKLFVkhUQHWkQcTffkbvYYfuob2hYkJWngg,1143
 vellum/types/search_request_options_request.py,sha256=WI_MYTsu4pjILsaJvkC-1A-Ghi8ib5qQZdz3kUq9iSY,1622
 vellum/types/search_response.py,sha256=tMnotqttu7YEYteBDuuriI2HYIJsstG1UFs-3GuNzPs,1047
-vellum/types/search_result.py,sha256=an56LL9iowhUCIO6np-lQNpPUt2SaYaSsPqLByU3ig4,1304
+vellum/types/search_result.py,sha256=bsAjiXEpXdwnysiJ0rsR3_aEi5wQlXR9HCECQ23ecxE,1500
 vellum/types/search_result_document.py,sha256=MRzncZs2Ug9g0NLoFO5AwElFIpJ4Zs-wUMOuDqX9Yfk,1466
 vellum/types/search_result_document_request.py,sha256=GVIvgn0htJJojCMPep2p3P_bcxf1ffNZ0XHhNPNsy-w,1473
 vellum/types/search_result_merging_request.py,sha256=Yx1iv-58kFMCayP_ngjhD8O-m2nvlIAfAQUz1pRxwKI,972
-vellum/types/search_result_request.py,sha256=fqqTr-id9cLg5cVxGavZSLOCJSTMBKPNRdkGAjJrytM,1333
+vellum/types/search_result_meta.py,sha256=6BIF2iDyBAlZMgJ4b0Hjw-6ZKgMicSXp09hvS1MHatY,936
+vellum/types/search_result_meta_request.py,sha256=9NT29Gy-lcmoF5fcTV95ftB5bS9aZjW4YSzkIVidH6A,965
+vellum/types/search_result_meta_source.py,sha256=8T7zgf4lKIoyVKN09dEME2bb3hi86ufG65z96kwYfDM,511
+vellum/types/search_result_meta_source_request.py,sha256=iQi1DI-COoeqfO3zsECjZPlnn-fTJEFEj6CGPXYH61A,554
+vellum/types/search_result_request.py,sha256=EYg4mDwbpGmQuMwQktn1LXOvn0XMVY0cKc3XPkCAjdw,1551
 vellum/types/search_results_enum.py,sha256=qiQWwPnGtlWgG6JVCOAV8KzJarrhOeZrOAeb569grgA,133
 vellum/types/search_weights_request.py,sha256=C6uvEWZSpmbslpU52qcVA-lEtKF_crRsafXsN_rDURc,1128
 vellum/types/sentence_chunker_config.py,sha256=DVag4hG9rvuhJWgzbcbsdU4Nz1mx_Ynb3DHUbeOViA4,1003
@@ -459,7 +466,7 @@ vellum/types/workflow_result_event_output_data_search_results.py,sha256=gazaUrC5
 vellum/types/workflow_result_event_output_data_string.py,sha256=aVWIIGbLj4TJJhTTj6WzhbYXQkcZatKuhhNy8UYwXbw,1482
 vellum/types/workflow_stream_event.py,sha256=KA6Bkk_XA6AIPWR-1vKnwF1A8l_Bm5y0arQCWWWRpsk,911
 vellum/version.py,sha256=neLt8HBHHUtDF9M5fsyUzHT-pKooEPvceaLDqqIGb0s,77
-vellum_ai-0.6.5.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
-vellum_ai-0.6.5.dist-info/METADATA,sha256=LRrhuNTE8VAO6jeFWXRA5RDnsW1OtcniYmYj_nGX548,3872
-vellum_ai-0.6.5.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-vellum_ai-0.6.5.dist-info/RECORD,,
+vellum_ai-0.6.6.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
+vellum_ai-0.6.6.dist-info/METADATA,sha256=GDu8VFYeIr-72DPo2M5V-BSnSiWrMyGCziUD7axX-3o,3872
+vellum_ai-0.6.6.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+vellum_ai-0.6.6.dist-info/RECORD,,