From 07d28ccf1f10e3a0fde214b71ac048f5c038c68d Mon Sep 17 00:00:00 2001 From: "konfig-bot[bot]" <121480725+konfig-bot[bot]@users.noreply.github.com> Date: Wed, 2 Oct 2024 00:26:31 +0000 Subject: [PATCH] Update OpenAPI Specification (#65) * Update OpenAPI Specification (api.yaml) * Regenerate SDKs --------- Co-authored-by: konfig-bot[bot] <121480725+konfig-bot[bot]@users.noreply.github.com> Co-authored-by: konfig-publisher --- .konfig/changesets/fine-jobs-search.md | 6 ++ STATISTICS.md | 6 +- api.yaml | 8 ++- sdks/python/.konfig/generate-id.txt | 2 +- sdks/python/README.md | 7 ++- sdks/python/groundx/api_client.py | 2 + sdks/python/groundx/configuration.py | 2 + sdks/python/groundx/model/search_request.py | 14 ++++- sdks/python/groundx/model/search_request.pyi | 14 ++++- .../python/groundx/operation_parameter_map.py | 3 + sdks/python/groundx/paths/v1_bucket/get.py | 2 + sdks/python/groundx/paths/v1_bucket/get.pyi | 2 + sdks/python/groundx/paths/v1_bucket/post.py | 2 + sdks/python/groundx/paths/v1_bucket/post.pyi | 2 + .../paths/v1_bucket_bucket_id/delete.py | 2 + .../paths/v1_bucket_bucket_id/delete.pyi | 2 + .../groundx/paths/v1_bucket_bucket_id/get.py | 2 + .../groundx/paths/v1_bucket_bucket_id/get.pyi | 2 + .../groundx/paths/v1_bucket_bucket_id/put.py | 2 + .../groundx/paths/v1_bucket_bucket_id/put.pyi | 2 + sdks/python/groundx/paths/v1_customer/get.py | 2 + sdks/python/groundx/paths/v1_customer/get.pyi | 2 + sdks/python/groundx/paths/v1_health/get.py | 2 + sdks/python/groundx/paths/v1_health/get.pyi | 2 + .../groundx/paths/v1_health_service/get.py | 2 + .../groundx/paths/v1_health_service/get.pyi | 2 + .../v1_ingest_document_document_id/delete.py | 2 + .../v1_ingest_document_document_id/delete.pyi | 2 + .../v1_ingest_document_document_id/get.py | 2 + .../v1_ingest_document_document_id/get.pyi | 2 + .../paths/v1_ingest_documents/delete.py | 2 + .../paths/v1_ingest_documents/delete.pyi | 2 + .../groundx/paths/v1_ingest_documents/get.py | 2 + .../groundx/paths/v1_ingest_documents/get.pyi | 2 + .../paths/v1_ingest_documents_id/get.py | 2 + .../paths/v1_ingest_documents_id/get.pyi | 2 + .../paths/v1_ingest_documents_local/post.py | 2 + .../paths/v1_ingest_documents_local/post.pyi | 2 + .../paths/v1_ingest_documents_remote/post.py | 2 + .../paths/v1_ingest_documents_remote/post.pyi | 2 + .../paths/v1_ingest_documents_website/post.py | 2 + .../v1_ingest_documents_website/post.pyi | 2 + .../groundx/paths/v1_ingest_process_id/get.py | 2 + .../paths/v1_ingest_process_id/get.pyi | 2 + sdks/python/groundx/paths/v1_project/get.py | 2 + sdks/python/groundx/paths/v1_project/get.pyi | 2 + sdks/python/groundx/paths/v1_project/post.py | 2 + sdks/python/groundx/paths/v1_project/post.pyi | 2 + .../paths/v1_project_project_id/delete.py | 2 + .../paths/v1_project_project_id/delete.pyi | 2 + .../paths/v1_project_project_id/get.py | 2 + .../paths/v1_project_project_id/get.pyi | 2 + .../paths/v1_project_project_id/put.py | 2 + .../paths/v1_project_project_id/put.pyi | 2 + .../delete.py | 2 + .../delete.pyi | 2 + .../post.py | 2 + .../post.pyi | 2 + .../python/groundx/paths/v1_search_id/post.py | 13 +++++ .../groundx/paths/v1_search_id/post.pyi | 13 +++++ sdks/python/groundx/type/search_request.py | 4 +- sdks/typescript/.konfig/generate-id.txt | 2 +- sdks/typescript/README.md | 7 ++- sdks/typescript/api/search-api-generated.ts | 7 ++- sdks/typescript/common.ts | 55 ++++++++++++------- sdks/typescript/models/search-request.ts | 6 ++ sdks/typescript/operationParameterMap.ts | 3 + 67 files changed, 233 insertions(+), 37 deletions(-) create mode 100644 .konfig/changesets/fine-jobs-search.md diff --git a/.konfig/changesets/fine-jobs-search.md b/.konfig/changesets/fine-jobs-search.md new file mode 100644 index 0000000..aa661f6 --- /dev/null +++ b/.konfig/changesets/fine-jobs-search.md @@ -0,0 +1,6 @@ +--- +python: patch +typescript: patch +--- + +Regenerate SDKs diff --git a/STATISTICS.md b/STATISTICS.md index a6cc4fd..70d9eb8 100644 --- a/STATISTICS.md +++ b/STATISTICS.md @@ -2,6 +2,6 @@ | SDK Name | Lines of Code | | -------- | ------------- | -| python | 47673 | -| typescript | 15724 | -| **Total** | 63397 | +| python | 47829 | +| typescript | 15752 | +| **Total** | 63581 | diff --git a/api.yaml b/api.yaml index 4e6a644..3c09047 100644 --- a/api.yaml +++ b/api.yaml @@ -357,7 +357,7 @@ paths: Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. parameters: - - description: The bucketId or projectId of the bucket or project being searched. The documents within the specified container will be compared to the query, and relevant information will be extracted. + - description: The bucketId, projectId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted. in: path name: id required: true @@ -833,6 +833,12 @@ components: default: my search query type: string example: 'my search query' + relevance: + description: The minimum search relevance score required to include the result. By default, this is 10.0. + default: 10.0 + type: number + format: float + example: 10.0 SearchResponse: type: object required: diff --git a/sdks/python/.konfig/generate-id.txt b/sdks/python/.konfig/generate-id.txt index 8da8b4d..cbd5f9a 100644 --- a/sdks/python/.konfig/generate-id.txt +++ b/sdks/python/.konfig/generate-id.txt @@ -1 +1 @@ -dfe7e157-3dfe-411a-b3d4-156dc5becddf \ No newline at end of file +2fef5e18-2886-44bf-aa84-5319703d20e5 \ No newline at end of file diff --git a/sdks/python/README.md b/sdks/python/README.md index 1dd6f7b..245fd04 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -1035,6 +1035,7 @@ Interact with the "Request Body" below to explore the arguments of this function content_response = groundx.search.content( query="my search query", id=1, + relevance=10, n=20, next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9", verbosity=0, @@ -1049,7 +1050,11 @@ The search query to be used to find relevant documentation. ##### id: `int` -The bucketId or projectId of the bucket or project being searched. The documents within the specified container will be compared to the query, and relevant information will be extracted. +The bucketId, projectId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted. + +##### relevance: `Union[int, float]` + +The minimum search relevance score required to include the result. By default, this is 10.0. ##### n: `int` diff --git a/sdks/python/groundx/api_client.py b/sdks/python/groundx/api_client.py index 803e755..ba101be 100644 --- a/sdks/python/groundx/api_client.py +++ b/sdks/python/groundx/api_client.py @@ -29,6 +29,8 @@ from urllib.parse import urlparse, quote from urllib3.fields import RequestField as RequestFieldBase from urllib3.fields import guess_content_type +from dateutil import parser +from datetime import datetime as dt import frozendict diff --git a/sdks/python/groundx/configuration.py b/sdks/python/groundx/configuration.py index 4a1c2d8..e32ec19 100644 --- a/sdks/python/groundx/configuration.py +++ b/sdks/python/groundx/configuration.py @@ -139,6 +139,8 @@ def __init__(self, host=None, else: raise ClientConfigurationError('API Key "ApiKeyAuth" is required') if x_api_key: + if type(x_api_key) is not str: + raise ClientConfigurationError("x_api_key must be a string") self.api_key['ApiKeyAuth'] = x_api_key elif api_key is None: raise ClientConfigurationError('API Key "ApiKeyAuth" is required') diff --git a/sdks/python/groundx/model/search_request.py b/sdks/python/groundx/model/search_request.py index 1c5b129..60e5de4 100644 --- a/sdks/python/groundx/model/search_request.py +++ b/sdks/python/groundx/model/search_request.py @@ -39,8 +39,10 @@ class MetaOapg: class properties: query = schemas.StrSchema + relevance = schemas.Float32Schema __annotations__ = { "query": query, + "relevance": relevance, } query: MetaOapg.properties.query @@ -48,10 +50,13 @@ class properties: @typing.overload def __getitem__(self, name: typing_extensions.Literal["query"]) -> MetaOapg.properties.query: ... + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relevance"]) -> MetaOapg.properties.relevance: ... + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["query", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["query", "relevance", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -59,10 +64,13 @@ def __getitem__(self, name: typing.Union[typing_extensions.Literal["query", ], s @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> MetaOapg.properties.query: ... + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relevance"]) -> typing.Union[MetaOapg.properties.relevance, schemas.Unset]: ... + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["query", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["query", "relevance", ], str]): return super().get_item_oapg(name) @@ -70,6 +78,7 @@ def __new__( cls, *args: typing.Union[dict, frozendict.frozendict, ], query: typing.Union[MetaOapg.properties.query, str, ], + relevance: typing.Union[MetaOapg.properties.relevance, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'SearchRequest': @@ -77,6 +86,7 @@ def __new__( cls, *args, query=query, + relevance=relevance, _configuration=_configuration, **kwargs, ) diff --git a/sdks/python/groundx/model/search_request.pyi b/sdks/python/groundx/model/search_request.pyi index 1c5b129..60e5de4 100644 --- a/sdks/python/groundx/model/search_request.pyi +++ b/sdks/python/groundx/model/search_request.pyi @@ -39,8 +39,10 @@ class SearchRequest( class properties: query = schemas.StrSchema + relevance = schemas.Float32Schema __annotations__ = { "query": query, + "relevance": relevance, } query: MetaOapg.properties.query @@ -48,10 +50,13 @@ class SearchRequest( @typing.overload def __getitem__(self, name: typing_extensions.Literal["query"]) -> MetaOapg.properties.query: ... + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relevance"]) -> MetaOapg.properties.relevance: ... + @typing.overload def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... - def __getitem__(self, name: typing.Union[typing_extensions.Literal["query", ], str]): + def __getitem__(self, name: typing.Union[typing_extensions.Literal["query", "relevance", ], str]): # dict_instance[name] accessor return super().__getitem__(name) @@ -59,10 +64,13 @@ class SearchRequest( @typing.overload def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> MetaOapg.properties.query: ... + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relevance"]) -> typing.Union[MetaOapg.properties.relevance, schemas.Unset]: ... + @typing.overload def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... - def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["query", ], str]): + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["query", "relevance", ], str]): return super().get_item_oapg(name) @@ -70,6 +78,7 @@ class SearchRequest( cls, *args: typing.Union[dict, frozendict.frozendict, ], query: typing.Union[MetaOapg.properties.query, str, ], + relevance: typing.Union[MetaOapg.properties.relevance, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, _configuration: typing.Optional[schemas.Configuration] = None, **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], ) -> 'SearchRequest': @@ -77,6 +86,7 @@ class SearchRequest( cls, *args, query=query, + relevance=relevance, _configuration=_configuration, **kwargs, ) diff --git a/sdks/python/groundx/operation_parameter_map.py b/sdks/python/groundx/operation_parameter_map.py index c9d2dc2..55089d3 100644 --- a/sdks/python/groundx/operation_parameter_map.py +++ b/sdks/python/groundx/operation_parameter_map.py @@ -220,6 +220,9 @@ { 'name': 'id' }, + { + 'name': 'relevance' + }, { 'name': 'n' }, diff --git a/sdks/python/groundx/paths/v1_bucket/get.py b/sdks/python/groundx/paths/v1_bucket/get.py index 357b083..38719ab 100644 --- a/sdks/python/groundx/paths/v1_bucket/get.py +++ b/sdks/python/groundx/paths/v1_bucket/get.py @@ -347,6 +347,7 @@ def list( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ List all buckets within your GroundX account Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, next_token=next_token, @@ -385,6 +386,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ List all buckets within your GroundX account Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, next_token=next_token, diff --git a/sdks/python/groundx/paths/v1_bucket/get.pyi b/sdks/python/groundx/paths/v1_bucket/get.pyi index f63d574..7be86a9 100644 --- a/sdks/python/groundx/paths/v1_bucket/get.pyi +++ b/sdks/python/groundx/paths/v1_bucket/get.pyi @@ -339,6 +339,7 @@ class List(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ List all buckets within your GroundX account Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, next_token=next_token, @@ -377,6 +378,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ List all buckets within your GroundX account Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, next_token=next_token, diff --git a/sdks/python/groundx/paths/v1_bucket/post.py b/sdks/python/groundx/paths/v1_bucket/post.py index d6e0eb0..0935572 100644 --- a/sdks/python/groundx/paths/v1_bucket/post.py +++ b/sdks/python/groundx/paths/v1_bucket/post.py @@ -339,6 +339,7 @@ def create( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Create a new bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._create_mapped_args( name=name, ) @@ -373,6 +374,7 @@ def post( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Create a new bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._create_mapped_args( name=name, ) diff --git a/sdks/python/groundx/paths/v1_bucket/post.pyi b/sdks/python/groundx/paths/v1_bucket/post.pyi index fcf06ed..d719e98 100644 --- a/sdks/python/groundx/paths/v1_bucket/post.pyi +++ b/sdks/python/groundx/paths/v1_bucket/post.pyi @@ -330,6 +330,7 @@ class Create(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Create a new bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._create_mapped_args( name=name, ) @@ -364,6 +365,7 @@ class ApiForpost(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Create a new bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._create_mapped_args( name=name, ) diff --git a/sdks/python/groundx/paths/v1_bucket_bucket_id/delete.py b/sdks/python/groundx/paths/v1_bucket_bucket_id/delete.py index ea844ad..cc8c07a 100644 --- a/sdks/python/groundx/paths/v1_bucket_bucket_id/delete.py +++ b/sdks/python/groundx/paths/v1_bucket_bucket_id/delete.py @@ -363,6 +363,7 @@ def delete( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( bucket_id=bucket_id, ) @@ -397,6 +398,7 @@ def delete( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( bucket_id=bucket_id, ) diff --git a/sdks/python/groundx/paths/v1_bucket_bucket_id/delete.pyi b/sdks/python/groundx/paths/v1_bucket_bucket_id/delete.pyi index 5fab865..8d224d9 100644 --- a/sdks/python/groundx/paths/v1_bucket_bucket_id/delete.pyi +++ b/sdks/python/groundx/paths/v1_bucket_bucket_id/delete.pyi @@ -353,6 +353,7 @@ class Delete(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( bucket_id=bucket_id, ) @@ -387,6 +388,7 @@ class ApiFordelete(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( bucket_id=bucket_id, ) diff --git a/sdks/python/groundx/paths/v1_bucket_bucket_id/get.py b/sdks/python/groundx/paths/v1_bucket_bucket_id/get.py index 0691884..5e8f02b 100644 --- a/sdks/python/groundx/paths/v1_bucket_bucket_id/get.py +++ b/sdks/python/groundx/paths/v1_bucket_bucket_id/get.py @@ -363,6 +363,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up a specific bucket by its bucketId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( bucket_id=bucket_id, ) @@ -397,6 +398,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up a specific bucket by its bucketId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( bucket_id=bucket_id, ) diff --git a/sdks/python/groundx/paths/v1_bucket_bucket_id/get.pyi b/sdks/python/groundx/paths/v1_bucket_bucket_id/get.pyi index ee47ca2..e746ceb 100644 --- a/sdks/python/groundx/paths/v1_bucket_bucket_id/get.pyi +++ b/sdks/python/groundx/paths/v1_bucket_bucket_id/get.pyi @@ -353,6 +353,7 @@ class Get(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up a specific bucket by its bucketId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( bucket_id=bucket_id, ) @@ -387,6 +388,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up a specific bucket by its bucketId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( bucket_id=bucket_id, ) diff --git a/sdks/python/groundx/paths/v1_bucket_bucket_id/put.py b/sdks/python/groundx/paths/v1_bucket_bucket_id/put.py index bbc6b26..f2d621a 100644 --- a/sdks/python/groundx/paths/v1_bucket_bucket_id/put.py +++ b/sdks/python/groundx/paths/v1_bucket_bucket_id/put.py @@ -421,6 +421,7 @@ def update( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Rename a bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._update_mapped_args( new_name=new_name, bucket_id=bucket_id, @@ -461,6 +462,7 @@ def put( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Rename a bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._update_mapped_args( new_name=new_name, bucket_id=bucket_id, diff --git a/sdks/python/groundx/paths/v1_bucket_bucket_id/put.pyi b/sdks/python/groundx/paths/v1_bucket_bucket_id/put.pyi index 4e57c65..5e95bab 100644 --- a/sdks/python/groundx/paths/v1_bucket_bucket_id/put.pyi +++ b/sdks/python/groundx/paths/v1_bucket_bucket_id/put.pyi @@ -411,6 +411,7 @@ class Update(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Rename a bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._update_mapped_args( new_name=new_name, bucket_id=bucket_id, @@ -451,6 +452,7 @@ class ApiForput(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Rename a bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._update_mapped_args( new_name=new_name, bucket_id=bucket_id, diff --git a/sdks/python/groundx/paths/v1_customer/get.py b/sdks/python/groundx/paths/v1_customer/get.py index 243da42..03ec66e 100644 --- a/sdks/python/groundx/paths/v1_customer/get.py +++ b/sdks/python/groundx/paths/v1_customer/get.py @@ -264,6 +264,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Get the account information associated with the API key. """ args = self._get_mapped_args( ) return self._get_oapg( @@ -292,6 +293,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Get the account information associated with the API key. """ args = self._get_mapped_args( ) return self._get_oapg( diff --git a/sdks/python/groundx/paths/v1_customer/get.pyi b/sdks/python/groundx/paths/v1_customer/get.pyi index cbe6046..98c8e24 100644 --- a/sdks/python/groundx/paths/v1_customer/get.pyi +++ b/sdks/python/groundx/paths/v1_customer/get.pyi @@ -256,6 +256,7 @@ class Get(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Get the account information associated with the API key. """ args = self._get_mapped_args( ) return self._get_oapg( @@ -284,6 +285,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Get the account information associated with the API key. """ args = self._get_mapped_args( ) return self._get_oapg( diff --git a/sdks/python/groundx/paths/v1_health/get.py b/sdks/python/groundx/paths/v1_health/get.py index 7eef4cc..5159f3e 100644 --- a/sdks/python/groundx/paths/v1_health/get.py +++ b/sdks/python/groundx/paths/v1_health/get.py @@ -264,6 +264,7 @@ def list( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ List the current health status of all services. Statuses update every 5 minutes. """ args = self._list_mapped_args( ) return self._list_oapg( @@ -292,6 +293,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ List the current health status of all services. Statuses update every 5 minutes. """ args = self._list_mapped_args( ) return self._list_oapg( diff --git a/sdks/python/groundx/paths/v1_health/get.pyi b/sdks/python/groundx/paths/v1_health/get.pyi index 615e92a..6fb4608 100644 --- a/sdks/python/groundx/paths/v1_health/get.pyi +++ b/sdks/python/groundx/paths/v1_health/get.pyi @@ -256,6 +256,7 @@ class List(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ List the current health status of all services. Statuses update every 5 minutes. """ args = self._list_mapped_args( ) return self._list_oapg( @@ -284,6 +285,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ List the current health status of all services. Statuses update every 5 minutes. """ args = self._list_mapped_args( ) return self._list_oapg( diff --git a/sdks/python/groundx/paths/v1_health_service/get.py b/sdks/python/groundx/paths/v1_health_service/get.py index ce389c2..78fb83e 100644 --- a/sdks/python/groundx/paths/v1_health_service/get.py +++ b/sdks/python/groundx/paths/v1_health_service/get.py @@ -346,6 +346,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up the current health status of a specific service. Statuses update every 5 minutes. """ args = self._get_mapped_args( service=service, ) @@ -380,6 +381,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up the current health status of a specific service. Statuses update every 5 minutes. """ args = self._get_mapped_args( service=service, ) diff --git a/sdks/python/groundx/paths/v1_health_service/get.pyi b/sdks/python/groundx/paths/v1_health_service/get.pyi index d4d98e3..60dfd50 100644 --- a/sdks/python/groundx/paths/v1_health_service/get.pyi +++ b/sdks/python/groundx/paths/v1_health_service/get.pyi @@ -337,6 +337,7 @@ class Get(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up the current health status of a specific service. Statuses update every 5 minutes. """ args = self._get_mapped_args( service=service, ) @@ -371,6 +372,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up the current health status of a specific service. Statuses update every 5 minutes. """ args = self._get_mapped_args( service=service, ) diff --git a/sdks/python/groundx/paths/v1_ingest_document_document_id/delete.py b/sdks/python/groundx/paths/v1_ingest_document_document_id/delete.py index 148c5ff..1f3edf8 100644 --- a/sdks/python/groundx/paths/v1_ingest_document_document_id/delete.py +++ b/sdks/python/groundx/paths/v1_ingest_document_document_id/delete.py @@ -363,6 +363,7 @@ def delete1( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a single document hosted on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete1_mapped_args( document_id=document_id, ) @@ -397,6 +398,7 @@ def delete( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a single document hosted on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete1_mapped_args( document_id=document_id, ) diff --git a/sdks/python/groundx/paths/v1_ingest_document_document_id/delete.pyi b/sdks/python/groundx/paths/v1_ingest_document_document_id/delete.pyi index 2e50766..8228b70 100644 --- a/sdks/python/groundx/paths/v1_ingest_document_document_id/delete.pyi +++ b/sdks/python/groundx/paths/v1_ingest_document_document_id/delete.pyi @@ -353,6 +353,7 @@ class Delete1(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a single document hosted on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete1_mapped_args( document_id=document_id, ) @@ -387,6 +388,7 @@ class ApiFordelete(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a single document hosted on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete1_mapped_args( document_id=document_id, ) diff --git a/sdks/python/groundx/paths/v1_ingest_document_document_id/get.py b/sdks/python/groundx/paths/v1_ingest_document_document_id/get.py index 6a65d32..1ae7ec7 100644 --- a/sdks/python/groundx/paths/v1_ingest_document_document_id/get.py +++ b/sdks/python/groundx/paths/v1_ingest_document_document_id/get.py @@ -363,6 +363,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up an existing document by documentId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( document_id=document_id, ) @@ -397,6 +398,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up an existing document by documentId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( document_id=document_id, ) diff --git a/sdks/python/groundx/paths/v1_ingest_document_document_id/get.pyi b/sdks/python/groundx/paths/v1_ingest_document_document_id/get.pyi index d040630..381c732 100644 --- a/sdks/python/groundx/paths/v1_ingest_document_document_id/get.pyi +++ b/sdks/python/groundx/paths/v1_ingest_document_document_id/get.pyi @@ -353,6 +353,7 @@ class Get(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up an existing document by documentId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( document_id=document_id, ) @@ -387,6 +388,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Look up an existing document by documentId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( document_id=document_id, ) diff --git a/sdks/python/groundx/paths/v1_ingest_documents/delete.py b/sdks/python/groundx/paths/v1_ingest_documents/delete.py index c53fc16..79ee3cd 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents/delete.py +++ b/sdks/python/groundx/paths/v1_ingest_documents/delete.py @@ -387,6 +387,7 @@ def delete( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete multiple documents hosted on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( document_ids=document_ids, ) @@ -421,6 +422,7 @@ def delete( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete multiple documents hosted on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( document_ids=document_ids, ) diff --git a/sdks/python/groundx/paths/v1_ingest_documents/delete.pyi b/sdks/python/groundx/paths/v1_ingest_documents/delete.pyi index 2b4a491..8080e4c 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents/delete.pyi +++ b/sdks/python/groundx/paths/v1_ingest_documents/delete.pyi @@ -377,6 +377,7 @@ class Delete(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete multiple documents hosted on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( document_ids=document_ids, ) @@ -411,6 +412,7 @@ class ApiFordelete(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete multiple documents hosted on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( document_ids=document_ids, ) diff --git a/sdks/python/groundx/paths/v1_ingest_documents/get.py b/sdks/python/groundx/paths/v1_ingest_documents/get.py index bebd95b..2e683d4 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents/get.py +++ b/sdks/python/groundx/paths/v1_ingest_documents/get.py @@ -417,6 +417,7 @@ def list( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ lookup all documents across all resources which are currently on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, filter=filter, @@ -471,6 +472,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ lookup all documents across all resources which are currently on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, filter=filter, diff --git a/sdks/python/groundx/paths/v1_ingest_documents/get.pyi b/sdks/python/groundx/paths/v1_ingest_documents/get.pyi index 5b2cb2e..ed17216 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents/get.pyi +++ b/sdks/python/groundx/paths/v1_ingest_documents/get.pyi @@ -409,6 +409,7 @@ class List(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ lookup all documents across all resources which are currently on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, filter=filter, @@ -463,6 +464,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ lookup all documents across all resources which are currently on GroundX Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, filter=filter, diff --git a/sdks/python/groundx/paths/v1_ingest_documents_id/get.py b/sdks/python/groundx/paths/v1_ingest_documents_id/get.py index 86d612c..81a6dd2 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents_id/get.py +++ b/sdks/python/groundx/paths/v1_ingest_documents_id/get.py @@ -516,6 +516,7 @@ def lookup( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ lookup the document(s) associated with a processId, bucketId, or projectId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._lookup_mapped_args( id=id, n=n, @@ -576,6 +577,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ lookup the document(s) associated with a processId, bucketId, or projectId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._lookup_mapped_args( id=id, n=n, diff --git a/sdks/python/groundx/paths/v1_ingest_documents_id/get.pyi b/sdks/python/groundx/paths/v1_ingest_documents_id/get.pyi index 43f7228..a216172 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents_id/get.pyi +++ b/sdks/python/groundx/paths/v1_ingest_documents_id/get.pyi @@ -506,6 +506,7 @@ class Lookup(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ lookup the document(s) associated with a processId, bucketId, or projectId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._lookup_mapped_args( id=id, n=n, @@ -566,6 +567,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ lookup the document(s) associated with a processId, bucketId, or projectId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._lookup_mapped_args( id=id, n=n, diff --git a/sdks/python/groundx/paths/v1_ingest_documents_local/post.py b/sdks/python/groundx/paths/v1_ingest_documents_local/post.py index aef01d8..58e98a0 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents_local/post.py +++ b/sdks/python/groundx/paths/v1_ingest_documents_local/post.py @@ -349,6 +349,7 @@ def ingest_local( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Upload documents hosted on a local file system for ingestion into a GroundX bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._ingest_local_mapped_args( body=body, ) @@ -383,6 +384,7 @@ def post( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Upload documents hosted on a local file system for ingestion into a GroundX bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._ingest_local_mapped_args( body=body, ) diff --git a/sdks/python/groundx/paths/v1_ingest_documents_local/post.pyi b/sdks/python/groundx/paths/v1_ingest_documents_local/post.pyi index 9b5c1ef..c0243bd 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents_local/post.pyi +++ b/sdks/python/groundx/paths/v1_ingest_documents_local/post.pyi @@ -339,6 +339,7 @@ class IngestLocal(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Upload documents hosted on a local file system for ingestion into a GroundX bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._ingest_local_mapped_args( body=body, ) @@ -373,6 +374,7 @@ class ApiForpost(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Upload documents hosted on a local file system for ingestion into a GroundX bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._ingest_local_mapped_args( body=body, ) diff --git a/sdks/python/groundx/paths/v1_ingest_documents_remote/post.py b/sdks/python/groundx/paths/v1_ingest_documents_remote/post.py index cc062b5..6cf4679 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents_remote/post.py +++ b/sdks/python/groundx/paths/v1_ingest_documents_remote/post.py @@ -353,6 +353,7 @@ def ingest_remote( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Ingest documents hosted on public URLs to a GroundX bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._ingest_remote_mapped_args( documents=documents, ) @@ -387,6 +388,7 @@ def post( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Ingest documents hosted on public URLs to a GroundX bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._ingest_remote_mapped_args( documents=documents, ) diff --git a/sdks/python/groundx/paths/v1_ingest_documents_remote/post.pyi b/sdks/python/groundx/paths/v1_ingest_documents_remote/post.pyi index adb7d54..961235e 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents_remote/post.pyi +++ b/sdks/python/groundx/paths/v1_ingest_documents_remote/post.pyi @@ -343,6 +343,7 @@ class IngestRemote(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Ingest documents hosted on public URLs to a GroundX bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._ingest_remote_mapped_args( documents=documents, ) @@ -377,6 +378,7 @@ class ApiForpost(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Ingest documents hosted on public URLs to a GroundX bucket. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._ingest_remote_mapped_args( documents=documents, ) diff --git a/sdks/python/groundx/paths/v1_ingest_documents_website/post.py b/sdks/python/groundx/paths/v1_ingest_documents_website/post.py index 92c8849..a242f2e 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents_website/post.py +++ b/sdks/python/groundx/paths/v1_ingest_documents_website/post.py @@ -353,6 +353,7 @@ def crawl_website( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._crawl_website_mapped_args( websites=websites, ) @@ -387,6 +388,7 @@ def post( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._crawl_website_mapped_args( websites=websites, ) diff --git a/sdks/python/groundx/paths/v1_ingest_documents_website/post.pyi b/sdks/python/groundx/paths/v1_ingest_documents_website/post.pyi index 215be1e..4b46f25 100644 --- a/sdks/python/groundx/paths/v1_ingest_documents_website/post.pyi +++ b/sdks/python/groundx/paths/v1_ingest_documents_website/post.pyi @@ -343,6 +343,7 @@ class CrawlWebsite(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._crawl_website_mapped_args( websites=websites, ) @@ -377,6 +378,7 @@ class ApiForpost(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._crawl_website_mapped_args( websites=websites, ) diff --git a/sdks/python/groundx/paths/v1_ingest_process_id/get.py b/sdks/python/groundx/paths/v1_ingest_process_id/get.py index 4ea89f1..6b268b5 100644 --- a/sdks/python/groundx/paths/v1_ingest_process_id/get.py +++ b/sdks/python/groundx/paths/v1_ingest_process_id/get.py @@ -363,6 +363,7 @@ def get_processing_status_by_id( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions). Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_processing_status_by_id_mapped_args( process_id=process_id, ) @@ -397,6 +398,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions). Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_processing_status_by_id_mapped_args( process_id=process_id, ) diff --git a/sdks/python/groundx/paths/v1_ingest_process_id/get.pyi b/sdks/python/groundx/paths/v1_ingest_process_id/get.pyi index 00320ac..222103b 100644 --- a/sdks/python/groundx/paths/v1_ingest_process_id/get.pyi +++ b/sdks/python/groundx/paths/v1_ingest_process_id/get.pyi @@ -353,6 +353,7 @@ class GetProcessingStatusById(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions). Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_processing_status_by_id_mapped_args( process_id=process_id, ) @@ -387,6 +388,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions). Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_processing_status_by_id_mapped_args( process_id=process_id, ) diff --git a/sdks/python/groundx/paths/v1_project/get.py b/sdks/python/groundx/paths/v1_project/get.py index 84f3cd1..96db77e 100644 --- a/sdks/python/groundx/paths/v1_project/get.py +++ b/sdks/python/groundx/paths/v1_project/get.py @@ -347,6 +347,7 @@ def list( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ list all projects within your GroundX account. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, next_token=next_token, @@ -385,6 +386,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ list all projects within your GroundX account. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, next_token=next_token, diff --git a/sdks/python/groundx/paths/v1_project/get.pyi b/sdks/python/groundx/paths/v1_project/get.pyi index 27b3679..c5ff19f 100644 --- a/sdks/python/groundx/paths/v1_project/get.pyi +++ b/sdks/python/groundx/paths/v1_project/get.pyi @@ -339,6 +339,7 @@ class List(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ list all projects within your GroundX account. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, next_token=next_token, @@ -377,6 +378,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ list all projects within your GroundX account. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._list_mapped_args( n=n, next_token=next_token, diff --git a/sdks/python/groundx/paths/v1_project/post.py b/sdks/python/groundx/paths/v1_project/post.py index 06fe5ff..8d0679d 100644 --- a/sdks/python/groundx/paths/v1_project/post.py +++ b/sdks/python/groundx/paths/v1_project/post.py @@ -345,6 +345,7 @@ def create( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ create a new project, a project being a collection of buckets which can be searched. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._create_mapped_args( name=name, bucket_name=bucket_name, @@ -383,6 +384,7 @@ def post( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ create a new project, a project being a collection of buckets which can be searched. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._create_mapped_args( name=name, bucket_name=bucket_name, diff --git a/sdks/python/groundx/paths/v1_project/post.pyi b/sdks/python/groundx/paths/v1_project/post.pyi index cc10210..0bce954 100644 --- a/sdks/python/groundx/paths/v1_project/post.pyi +++ b/sdks/python/groundx/paths/v1_project/post.pyi @@ -336,6 +336,7 @@ class Create(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ create a new project, a project being a collection of buckets which can be searched. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._create_mapped_args( name=name, bucket_name=bucket_name, @@ -374,6 +375,7 @@ class ApiForpost(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ create a new project, a project being a collection of buckets which can be searched. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._create_mapped_args( name=name, bucket_name=bucket_name, diff --git a/sdks/python/groundx/paths/v1_project_project_id/delete.py b/sdks/python/groundx/paths/v1_project_project_id/delete.py index 6f49875..803fe10 100644 --- a/sdks/python/groundx/paths/v1_project_project_id/delete.py +++ b/sdks/python/groundx/paths/v1_project_project_id/delete.py @@ -363,6 +363,7 @@ def delete( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a project. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( project_id=project_id, ) @@ -397,6 +398,7 @@ def delete( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a project. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( project_id=project_id, ) diff --git a/sdks/python/groundx/paths/v1_project_project_id/delete.pyi b/sdks/python/groundx/paths/v1_project_project_id/delete.pyi index 9abff0e..7c61eb8 100644 --- a/sdks/python/groundx/paths/v1_project_project_id/delete.pyi +++ b/sdks/python/groundx/paths/v1_project_project_id/delete.pyi @@ -353,6 +353,7 @@ class Delete(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a project. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( project_id=project_id, ) @@ -387,6 +388,7 @@ class ApiFordelete(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Delete a project. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._delete_mapped_args( project_id=project_id, ) diff --git a/sdks/python/groundx/paths/v1_project_project_id/get.py b/sdks/python/groundx/paths/v1_project_project_id/get.py index 7a7a25b..4876203 100644 --- a/sdks/python/groundx/paths/v1_project_project_id/get.py +++ b/sdks/python/groundx/paths/v1_project_project_id/get.py @@ -363,6 +363,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ look up a specific project by its projectId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( project_id=project_id, ) @@ -397,6 +398,7 @@ def get( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ look up a specific project by its projectId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( project_id=project_id, ) diff --git a/sdks/python/groundx/paths/v1_project_project_id/get.pyi b/sdks/python/groundx/paths/v1_project_project_id/get.pyi index 55ed65a..ea2f2fd 100644 --- a/sdks/python/groundx/paths/v1_project_project_id/get.pyi +++ b/sdks/python/groundx/paths/v1_project_project_id/get.pyi @@ -353,6 +353,7 @@ class Get(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ look up a specific project by its projectId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( project_id=project_id, ) @@ -387,6 +388,7 @@ class ApiForget(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ look up a specific project by its projectId. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._get_mapped_args( project_id=project_id, ) diff --git a/sdks/python/groundx/paths/v1_project_project_id/put.py b/sdks/python/groundx/paths/v1_project_project_id/put.py index c9af5cb..40a254e 100644 --- a/sdks/python/groundx/paths/v1_project_project_id/put.py +++ b/sdks/python/groundx/paths/v1_project_project_id/put.py @@ -421,6 +421,7 @@ def update( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Rename a project Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._update_mapped_args( new_name=new_name, project_id=project_id, @@ -461,6 +462,7 @@ def put( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Rename a project Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._update_mapped_args( new_name=new_name, project_id=project_id, diff --git a/sdks/python/groundx/paths/v1_project_project_id/put.pyi b/sdks/python/groundx/paths/v1_project_project_id/put.pyi index 4597e3e..1621ac7 100644 --- a/sdks/python/groundx/paths/v1_project_project_id/put.pyi +++ b/sdks/python/groundx/paths/v1_project_project_id/put.pyi @@ -411,6 +411,7 @@ class Update(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Rename a project Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._update_mapped_args( new_name=new_name, project_id=project_id, @@ -451,6 +452,7 @@ class ApiForput(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Rename a project Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._update_mapped_args( new_name=new_name, project_id=project_id, diff --git a/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/delete.py b/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/delete.py index a5560ed..37aa98d 100644 --- a/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/delete.py +++ b/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/delete.py @@ -379,6 +379,7 @@ def remove_bucket( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ remove a bucket from a project. Buckets and projects can be associated many to many, this removes one bucket to project association without disturbing others. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._remove_bucket_mapped_args( project_id=project_id, bucket_id=bucket_id, @@ -417,6 +418,7 @@ def delete( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ remove a bucket from a project. Buckets and projects can be associated many to many, this removes one bucket to project association without disturbing others. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._remove_bucket_mapped_args( project_id=project_id, bucket_id=bucket_id, diff --git a/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/delete.pyi b/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/delete.pyi index 2e6e2d8..8188980 100644 --- a/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/delete.pyi +++ b/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/delete.pyi @@ -369,6 +369,7 @@ class RemoveBucket(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ remove a bucket from a project. Buckets and projects can be associated many to many, this removes one bucket to project association without disturbing others. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._remove_bucket_mapped_args( project_id=project_id, bucket_id=bucket_id, @@ -407,6 +408,7 @@ class ApiFordelete(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ remove a bucket from a project. Buckets and projects can be associated many to many, this removes one bucket to project association without disturbing others. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._remove_bucket_mapped_args( project_id=project_id, bucket_id=bucket_id, diff --git a/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/post.py b/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/post.py index 69c88c3..4ff8a44 100644 --- a/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/post.py +++ b/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/post.py @@ -379,6 +379,7 @@ def add_bucket( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Add an existing bucket to an existing project. Buckets and projects can be associated many to many. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._add_bucket_mapped_args( project_id=project_id, bucket_id=bucket_id, @@ -417,6 +418,7 @@ def post( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Add an existing bucket to an existing project. Buckets and projects can be associated many to many. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._add_bucket_mapped_args( project_id=project_id, bucket_id=bucket_id, diff --git a/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/post.pyi b/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/post.pyi index 6aa2901..1355bf9 100644 --- a/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/post.pyi +++ b/sdks/python/groundx/paths/v1_project_project_id_bucket_bucket_id/post.pyi @@ -369,6 +369,7 @@ class AddBucket(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Add an existing bucket to an existing project. Buckets and projects can be associated many to many. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._add_bucket_mapped_args( project_id=project_id, bucket_id=bucket_id, @@ -407,6 +408,7 @@ class ApiForpost(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Add an existing bucket to an existing project. Buckets and projects can be associated many to many. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._add_bucket_mapped_args( project_id=project_id, bucket_id=bucket_id, diff --git a/sdks/python/groundx/paths/v1_search_id/post.py b/sdks/python/groundx/paths/v1_search_id/post.py index e56127a..dc06485 100644 --- a/sdks/python/groundx/paths/v1_search_id/post.py +++ b/sdks/python/groundx/paths/v1_search_id/post.py @@ -208,6 +208,7 @@ def _content_mapped_args( self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -218,6 +219,8 @@ def _content_mapped_args( _body = {} if query is not None: _body["query"] = query + if relevance is not None: + _body["relevance"] = relevance args.body = _body if n is not None: _query_params["n"] = n @@ -499,6 +502,7 @@ async def acontent( self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -511,6 +515,7 @@ async def acontent( args = self._content_mapped_args( query=query, id=id, + relevance=relevance, n=n, next_token=next_token, verbosity=verbosity, @@ -526,6 +531,7 @@ def content( self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -533,9 +539,11 @@ def content( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Search documents on GroundX for the most relevant information to a given query. The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._content_mapped_args( query=query, id=id, + relevance=relevance, n=n, next_token=next_token, verbosity=verbosity, @@ -553,6 +561,7 @@ async def apost( self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -565,6 +574,7 @@ async def apost( args = self._content_mapped_args( query=query, id=id, + relevance=relevance, n=n, next_token=next_token, verbosity=verbosity, @@ -580,6 +590,7 @@ def post( self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -587,9 +598,11 @@ def post( ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Search documents on GroundX for the most relevant information to a given query. The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._content_mapped_args( query=query, id=id, + relevance=relevance, n=n, next_token=next_token, verbosity=verbosity, diff --git a/sdks/python/groundx/paths/v1_search_id/post.pyi b/sdks/python/groundx/paths/v1_search_id/post.pyi index 2459253..3ef7f38 100644 --- a/sdks/python/groundx/paths/v1_search_id/post.pyi +++ b/sdks/python/groundx/paths/v1_search_id/post.pyi @@ -190,6 +190,7 @@ class BaseApi(api_client.Api): self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -200,6 +201,8 @@ class BaseApi(api_client.Api): _body = {} if query is not None: _body["query"] = query + if relevance is not None: + _body["relevance"] = relevance args.body = _body if n is not None: _query_params["n"] = n @@ -481,6 +484,7 @@ class Content(BaseApi): self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -493,6 +497,7 @@ class Content(BaseApi): args = self._content_mapped_args( query=query, id=id, + relevance=relevance, n=n, next_token=next_token, verbosity=verbosity, @@ -508,6 +513,7 @@ class Content(BaseApi): self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -515,9 +521,11 @@ class Content(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Search documents on GroundX for the most relevant information to a given query. The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._content_mapped_args( query=query, id=id, + relevance=relevance, n=n, next_token=next_token, verbosity=verbosity, @@ -535,6 +543,7 @@ class ApiForpost(BaseApi): self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -547,6 +556,7 @@ class ApiForpost(BaseApi): args = self._content_mapped_args( query=query, id=id, + relevance=relevance, n=n, next_token=next_token, verbosity=verbosity, @@ -562,6 +572,7 @@ class ApiForpost(BaseApi): self, query: str, id: int, + relevance: typing.Optional[typing.Union[int, float]] = None, n: typing.Optional[int] = None, next_token: typing.Optional[str] = None, verbosity: typing.Optional[int] = None, @@ -569,9 +580,11 @@ class ApiForpost(BaseApi): ApiResponseFor200, api_client.ApiResponseWithoutDeserialization, ]: + """ Search documents on GroundX for the most relevant information to a given query. The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. """ args = self._content_mapped_args( query=query, id=id, + relevance=relevance, n=n, next_token=next_token, verbosity=verbosity, diff --git a/sdks/python/groundx/type/search_request.py b/sdks/python/groundx/type/search_request.py index add27a0..f1d2357 100644 --- a/sdks/python/groundx/type/search_request.py +++ b/sdks/python/groundx/type/search_request.py @@ -20,8 +20,10 @@ class RequiredSearchRequest(TypedDict): # The search query to be used to find relevant documentation. query: str + class OptionalSearchRequest(TypedDict, total=False): - pass + # The minimum search relevance score required to include the result. By default, this is 10.0. + relevance: typing.Union[int, float] class SearchRequest(RequiredSearchRequest, OptionalSearchRequest): pass diff --git a/sdks/typescript/.konfig/generate-id.txt b/sdks/typescript/.konfig/generate-id.txt index 8da8b4d..cbd5f9a 100644 --- a/sdks/typescript/.konfig/generate-id.txt +++ b/sdks/typescript/.konfig/generate-id.txt @@ -1 +1 @@ -dfe7e157-3dfe-411a-b3d4-156dc5becddf \ No newline at end of file +2fef5e18-2886-44bf-aa84-5319703d20e5 \ No newline at end of file diff --git a/sdks/typescript/README.md b/sdks/typescript/README.md index 7103323..a5caee3 100644 --- a/sdks/typescript/README.md +++ b/sdks/typescript/README.md @@ -1003,6 +1003,7 @@ const contentResponse = await groundx.search.content({ n: 20, nextToken: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9", query: "my search query", + relevance: 10, }); ``` @@ -1014,7 +1015,11 @@ The search query to be used to find relevant documentation. ##### id: `number` -The bucketId or projectId of the bucket or project being searched. The documents within the specified container will be compared to the query, and relevant information will be extracted. +The bucketId, projectId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted. + +##### relevance: `number` + +The minimum search relevance score required to include the result. By default, this is 10.0. ##### n: `number` diff --git a/sdks/typescript/api/search-api-generated.ts b/sdks/typescript/api/search-api-generated.ts index ec89e93..323249a 100644 --- a/sdks/typescript/api/search-api-generated.ts +++ b/sdks/typescript/api/search-api-generated.ts @@ -36,7 +36,7 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio /** * Search documents on GroundX for the most relevant information to a given query. The result of this query is typically used in one of two ways; result[\'search\'][\'text\'] can be used to provide context to a language model, facilitating RAG, or result[\'search\'][\'results\'] can be used to observe chunks of text which are relevant to the query, facilitating citation. Interact with the \"Request Body\" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments. * @summary search.content - * @param {number} id The bucketId or projectId of the bucket or project being searched. The documents within the specified container will be compared to the query, and relevant information will be extracted. + * @param {number} id The bucketId, projectId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted. * @param {number} [n] The maximum number of returned documents. Accepts 1-100 with a default of 20. * @param {string} [nextToken] A token for pagination. If the number of search results for a given query is larger than n, the response will include a \"nextToken\" value. That token can be included in this field to retrieve the next batch of n search results. * @param {number} [verbosity] The amount of data returned with each search result. 0 == no search results, only the recommended context. 1 == search results but no searchData. 2 == search results and searchData. @@ -117,7 +117,8 @@ export const SearchApiFp = function(configuration?: Configuration) { */ async content(requestParameters: SearchApiContentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const searchRequest: SearchRequest = { - query: requestParameters.query + query: requestParameters.query, + relevance: requestParameters.relevance }; const localVarAxiosArgs = await localVarAxiosParamCreator.content(requestParameters.id, requestParameters.n, requestParameters.nextToken, requestParameters.verbosity, searchRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -153,7 +154,7 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat export type SearchApiContentRequest = { /** - * The bucketId or projectId of the bucket or project being searched. The documents within the specified container will be compared to the query, and relevant information will be extracted. + * The bucketId, projectId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted. * @type {number} * @memberof SearchApiContent */ diff --git a/sdks/typescript/common.ts b/sdks/typescript/common.ts index 4ddb3e0..6cab4a2 100644 --- a/sdks/typescript/common.ts +++ b/sdks/typescript/common.ts @@ -162,32 +162,45 @@ export const removeTrailingSlash = function (url: string) { * Wrap an axios request in a try/catch block to catch network errors and parse the response body */ async function wrapAxiosRequest(makeRequest: () => Promise): Promise { - try { - return await makeRequest(); - } catch (e) { - if (e instanceof AxiosError && e.isAxiosError) { - try { - const responseBody = - e.response?.data instanceof ReadableStream - ? await readableStreamToString(e.response.data) - : e.response?.data - throw new GroundxError(e, parseIfJson(responseBody), e.response?.headers) - } catch (innerError) { - if (innerError instanceof ReferenceError) { - // Got: "ReferenceError: ReadableStream is not defined" - // This means we are in a Node environment so just throw the original error - throw new GroundxError(e, e.response?.data, e.response?.headers) + const maxAttempts = 3; + let attempt = 0; + let delay = 5000; + while (attempt < maxAttempts) { + try { + return await makeRequest(); + } catch (e) { + if (e instanceof AxiosError && e.isAxiosError) { + if (e.response?.status == 429) { + attempt++; + console.log(`429 error encountered, retrying in ${delay / 1000} seconds...`); + await new Promise(resolve => setTimeout(resolve, delay)); + delay *= 2; + continue; } - if (innerError instanceof GroundxError) { - // Got "GroundxError" from the above try block - throw innerError; + try { + const responseBody = + e.response?.data instanceof ReadableStream + ? await readableStreamToString(e.response.data) + : e.response?.data + throw new GroundxError(e, parseIfJson(responseBody), e.response?.headers) + } catch (innerError) { + if (innerError instanceof ReferenceError) { + // Got: "ReferenceError: ReadableStream is not defined" + // This means we are in a Node environment so just throw the original error + throw new GroundxError(e, e.response?.data, e.response?.headers) + } + if (innerError instanceof GroundxError) { + // Got "GroundxError" from the above try block + throw innerError; + } + // Something unexpected happened: propagate the error + throw e } - // Something unexpected happened: propagate the error - throw e } + throw e } - throw e } + throw new Error(`Request failed after ${maxAttempts} retries due to 429 (rate limit) errors.`); } /** diff --git a/sdks/typescript/models/search-request.ts b/sdks/typescript/models/search-request.ts index 839669a..9d96c67 100644 --- a/sdks/typescript/models/search-request.ts +++ b/sdks/typescript/models/search-request.ts @@ -23,5 +23,11 @@ export interface SearchRequest { * @memberof SearchRequest */ 'query': string; + /** + * The minimum search relevance score required to include the result. By default, this is 10.0. + * @type {number} + * @memberof SearchRequest + */ + 'relevance'?: number; } diff --git a/sdks/typescript/operationParameterMap.ts b/sdks/typescript/operationParameterMap.ts index 2d129c7..6a8ca9b 100644 --- a/sdks/typescript/operationParameterMap.ts +++ b/sdks/typescript/operationParameterMap.ts @@ -226,6 +226,9 @@ export const operationParameterMap: Record = { { name: 'id' }, + { + name: 'relevance' + }, { name: 'n' },