vectorize_client.api.ai_platform_connectors_api

Vectorize API

API for Vectorize services (Beta)

The version of the OpenAPI document: 0.1.2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

   1# coding: utf-8
   2
   3"""
   4    Vectorize API
   5
   6    API for Vectorize services (Beta)
   7
   8    The version of the OpenAPI document: 0.1.2
   9    Generated by OpenAPI Generator (https://openapi-generator.tech)
  10
  11    Do not edit the class manually.
  12"""  # noqa: E501
  13
  14import warnings
  15from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
  16from typing import Any, Dict, List, Optional, Tuple, Union
  17from typing_extensions import Annotated
  18
  19from pydantic import StrictStr
  20from typing import Optional
  21from vectorize_client.models.ai_platform_connector import AIPlatformConnector
  22from vectorize_client.models.create_ai_platform_connector_request import CreateAIPlatformConnectorRequest
  23from vectorize_client.models.create_ai_platform_connector_response import CreateAIPlatformConnectorResponse
  24from vectorize_client.models.delete_ai_platform_connector_response import DeleteAIPlatformConnectorResponse
  25from vectorize_client.models.get_ai_platform_connectors200_response import GetAIPlatformConnectors200Response
  26from vectorize_client.models.update_ai_platform_connector_request import UpdateAIPlatformConnectorRequest
  27from vectorize_client.models.update_ai_platform_connector_response import UpdateAIPlatformConnectorResponse
  28
  29from vectorize_client.api_client import ApiClient, RequestSerialized
  30from vectorize_client.api_response import ApiResponse
  31from vectorize_client.rest import RESTResponseType
  32
  33
  34class AIPlatformConnectorsApi:
  35    """NOTE: This class is auto generated by OpenAPI Generator
  36    Ref: https://openapi-generator.tech
  37
  38    Do not edit the class manually.
  39    """
  40
  41    def __init__(self, api_client=None) -> None:
  42        if api_client is None:
  43            api_client = ApiClient.get_default()
  44        self.api_client = api_client
  45
  46
  47    @validate_call
  48    def create_ai_platform_connector(
  49        self,
  50        organization_id: StrictStr,
  51        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
  52        workspace_id: Optional[StrictStr] = None,
  53        _request_timeout: Union[
  54            None,
  55            Annotated[StrictFloat, Field(gt=0)],
  56            Tuple[
  57                Annotated[StrictFloat, Field(gt=0)],
  58                Annotated[StrictFloat, Field(gt=0)]
  59            ]
  60        ] = None,
  61        _request_auth: Optional[Dict[StrictStr, Any]] = None,
  62        _content_type: Optional[StrictStr] = None,
  63        _headers: Optional[Dict[StrictStr, Any]] = None,
  64        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
  65    ) -> CreateAIPlatformConnectorResponse:
  66        """Create a new AI platform connector
  67
  68        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
  69
  70        :param organization_id: (required)
  71        :type organization_id: str
  72        :param create_ai_platform_connector_request: (required)
  73        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
  74        :param workspace_id:
  75        :type workspace_id: str
  76        :param _request_timeout: timeout setting for this request. If one
  77                                 number provided, it will be total request
  78                                 timeout. It can also be a pair (tuple) of
  79                                 (connection, read) timeouts.
  80        :type _request_timeout: int, tuple(int, int), optional
  81        :param _request_auth: set to override the auth_settings for an a single
  82                              request; this effectively ignores the
  83                              authentication in the spec for a single request.
  84        :type _request_auth: dict, optional
  85        :param _content_type: force content-type for the request.
  86        :type _content_type: str, Optional
  87        :param _headers: set to override the headers for a single
  88                         request; this effectively ignores the headers
  89                         in the spec for a single request.
  90        :type _headers: dict, optional
  91        :param _host_index: set to override the host_index for a single
  92                            request; this effectively ignores the host_index
  93                            in the spec for a single request.
  94        :type _host_index: int, optional
  95        :return: Returns the result object.
  96        """ # noqa: E501
  97
  98        _param = self._create_ai_platform_connector_serialize(
  99            organization_id=organization_id,
 100            create_ai_platform_connector_request=create_ai_platform_connector_request,
 101            workspace_id=workspace_id,
 102            _request_auth=_request_auth,
 103            _content_type=_content_type,
 104            _headers=_headers,
 105            _host_index=_host_index
 106        )
 107
 108        _response_types_map: Dict[str, Optional[str]] = {
 109            '200': "CreateAIPlatformConnectorResponse",
 110            '400': "GetPipelines400Response",
 111            '401': "GetPipelines400Response",
 112            '403': "GetPipelines400Response",
 113            '404': "GetPipelines400Response",
 114            '500': "GetPipelines400Response",
 115        }
 116        response_data = self.api_client.call_api(
 117            *_param,
 118            _request_timeout=_request_timeout
 119        )
 120        response_data.read()
 121        return self.api_client.response_deserialize(
 122            response_data=response_data,
 123            response_types_map=_response_types_map,
 124        ).data
 125
 126
 127    @validate_call
 128    def create_ai_platform_connector_with_http_info(
 129        self,
 130        organization_id: StrictStr,
 131        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
 132        workspace_id: Optional[StrictStr] = None,
 133        _request_timeout: Union[
 134            None,
 135            Annotated[StrictFloat, Field(gt=0)],
 136            Tuple[
 137                Annotated[StrictFloat, Field(gt=0)],
 138                Annotated[StrictFloat, Field(gt=0)]
 139            ]
 140        ] = None,
 141        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 142        _content_type: Optional[StrictStr] = None,
 143        _headers: Optional[Dict[StrictStr, Any]] = None,
 144        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 145    ) -> ApiResponse[CreateAIPlatformConnectorResponse]:
 146        """Create a new AI platform connector
 147
 148        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
 149
 150        :param organization_id: (required)
 151        :type organization_id: str
 152        :param create_ai_platform_connector_request: (required)
 153        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
 154        :param workspace_id:
 155        :type workspace_id: str
 156        :param _request_timeout: timeout setting for this request. If one
 157                                 number provided, it will be total request
 158                                 timeout. It can also be a pair (tuple) of
 159                                 (connection, read) timeouts.
 160        :type _request_timeout: int, tuple(int, int), optional
 161        :param _request_auth: set to override the auth_settings for an a single
 162                              request; this effectively ignores the
 163                              authentication in the spec for a single request.
 164        :type _request_auth: dict, optional
 165        :param _content_type: force content-type for the request.
 166        :type _content_type: str, Optional
 167        :param _headers: set to override the headers for a single
 168                         request; this effectively ignores the headers
 169                         in the spec for a single request.
 170        :type _headers: dict, optional
 171        :param _host_index: set to override the host_index for a single
 172                            request; this effectively ignores the host_index
 173                            in the spec for a single request.
 174        :type _host_index: int, optional
 175        :return: Returns the result object.
 176        """ # noqa: E501
 177
 178        _param = self._create_ai_platform_connector_serialize(
 179            organization_id=organization_id,
 180            create_ai_platform_connector_request=create_ai_platform_connector_request,
 181            workspace_id=workspace_id,
 182            _request_auth=_request_auth,
 183            _content_type=_content_type,
 184            _headers=_headers,
 185            _host_index=_host_index
 186        )
 187
 188        _response_types_map: Dict[str, Optional[str]] = {
 189            '200': "CreateAIPlatformConnectorResponse",
 190            '400': "GetPipelines400Response",
 191            '401': "GetPipelines400Response",
 192            '403': "GetPipelines400Response",
 193            '404': "GetPipelines400Response",
 194            '500': "GetPipelines400Response",
 195        }
 196        response_data = self.api_client.call_api(
 197            *_param,
 198            _request_timeout=_request_timeout
 199        )
 200        response_data.read()
 201        return self.api_client.response_deserialize(
 202            response_data=response_data,
 203            response_types_map=_response_types_map,
 204        )
 205
 206
 207    @validate_call
 208    def create_ai_platform_connector_without_preload_content(
 209        self,
 210        organization_id: StrictStr,
 211        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
 212        workspace_id: Optional[StrictStr] = None,
 213        _request_timeout: Union[
 214            None,
 215            Annotated[StrictFloat, Field(gt=0)],
 216            Tuple[
 217                Annotated[StrictFloat, Field(gt=0)],
 218                Annotated[StrictFloat, Field(gt=0)]
 219            ]
 220        ] = None,
 221        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 222        _content_type: Optional[StrictStr] = None,
 223        _headers: Optional[Dict[StrictStr, Any]] = None,
 224        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 225    ) -> RESTResponseType:
 226        """Create a new AI platform connector
 227
 228        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
 229
 230        :param organization_id: (required)
 231        :type organization_id: str
 232        :param create_ai_platform_connector_request: (required)
 233        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
 234        :param workspace_id:
 235        :type workspace_id: str
 236        :param _request_timeout: timeout setting for this request. If one
 237                                 number provided, it will be total request
 238                                 timeout. It can also be a pair (tuple) of
 239                                 (connection, read) timeouts.
 240        :type _request_timeout: int, tuple(int, int), optional
 241        :param _request_auth: set to override the auth_settings for an a single
 242                              request; this effectively ignores the
 243                              authentication in the spec for a single request.
 244        :type _request_auth: dict, optional
 245        :param _content_type: force content-type for the request.
 246        :type _content_type: str, Optional
 247        :param _headers: set to override the headers for a single
 248                         request; this effectively ignores the headers
 249                         in the spec for a single request.
 250        :type _headers: dict, optional
 251        :param _host_index: set to override the host_index for a single
 252                            request; this effectively ignores the host_index
 253                            in the spec for a single request.
 254        :type _host_index: int, optional
 255        :return: Returns the result object.
 256        """ # noqa: E501
 257
 258        _param = self._create_ai_platform_connector_serialize(
 259            organization_id=organization_id,
 260            create_ai_platform_connector_request=create_ai_platform_connector_request,
 261            workspace_id=workspace_id,
 262            _request_auth=_request_auth,
 263            _content_type=_content_type,
 264            _headers=_headers,
 265            _host_index=_host_index
 266        )
 267
 268        _response_types_map: Dict[str, Optional[str]] = {
 269            '200': "CreateAIPlatformConnectorResponse",
 270            '400': "GetPipelines400Response",
 271            '401': "GetPipelines400Response",
 272            '403': "GetPipelines400Response",
 273            '404': "GetPipelines400Response",
 274            '500': "GetPipelines400Response",
 275        }
 276        response_data = self.api_client.call_api(
 277            *_param,
 278            _request_timeout=_request_timeout
 279        )
 280        return response_data.response
 281
 282
 283    def _create_ai_platform_connector_serialize(
 284        self,
 285        organization_id,
 286        create_ai_platform_connector_request,
 287        workspace_id,
 288        _request_auth,
 289        _content_type,
 290        _headers,
 291        _host_index,
 292    ) -> RequestSerialized:
 293
 294        _host = None
 295
 296        _collection_formats: Dict[str, str] = {
 297        }
 298
 299        _path_params: Dict[str, str] = {}
 300        _query_params: List[Tuple[str, str]] = []
 301        _header_params: Dict[str, Optional[str]] = _headers or {}
 302        _form_params: List[Tuple[str, str]] = []
 303        _files: Dict[
 304            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
 305        ] = {}
 306        _body_params: Optional[bytes] = None
 307
 308        # process the path parameters
 309        if organization_id is not None:
 310            _path_params['organizationId'] = organization_id
 311        # process the query parameters
 312        if workspace_id is not None:
 313            
 314            _query_params.append(('workspaceId', workspace_id))
 315            
 316        # process the header parameters
 317        # process the form parameters
 318        # process the body parameter
 319        if create_ai_platform_connector_request is not None:
 320            _body_params = create_ai_platform_connector_request
 321
 322
 323        # set the HTTP header `Accept`
 324        if 'Accept' not in _header_params:
 325            _header_params['Accept'] = self.api_client.select_header_accept(
 326                [
 327                    'application/json'
 328                ]
 329            )
 330
 331        # set the HTTP header `Content-Type`
 332        if _content_type:
 333            _header_params['Content-Type'] = _content_type
 334        else:
 335            _default_content_type = (
 336                self.api_client.select_header_content_type(
 337                    [
 338                        'application/json'
 339                    ]
 340                )
 341            )
 342            if _default_content_type is not None:
 343                _header_params['Content-Type'] = _default_content_type
 344
 345        # authentication setting
 346        _auth_settings: List[str] = [
 347            'bearerAuth'
 348        ]
 349
 350        return self.api_client.param_serialize(
 351            method='POST',
 352            resource_path='/org/{organizationId}/connectors/aiplatforms',
 353            path_params=_path_params,
 354            query_params=_query_params,
 355            header_params=_header_params,
 356            body=_body_params,
 357            post_params=_form_params,
 358            files=_files,
 359            auth_settings=_auth_settings,
 360            collection_formats=_collection_formats,
 361            _host=_host,
 362            _request_auth=_request_auth
 363        )
 364
 365
 366
 367
 368    @validate_call
 369    def delete_ai_platform_connector(
 370        self,
 371        organization_id: StrictStr,
 372        ai_platform_connector_id: StrictStr,
 373        _request_timeout: Union[
 374            None,
 375            Annotated[StrictFloat, Field(gt=0)],
 376            Tuple[
 377                Annotated[StrictFloat, Field(gt=0)],
 378                Annotated[StrictFloat, Field(gt=0)]
 379            ]
 380        ] = None,
 381        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 382        _content_type: Optional[StrictStr] = None,
 383        _headers: Optional[Dict[StrictStr, Any]] = None,
 384        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 385    ) -> DeleteAIPlatformConnectorResponse:
 386        """Delete an AI platform connector
 387
 388        Delete an AI platform connector
 389
 390        :param organization_id: (required)
 391        :type organization_id: str
 392        :param ai_platform_connector_id: (required)
 393        :type ai_platform_connector_id: str
 394        :param _request_timeout: timeout setting for this request. If one
 395                                 number provided, it will be total request
 396                                 timeout. It can also be a pair (tuple) of
 397                                 (connection, read) timeouts.
 398        :type _request_timeout: int, tuple(int, int), optional
 399        :param _request_auth: set to override the auth_settings for an a single
 400                              request; this effectively ignores the
 401                              authentication in the spec for a single request.
 402        :type _request_auth: dict, optional
 403        :param _content_type: force content-type for the request.
 404        :type _content_type: str, Optional
 405        :param _headers: set to override the headers for a single
 406                         request; this effectively ignores the headers
 407                         in the spec for a single request.
 408        :type _headers: dict, optional
 409        :param _host_index: set to override the host_index for a single
 410                            request; this effectively ignores the host_index
 411                            in the spec for a single request.
 412        :type _host_index: int, optional
 413        :return: Returns the result object.
 414        """ # noqa: E501
 415
 416        _param = self._delete_ai_platform_connector_serialize(
 417            organization_id=organization_id,
 418            ai_platform_connector_id=ai_platform_connector_id,
 419            _request_auth=_request_auth,
 420            _content_type=_content_type,
 421            _headers=_headers,
 422            _host_index=_host_index
 423        )
 424
 425        _response_types_map: Dict[str, Optional[str]] = {
 426            '200': "DeleteAIPlatformConnectorResponse",
 427            '400': "GetPipelines400Response",
 428            '401': "GetPipelines400Response",
 429            '403': "GetPipelines400Response",
 430            '404': "GetPipelines400Response",
 431            '500': "GetPipelines400Response",
 432        }
 433        response_data = self.api_client.call_api(
 434            *_param,
 435            _request_timeout=_request_timeout
 436        )
 437        response_data.read()
 438        return self.api_client.response_deserialize(
 439            response_data=response_data,
 440            response_types_map=_response_types_map,
 441        ).data
 442
 443
 444    @validate_call
 445    def delete_ai_platform_connector_with_http_info(
 446        self,
 447        organization_id: StrictStr,
 448        ai_platform_connector_id: StrictStr,
 449        _request_timeout: Union[
 450            None,
 451            Annotated[StrictFloat, Field(gt=0)],
 452            Tuple[
 453                Annotated[StrictFloat, Field(gt=0)],
 454                Annotated[StrictFloat, Field(gt=0)]
 455            ]
 456        ] = None,
 457        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 458        _content_type: Optional[StrictStr] = None,
 459        _headers: Optional[Dict[StrictStr, Any]] = None,
 460        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 461    ) -> ApiResponse[DeleteAIPlatformConnectorResponse]:
 462        """Delete an AI platform connector
 463
 464        Delete an AI platform connector
 465
 466        :param organization_id: (required)
 467        :type organization_id: str
 468        :param ai_platform_connector_id: (required)
 469        :type ai_platform_connector_id: str
 470        :param _request_timeout: timeout setting for this request. If one
 471                                 number provided, it will be total request
 472                                 timeout. It can also be a pair (tuple) of
 473                                 (connection, read) timeouts.
 474        :type _request_timeout: int, tuple(int, int), optional
 475        :param _request_auth: set to override the auth_settings for an a single
 476                              request; this effectively ignores the
 477                              authentication in the spec for a single request.
 478        :type _request_auth: dict, optional
 479        :param _content_type: force content-type for the request.
 480        :type _content_type: str, Optional
 481        :param _headers: set to override the headers for a single
 482                         request; this effectively ignores the headers
 483                         in the spec for a single request.
 484        :type _headers: dict, optional
 485        :param _host_index: set to override the host_index for a single
 486                            request; this effectively ignores the host_index
 487                            in the spec for a single request.
 488        :type _host_index: int, optional
 489        :return: Returns the result object.
 490        """ # noqa: E501
 491
 492        _param = self._delete_ai_platform_connector_serialize(
 493            organization_id=organization_id,
 494            ai_platform_connector_id=ai_platform_connector_id,
 495            _request_auth=_request_auth,
 496            _content_type=_content_type,
 497            _headers=_headers,
 498            _host_index=_host_index
 499        )
 500
 501        _response_types_map: Dict[str, Optional[str]] = {
 502            '200': "DeleteAIPlatformConnectorResponse",
 503            '400': "GetPipelines400Response",
 504            '401': "GetPipelines400Response",
 505            '403': "GetPipelines400Response",
 506            '404': "GetPipelines400Response",
 507            '500': "GetPipelines400Response",
 508        }
 509        response_data = self.api_client.call_api(
 510            *_param,
 511            _request_timeout=_request_timeout
 512        )
 513        response_data.read()
 514        return self.api_client.response_deserialize(
 515            response_data=response_data,
 516            response_types_map=_response_types_map,
 517        )
 518
 519
 520    @validate_call
 521    def delete_ai_platform_connector_without_preload_content(
 522        self,
 523        organization_id: StrictStr,
 524        ai_platform_connector_id: StrictStr,
 525        _request_timeout: Union[
 526            None,
 527            Annotated[StrictFloat, Field(gt=0)],
 528            Tuple[
 529                Annotated[StrictFloat, Field(gt=0)],
 530                Annotated[StrictFloat, Field(gt=0)]
 531            ]
 532        ] = None,
 533        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 534        _content_type: Optional[StrictStr] = None,
 535        _headers: Optional[Dict[StrictStr, Any]] = None,
 536        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 537    ) -> RESTResponseType:
 538        """Delete an AI platform connector
 539
 540        Delete an AI platform connector
 541
 542        :param organization_id: (required)
 543        :type organization_id: str
 544        :param ai_platform_connector_id: (required)
 545        :type ai_platform_connector_id: str
 546        :param _request_timeout: timeout setting for this request. If one
 547                                 number provided, it will be total request
 548                                 timeout. It can also be a pair (tuple) of
 549                                 (connection, read) timeouts.
 550        :type _request_timeout: int, tuple(int, int), optional
 551        :param _request_auth: set to override the auth_settings for an a single
 552                              request; this effectively ignores the
 553                              authentication in the spec for a single request.
 554        :type _request_auth: dict, optional
 555        :param _content_type: force content-type for the request.
 556        :type _content_type: str, Optional
 557        :param _headers: set to override the headers for a single
 558                         request; this effectively ignores the headers
 559                         in the spec for a single request.
 560        :type _headers: dict, optional
 561        :param _host_index: set to override the host_index for a single
 562                            request; this effectively ignores the host_index
 563                            in the spec for a single request.
 564        :type _host_index: int, optional
 565        :return: Returns the result object.
 566        """ # noqa: E501
 567
 568        _param = self._delete_ai_platform_connector_serialize(
 569            organization_id=organization_id,
 570            ai_platform_connector_id=ai_platform_connector_id,
 571            _request_auth=_request_auth,
 572            _content_type=_content_type,
 573            _headers=_headers,
 574            _host_index=_host_index
 575        )
 576
 577        _response_types_map: Dict[str, Optional[str]] = {
 578            '200': "DeleteAIPlatformConnectorResponse",
 579            '400': "GetPipelines400Response",
 580            '401': "GetPipelines400Response",
 581            '403': "GetPipelines400Response",
 582            '404': "GetPipelines400Response",
 583            '500': "GetPipelines400Response",
 584        }
 585        response_data = self.api_client.call_api(
 586            *_param,
 587            _request_timeout=_request_timeout
 588        )
 589        return response_data.response
 590
 591
 592    def _delete_ai_platform_connector_serialize(
 593        self,
 594        organization_id,
 595        ai_platform_connector_id,
 596        _request_auth,
 597        _content_type,
 598        _headers,
 599        _host_index,
 600    ) -> RequestSerialized:
 601
 602        _host = None
 603
 604        _collection_formats: Dict[str, str] = {
 605        }
 606
 607        _path_params: Dict[str, str] = {}
 608        _query_params: List[Tuple[str, str]] = []
 609        _header_params: Dict[str, Optional[str]] = _headers or {}
 610        _form_params: List[Tuple[str, str]] = []
 611        _files: Dict[
 612            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
 613        ] = {}
 614        _body_params: Optional[bytes] = None
 615
 616        # process the path parameters
 617        if organization_id is not None:
 618            _path_params['organizationId'] = organization_id
 619        if ai_platform_connector_id is not None:
 620            _path_params['aiPlatformConnectorId'] = ai_platform_connector_id
 621        # process the query parameters
 622        # process the header parameters
 623        # process the form parameters
 624        # process the body parameter
 625
 626
 627        # set the HTTP header `Accept`
 628        if 'Accept' not in _header_params:
 629            _header_params['Accept'] = self.api_client.select_header_accept(
 630                [
 631                    'application/json'
 632                ]
 633            )
 634
 635
 636        # authentication setting
 637        _auth_settings: List[str] = [
 638            'bearerAuth'
 639        ]
 640
 641        return self.api_client.param_serialize(
 642            method='DELETE',
 643            resource_path='/org/{organizationId}/connectors/aiplatforms/{aiPlatformConnectorId}',
 644            path_params=_path_params,
 645            query_params=_query_params,
 646            header_params=_header_params,
 647            body=_body_params,
 648            post_params=_form_params,
 649            files=_files,
 650            auth_settings=_auth_settings,
 651            collection_formats=_collection_formats,
 652            _host=_host,
 653            _request_auth=_request_auth
 654        )
 655
 656
 657
 658
 659    @validate_call
 660    def get_ai_platform_connector(
 661        self,
 662        organization_id: StrictStr,
 663        ai_platform_connector_id: StrictStr,
 664        _request_timeout: Union[
 665            None,
 666            Annotated[StrictFloat, Field(gt=0)],
 667            Tuple[
 668                Annotated[StrictFloat, Field(gt=0)],
 669                Annotated[StrictFloat, Field(gt=0)]
 670            ]
 671        ] = None,
 672        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 673        _content_type: Optional[StrictStr] = None,
 674        _headers: Optional[Dict[StrictStr, Any]] = None,
 675        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 676    ) -> AIPlatformConnector:
 677        """Get an AI platform connector
 678
 679        Get an AI platform connector
 680
 681        :param organization_id: (required)
 682        :type organization_id: str
 683        :param ai_platform_connector_id: (required)
 684        :type ai_platform_connector_id: str
 685        :param _request_timeout: timeout setting for this request. If one
 686                                 number provided, it will be total request
 687                                 timeout. It can also be a pair (tuple) of
 688                                 (connection, read) timeouts.
 689        :type _request_timeout: int, tuple(int, int), optional
 690        :param _request_auth: set to override the auth_settings for an a single
 691                              request; this effectively ignores the
 692                              authentication in the spec for a single request.
 693        :type _request_auth: dict, optional
 694        :param _content_type: force content-type for the request.
 695        :type _content_type: str, Optional
 696        :param _headers: set to override the headers for a single
 697                         request; this effectively ignores the headers
 698                         in the spec for a single request.
 699        :type _headers: dict, optional
 700        :param _host_index: set to override the host_index for a single
 701                            request; this effectively ignores the host_index
 702                            in the spec for a single request.
 703        :type _host_index: int, optional
 704        :return: Returns the result object.
 705        """ # noqa: E501
 706
 707        _param = self._get_ai_platform_connector_serialize(
 708            organization_id=organization_id,
 709            ai_platform_connector_id=ai_platform_connector_id,
 710            _request_auth=_request_auth,
 711            _content_type=_content_type,
 712            _headers=_headers,
 713            _host_index=_host_index
 714        )
 715
 716        _response_types_map: Dict[str, Optional[str]] = {
 717            '200': "AIPlatformConnector",
 718            '400': "GetPipelines400Response",
 719            '401': "GetPipelines400Response",
 720            '403': "GetPipelines400Response",
 721            '404': "GetPipelines400Response",
 722            '500': "GetPipelines400Response",
 723        }
 724        response_data = self.api_client.call_api(
 725            *_param,
 726            _request_timeout=_request_timeout
 727        )
 728        response_data.read()
 729        return self.api_client.response_deserialize(
 730            response_data=response_data,
 731            response_types_map=_response_types_map,
 732        ).data
 733
 734
 735    @validate_call
 736    def get_ai_platform_connector_with_http_info(
 737        self,
 738        organization_id: StrictStr,
 739        ai_platform_connector_id: StrictStr,
 740        _request_timeout: Union[
 741            None,
 742            Annotated[StrictFloat, Field(gt=0)],
 743            Tuple[
 744                Annotated[StrictFloat, Field(gt=0)],
 745                Annotated[StrictFloat, Field(gt=0)]
 746            ]
 747        ] = None,
 748        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 749        _content_type: Optional[StrictStr] = None,
 750        _headers: Optional[Dict[StrictStr, Any]] = None,
 751        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 752    ) -> ApiResponse[AIPlatformConnector]:
 753        """Get an AI platform connector
 754
 755        Get an AI platform connector
 756
 757        :param organization_id: (required)
 758        :type organization_id: str
 759        :param ai_platform_connector_id: (required)
 760        :type ai_platform_connector_id: str
 761        :param _request_timeout: timeout setting for this request. If one
 762                                 number provided, it will be total request
 763                                 timeout. It can also be a pair (tuple) of
 764                                 (connection, read) timeouts.
 765        :type _request_timeout: int, tuple(int, int), optional
 766        :param _request_auth: set to override the auth_settings for an a single
 767                              request; this effectively ignores the
 768                              authentication in the spec for a single request.
 769        :type _request_auth: dict, optional
 770        :param _content_type: force content-type for the request.
 771        :type _content_type: str, Optional
 772        :param _headers: set to override the headers for a single
 773                         request; this effectively ignores the headers
 774                         in the spec for a single request.
 775        :type _headers: dict, optional
 776        :param _host_index: set to override the host_index for a single
 777                            request; this effectively ignores the host_index
 778                            in the spec for a single request.
 779        :type _host_index: int, optional
 780        :return: Returns the result object.
 781        """ # noqa: E501
 782
 783        _param = self._get_ai_platform_connector_serialize(
 784            organization_id=organization_id,
 785            ai_platform_connector_id=ai_platform_connector_id,
 786            _request_auth=_request_auth,
 787            _content_type=_content_type,
 788            _headers=_headers,
 789            _host_index=_host_index
 790        )
 791
 792        _response_types_map: Dict[str, Optional[str]] = {
 793            '200': "AIPlatformConnector",
 794            '400': "GetPipelines400Response",
 795            '401': "GetPipelines400Response",
 796            '403': "GetPipelines400Response",
 797            '404': "GetPipelines400Response",
 798            '500': "GetPipelines400Response",
 799        }
 800        response_data = self.api_client.call_api(
 801            *_param,
 802            _request_timeout=_request_timeout
 803        )
 804        response_data.read()
 805        return self.api_client.response_deserialize(
 806            response_data=response_data,
 807            response_types_map=_response_types_map,
 808        )
 809
 810
 811    @validate_call
 812    def get_ai_platform_connector_without_preload_content(
 813        self,
 814        organization_id: StrictStr,
 815        ai_platform_connector_id: StrictStr,
 816        _request_timeout: Union[
 817            None,
 818            Annotated[StrictFloat, Field(gt=0)],
 819            Tuple[
 820                Annotated[StrictFloat, Field(gt=0)],
 821                Annotated[StrictFloat, Field(gt=0)]
 822            ]
 823        ] = None,
 824        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 825        _content_type: Optional[StrictStr] = None,
 826        _headers: Optional[Dict[StrictStr, Any]] = None,
 827        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 828    ) -> RESTResponseType:
 829        """Get an AI platform connector
 830
 831        Get an AI platform connector
 832
 833        :param organization_id: (required)
 834        :type organization_id: str
 835        :param ai_platform_connector_id: (required)
 836        :type ai_platform_connector_id: str
 837        :param _request_timeout: timeout setting for this request. If one
 838                                 number provided, it will be total request
 839                                 timeout. It can also be a pair (tuple) of
 840                                 (connection, read) timeouts.
 841        :type _request_timeout: int, tuple(int, int), optional
 842        :param _request_auth: set to override the auth_settings for an a single
 843                              request; this effectively ignores the
 844                              authentication in the spec for a single request.
 845        :type _request_auth: dict, optional
 846        :param _content_type: force content-type for the request.
 847        :type _content_type: str, Optional
 848        :param _headers: set to override the headers for a single
 849                         request; this effectively ignores the headers
 850                         in the spec for a single request.
 851        :type _headers: dict, optional
 852        :param _host_index: set to override the host_index for a single
 853                            request; this effectively ignores the host_index
 854                            in the spec for a single request.
 855        :type _host_index: int, optional
 856        :return: Returns the result object.
 857        """ # noqa: E501
 858
 859        _param = self._get_ai_platform_connector_serialize(
 860            organization_id=organization_id,
 861            ai_platform_connector_id=ai_platform_connector_id,
 862            _request_auth=_request_auth,
 863            _content_type=_content_type,
 864            _headers=_headers,
 865            _host_index=_host_index
 866        )
 867
 868        _response_types_map: Dict[str, Optional[str]] = {
 869            '200': "AIPlatformConnector",
 870            '400': "GetPipelines400Response",
 871            '401': "GetPipelines400Response",
 872            '403': "GetPipelines400Response",
 873            '404': "GetPipelines400Response",
 874            '500': "GetPipelines400Response",
 875        }
 876        response_data = self.api_client.call_api(
 877            *_param,
 878            _request_timeout=_request_timeout
 879        )
 880        return response_data.response
 881
 882
 883    def _get_ai_platform_connector_serialize(
 884        self,
 885        organization_id,
 886        ai_platform_connector_id,
 887        _request_auth,
 888        _content_type,
 889        _headers,
 890        _host_index,
 891    ) -> RequestSerialized:
 892
 893        _host = None
 894
 895        _collection_formats: Dict[str, str] = {
 896        }
 897
 898        _path_params: Dict[str, str] = {}
 899        _query_params: List[Tuple[str, str]] = []
 900        _header_params: Dict[str, Optional[str]] = _headers or {}
 901        _form_params: List[Tuple[str, str]] = []
 902        _files: Dict[
 903            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
 904        ] = {}
 905        _body_params: Optional[bytes] = None
 906
 907        # process the path parameters
 908        if organization_id is not None:
 909            _path_params['organizationId'] = organization_id
 910        if ai_platform_connector_id is not None:
 911            _path_params['aiPlatformConnectorId'] = ai_platform_connector_id
 912        # process the query parameters
 913        # process the header parameters
 914        # process the form parameters
 915        # process the body parameter
 916
 917
 918        # set the HTTP header `Accept`
 919        if 'Accept' not in _header_params:
 920            _header_params['Accept'] = self.api_client.select_header_accept(
 921                [
 922                    'application/json'
 923                ]
 924            )
 925
 926
 927        # authentication setting
 928        _auth_settings: List[str] = [
 929            'bearerAuth'
 930        ]
 931
 932        return self.api_client.param_serialize(
 933            method='GET',
 934            resource_path='/org/{organizationId}/connectors/aiplatforms/{aiPlatformConnectorId}',
 935            path_params=_path_params,
 936            query_params=_query_params,
 937            header_params=_header_params,
 938            body=_body_params,
 939            post_params=_form_params,
 940            files=_files,
 941            auth_settings=_auth_settings,
 942            collection_formats=_collection_formats,
 943            _host=_host,
 944            _request_auth=_request_auth
 945        )
 946
 947
 948
 949
 950    @validate_call
 951    def get_ai_platform_connectors(
 952        self,
 953        organization_id: StrictStr,
 954        workspace_id: Optional[StrictStr] = None,
 955        _request_timeout: Union[
 956            None,
 957            Annotated[StrictFloat, Field(gt=0)],
 958            Tuple[
 959                Annotated[StrictFloat, Field(gt=0)],
 960                Annotated[StrictFloat, Field(gt=0)]
 961            ]
 962        ] = None,
 963        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 964        _content_type: Optional[StrictStr] = None,
 965        _headers: Optional[Dict[StrictStr, Any]] = None,
 966        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 967    ) -> GetAIPlatformConnectors200Response:
 968        """Get all existing AI Platform connectors
 969
 970        Get all existing AI Platform connectors
 971
 972        :param organization_id: (required)
 973        :type organization_id: str
 974        :param workspace_id:
 975        :type workspace_id: str
 976        :param _request_timeout: timeout setting for this request. If one
 977                                 number provided, it will be total request
 978                                 timeout. It can also be a pair (tuple) of
 979                                 (connection, read) timeouts.
 980        :type _request_timeout: int, tuple(int, int), optional
 981        :param _request_auth: set to override the auth_settings for an a single
 982                              request; this effectively ignores the
 983                              authentication in the spec for a single request.
 984        :type _request_auth: dict, optional
 985        :param _content_type: force content-type for the request.
 986        :type _content_type: str, Optional
 987        :param _headers: set to override the headers for a single
 988                         request; this effectively ignores the headers
 989                         in the spec for a single request.
 990        :type _headers: dict, optional
 991        :param _host_index: set to override the host_index for a single
 992                            request; this effectively ignores the host_index
 993                            in the spec for a single request.
 994        :type _host_index: int, optional
 995        :return: Returns the result object.
 996        """ # noqa: E501
 997
 998        _param = self._get_ai_platform_connectors_serialize(
 999            organization_id=organization_id,
1000            workspace_id=workspace_id,
1001            _request_auth=_request_auth,
1002            _content_type=_content_type,
1003            _headers=_headers,
1004            _host_index=_host_index
1005        )
1006
1007        _response_types_map: Dict[str, Optional[str]] = {
1008            '200': "GetAIPlatformConnectors200Response",
1009            '400': "GetPipelines400Response",
1010            '401': "GetPipelines400Response",
1011            '403': "GetPipelines400Response",
1012            '404': "GetPipelines400Response",
1013            '500': "GetPipelines400Response",
1014        }
1015        response_data = self.api_client.call_api(
1016            *_param,
1017            _request_timeout=_request_timeout
1018        )
1019        response_data.read()
1020        return self.api_client.response_deserialize(
1021            response_data=response_data,
1022            response_types_map=_response_types_map,
1023        ).data
1024
1025
1026    @validate_call
1027    def get_ai_platform_connectors_with_http_info(
1028        self,
1029        organization_id: StrictStr,
1030        workspace_id: Optional[StrictStr] = None,
1031        _request_timeout: Union[
1032            None,
1033            Annotated[StrictFloat, Field(gt=0)],
1034            Tuple[
1035                Annotated[StrictFloat, Field(gt=0)],
1036                Annotated[StrictFloat, Field(gt=0)]
1037            ]
1038        ] = None,
1039        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1040        _content_type: Optional[StrictStr] = None,
1041        _headers: Optional[Dict[StrictStr, Any]] = None,
1042        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1043    ) -> ApiResponse[GetAIPlatformConnectors200Response]:
1044        """Get all existing AI Platform connectors
1045
1046        Get all existing AI Platform connectors
1047
1048        :param organization_id: (required)
1049        :type organization_id: str
1050        :param workspace_id:
1051        :type workspace_id: str
1052        :param _request_timeout: timeout setting for this request. If one
1053                                 number provided, it will be total request
1054                                 timeout. It can also be a pair (tuple) of
1055                                 (connection, read) timeouts.
1056        :type _request_timeout: int, tuple(int, int), optional
1057        :param _request_auth: set to override the auth_settings for an a single
1058                              request; this effectively ignores the
1059                              authentication in the spec for a single request.
1060        :type _request_auth: dict, optional
1061        :param _content_type: force content-type for the request.
1062        :type _content_type: str, Optional
1063        :param _headers: set to override the headers for a single
1064                         request; this effectively ignores the headers
1065                         in the spec for a single request.
1066        :type _headers: dict, optional
1067        :param _host_index: set to override the host_index for a single
1068                            request; this effectively ignores the host_index
1069                            in the spec for a single request.
1070        :type _host_index: int, optional
1071        :return: Returns the result object.
1072        """ # noqa: E501
1073
1074        _param = self._get_ai_platform_connectors_serialize(
1075            organization_id=organization_id,
1076            workspace_id=workspace_id,
1077            _request_auth=_request_auth,
1078            _content_type=_content_type,
1079            _headers=_headers,
1080            _host_index=_host_index
1081        )
1082
1083        _response_types_map: Dict[str, Optional[str]] = {
1084            '200': "GetAIPlatformConnectors200Response",
1085            '400': "GetPipelines400Response",
1086            '401': "GetPipelines400Response",
1087            '403': "GetPipelines400Response",
1088            '404': "GetPipelines400Response",
1089            '500': "GetPipelines400Response",
1090        }
1091        response_data = self.api_client.call_api(
1092            *_param,
1093            _request_timeout=_request_timeout
1094        )
1095        response_data.read()
1096        return self.api_client.response_deserialize(
1097            response_data=response_data,
1098            response_types_map=_response_types_map,
1099        )
1100
1101
1102    @validate_call
1103    def get_ai_platform_connectors_without_preload_content(
1104        self,
1105        organization_id: StrictStr,
1106        workspace_id: Optional[StrictStr] = None,
1107        _request_timeout: Union[
1108            None,
1109            Annotated[StrictFloat, Field(gt=0)],
1110            Tuple[
1111                Annotated[StrictFloat, Field(gt=0)],
1112                Annotated[StrictFloat, Field(gt=0)]
1113            ]
1114        ] = None,
1115        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1116        _content_type: Optional[StrictStr] = None,
1117        _headers: Optional[Dict[StrictStr, Any]] = None,
1118        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1119    ) -> RESTResponseType:
1120        """Get all existing AI Platform connectors
1121
1122        Get all existing AI Platform connectors
1123
1124        :param organization_id: (required)
1125        :type organization_id: str
1126        :param workspace_id:
1127        :type workspace_id: str
1128        :param _request_timeout: timeout setting for this request. If one
1129                                 number provided, it will be total request
1130                                 timeout. It can also be a pair (tuple) of
1131                                 (connection, read) timeouts.
1132        :type _request_timeout: int, tuple(int, int), optional
1133        :param _request_auth: set to override the auth_settings for an a single
1134                              request; this effectively ignores the
1135                              authentication in the spec for a single request.
1136        :type _request_auth: dict, optional
1137        :param _content_type: force content-type for the request.
1138        :type _content_type: str, Optional
1139        :param _headers: set to override the headers for a single
1140                         request; this effectively ignores the headers
1141                         in the spec for a single request.
1142        :type _headers: dict, optional
1143        :param _host_index: set to override the host_index for a single
1144                            request; this effectively ignores the host_index
1145                            in the spec for a single request.
1146        :type _host_index: int, optional
1147        :return: Returns the result object.
1148        """ # noqa: E501
1149
1150        _param = self._get_ai_platform_connectors_serialize(
1151            organization_id=organization_id,
1152            workspace_id=workspace_id,
1153            _request_auth=_request_auth,
1154            _content_type=_content_type,
1155            _headers=_headers,
1156            _host_index=_host_index
1157        )
1158
1159        _response_types_map: Dict[str, Optional[str]] = {
1160            '200': "GetAIPlatformConnectors200Response",
1161            '400': "GetPipelines400Response",
1162            '401': "GetPipelines400Response",
1163            '403': "GetPipelines400Response",
1164            '404': "GetPipelines400Response",
1165            '500': "GetPipelines400Response",
1166        }
1167        response_data = self.api_client.call_api(
1168            *_param,
1169            _request_timeout=_request_timeout
1170        )
1171        return response_data.response
1172
1173
1174    def _get_ai_platform_connectors_serialize(
1175        self,
1176        organization_id,
1177        workspace_id,
1178        _request_auth,
1179        _content_type,
1180        _headers,
1181        _host_index,
1182    ) -> RequestSerialized:
1183
1184        _host = None
1185
1186        _collection_formats: Dict[str, str] = {
1187        }
1188
1189        _path_params: Dict[str, str] = {}
1190        _query_params: List[Tuple[str, str]] = []
1191        _header_params: Dict[str, Optional[str]] = _headers or {}
1192        _form_params: List[Tuple[str, str]] = []
1193        _files: Dict[
1194            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1195        ] = {}
1196        _body_params: Optional[bytes] = None
1197
1198        # process the path parameters
1199        if organization_id is not None:
1200            _path_params['organizationId'] = organization_id
1201        # process the query parameters
1202        if workspace_id is not None:
1203            
1204            _query_params.append(('workspaceId', workspace_id))
1205            
1206        # process the header parameters
1207        # process the form parameters
1208        # process the body parameter
1209
1210
1211        # set the HTTP header `Accept`
1212        if 'Accept' not in _header_params:
1213            _header_params['Accept'] = self.api_client.select_header_accept(
1214                [
1215                    'application/json'
1216                ]
1217            )
1218
1219
1220        # authentication setting
1221        _auth_settings: List[str] = [
1222            'bearerAuth'
1223        ]
1224
1225        return self.api_client.param_serialize(
1226            method='GET',
1227            resource_path='/org/{organizationId}/connectors/aiplatforms',
1228            path_params=_path_params,
1229            query_params=_query_params,
1230            header_params=_header_params,
1231            body=_body_params,
1232            post_params=_form_params,
1233            files=_files,
1234            auth_settings=_auth_settings,
1235            collection_formats=_collection_formats,
1236            _host=_host,
1237            _request_auth=_request_auth
1238        )
1239
1240
1241
1242
1243    @validate_call
1244    def update_ai_platform_connector(
1245        self,
1246        organization_id: StrictStr,
1247        ai_platform_connector_id: StrictStr,
1248        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1249        _request_timeout: Union[
1250            None,
1251            Annotated[StrictFloat, Field(gt=0)],
1252            Tuple[
1253                Annotated[StrictFloat, Field(gt=0)],
1254                Annotated[StrictFloat, Field(gt=0)]
1255            ]
1256        ] = None,
1257        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1258        _content_type: Optional[StrictStr] = None,
1259        _headers: Optional[Dict[StrictStr, Any]] = None,
1260        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1261    ) -> UpdateAIPlatformConnectorResponse:
1262        """Update an AI Platform connector
1263
1264        Update an AI Platform connector
1265
1266        :param organization_id: (required)
1267        :type organization_id: str
1268        :param ai_platform_connector_id: (required)
1269        :type ai_platform_connector_id: str
1270        :param update_ai_platform_connector_request: (required)
1271        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1272        :param _request_timeout: timeout setting for this request. If one
1273                                 number provided, it will be total request
1274                                 timeout. It can also be a pair (tuple) of
1275                                 (connection, read) timeouts.
1276        :type _request_timeout: int, tuple(int, int), optional
1277        :param _request_auth: set to override the auth_settings for an a single
1278                              request; this effectively ignores the
1279                              authentication in the spec for a single request.
1280        :type _request_auth: dict, optional
1281        :param _content_type: force content-type for the request.
1282        :type _content_type: str, Optional
1283        :param _headers: set to override the headers for a single
1284                         request; this effectively ignores the headers
1285                         in the spec for a single request.
1286        :type _headers: dict, optional
1287        :param _host_index: set to override the host_index for a single
1288                            request; this effectively ignores the host_index
1289                            in the spec for a single request.
1290        :type _host_index: int, optional
1291        :return: Returns the result object.
1292        """ # noqa: E501
1293
1294        _param = self._update_ai_platform_connector_serialize(
1295            organization_id=organization_id,
1296            ai_platform_connector_id=ai_platform_connector_id,
1297            update_ai_platform_connector_request=update_ai_platform_connector_request,
1298            _request_auth=_request_auth,
1299            _content_type=_content_type,
1300            _headers=_headers,
1301            _host_index=_host_index
1302        )
1303
1304        _response_types_map: Dict[str, Optional[str]] = {
1305            '200': "UpdateAIPlatformConnectorResponse",
1306            '400': "GetPipelines400Response",
1307            '401': "GetPipelines400Response",
1308            '403': "GetPipelines400Response",
1309            '404': "GetPipelines400Response",
1310            '500': "GetPipelines400Response",
1311        }
1312        response_data = self.api_client.call_api(
1313            *_param,
1314            _request_timeout=_request_timeout
1315        )
1316        response_data.read()
1317        return self.api_client.response_deserialize(
1318            response_data=response_data,
1319            response_types_map=_response_types_map,
1320        ).data
1321
1322
1323    @validate_call
1324    def update_ai_platform_connector_with_http_info(
1325        self,
1326        organization_id: StrictStr,
1327        ai_platform_connector_id: StrictStr,
1328        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1329        _request_timeout: Union[
1330            None,
1331            Annotated[StrictFloat, Field(gt=0)],
1332            Tuple[
1333                Annotated[StrictFloat, Field(gt=0)],
1334                Annotated[StrictFloat, Field(gt=0)]
1335            ]
1336        ] = None,
1337        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1338        _content_type: Optional[StrictStr] = None,
1339        _headers: Optional[Dict[StrictStr, Any]] = None,
1340        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1341    ) -> ApiResponse[UpdateAIPlatformConnectorResponse]:
1342        """Update an AI Platform connector
1343
1344        Update an AI Platform connector
1345
1346        :param organization_id: (required)
1347        :type organization_id: str
1348        :param ai_platform_connector_id: (required)
1349        :type ai_platform_connector_id: str
1350        :param update_ai_platform_connector_request: (required)
1351        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1352        :param _request_timeout: timeout setting for this request. If one
1353                                 number provided, it will be total request
1354                                 timeout. It can also be a pair (tuple) of
1355                                 (connection, read) timeouts.
1356        :type _request_timeout: int, tuple(int, int), optional
1357        :param _request_auth: set to override the auth_settings for an a single
1358                              request; this effectively ignores the
1359                              authentication in the spec for a single request.
1360        :type _request_auth: dict, optional
1361        :param _content_type: force content-type for the request.
1362        :type _content_type: str, Optional
1363        :param _headers: set to override the headers for a single
1364                         request; this effectively ignores the headers
1365                         in the spec for a single request.
1366        :type _headers: dict, optional
1367        :param _host_index: set to override the host_index for a single
1368                            request; this effectively ignores the host_index
1369                            in the spec for a single request.
1370        :type _host_index: int, optional
1371        :return: Returns the result object.
1372        """ # noqa: E501
1373
1374        _param = self._update_ai_platform_connector_serialize(
1375            organization_id=organization_id,
1376            ai_platform_connector_id=ai_platform_connector_id,
1377            update_ai_platform_connector_request=update_ai_platform_connector_request,
1378            _request_auth=_request_auth,
1379            _content_type=_content_type,
1380            _headers=_headers,
1381            _host_index=_host_index
1382        )
1383
1384        _response_types_map: Dict[str, Optional[str]] = {
1385            '200': "UpdateAIPlatformConnectorResponse",
1386            '400': "GetPipelines400Response",
1387            '401': "GetPipelines400Response",
1388            '403': "GetPipelines400Response",
1389            '404': "GetPipelines400Response",
1390            '500': "GetPipelines400Response",
1391        }
1392        response_data = self.api_client.call_api(
1393            *_param,
1394            _request_timeout=_request_timeout
1395        )
1396        response_data.read()
1397        return self.api_client.response_deserialize(
1398            response_data=response_data,
1399            response_types_map=_response_types_map,
1400        )
1401
1402
1403    @validate_call
1404    def update_ai_platform_connector_without_preload_content(
1405        self,
1406        organization_id: StrictStr,
1407        ai_platform_connector_id: StrictStr,
1408        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1409        _request_timeout: Union[
1410            None,
1411            Annotated[StrictFloat, Field(gt=0)],
1412            Tuple[
1413                Annotated[StrictFloat, Field(gt=0)],
1414                Annotated[StrictFloat, Field(gt=0)]
1415            ]
1416        ] = None,
1417        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1418        _content_type: Optional[StrictStr] = None,
1419        _headers: Optional[Dict[StrictStr, Any]] = None,
1420        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1421    ) -> RESTResponseType:
1422        """Update an AI Platform connector
1423
1424        Update an AI Platform connector
1425
1426        :param organization_id: (required)
1427        :type organization_id: str
1428        :param ai_platform_connector_id: (required)
1429        :type ai_platform_connector_id: str
1430        :param update_ai_platform_connector_request: (required)
1431        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1432        :param _request_timeout: timeout setting for this request. If one
1433                                 number provided, it will be total request
1434                                 timeout. It can also be a pair (tuple) of
1435                                 (connection, read) timeouts.
1436        :type _request_timeout: int, tuple(int, int), optional
1437        :param _request_auth: set to override the auth_settings for an a single
1438                              request; this effectively ignores the
1439                              authentication in the spec for a single request.
1440        :type _request_auth: dict, optional
1441        :param _content_type: force content-type for the request.
1442        :type _content_type: str, Optional
1443        :param _headers: set to override the headers for a single
1444                         request; this effectively ignores the headers
1445                         in the spec for a single request.
1446        :type _headers: dict, optional
1447        :param _host_index: set to override the host_index for a single
1448                            request; this effectively ignores the host_index
1449                            in the spec for a single request.
1450        :type _host_index: int, optional
1451        :return: Returns the result object.
1452        """ # noqa: E501
1453
1454        _param = self._update_ai_platform_connector_serialize(
1455            organization_id=organization_id,
1456            ai_platform_connector_id=ai_platform_connector_id,
1457            update_ai_platform_connector_request=update_ai_platform_connector_request,
1458            _request_auth=_request_auth,
1459            _content_type=_content_type,
1460            _headers=_headers,
1461            _host_index=_host_index
1462        )
1463
1464        _response_types_map: Dict[str, Optional[str]] = {
1465            '200': "UpdateAIPlatformConnectorResponse",
1466            '400': "GetPipelines400Response",
1467            '401': "GetPipelines400Response",
1468            '403': "GetPipelines400Response",
1469            '404': "GetPipelines400Response",
1470            '500': "GetPipelines400Response",
1471        }
1472        response_data = self.api_client.call_api(
1473            *_param,
1474            _request_timeout=_request_timeout
1475        )
1476        return response_data.response
1477
1478
1479    def _update_ai_platform_connector_serialize(
1480        self,
1481        organization_id,
1482        ai_platform_connector_id,
1483        update_ai_platform_connector_request,
1484        _request_auth,
1485        _content_type,
1486        _headers,
1487        _host_index,
1488    ) -> RequestSerialized:
1489
1490        _host = None
1491
1492        _collection_formats: Dict[str, str] = {
1493        }
1494
1495        _path_params: Dict[str, str] = {}
1496        _query_params: List[Tuple[str, str]] = []
1497        _header_params: Dict[str, Optional[str]] = _headers or {}
1498        _form_params: List[Tuple[str, str]] = []
1499        _files: Dict[
1500            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1501        ] = {}
1502        _body_params: Optional[bytes] = None
1503
1504        # process the path parameters
1505        if organization_id is not None:
1506            _path_params['organizationId'] = organization_id
1507        if ai_platform_connector_id is not None:
1508            _path_params['aiPlatformConnectorId'] = ai_platform_connector_id
1509        # process the query parameters
1510        # process the header parameters
1511        # process the form parameters
1512        # process the body parameter
1513        if update_ai_platform_connector_request is not None:
1514            _body_params = update_ai_platform_connector_request
1515
1516
1517        # set the HTTP header `Accept`
1518        if 'Accept' not in _header_params:
1519            _header_params['Accept'] = self.api_client.select_header_accept(
1520                [
1521                    'application/json'
1522                ]
1523            )
1524
1525        # set the HTTP header `Content-Type`
1526        if _content_type:
1527            _header_params['Content-Type'] = _content_type
1528        else:
1529            _default_content_type = (
1530                self.api_client.select_header_content_type(
1531                    [
1532                        'application/json'
1533                    ]
1534                )
1535            )
1536            if _default_content_type is not None:
1537                _header_params['Content-Type'] = _default_content_type
1538
1539        # authentication setting
1540        _auth_settings: List[str] = [
1541            'bearerAuth'
1542        ]
1543
1544        return self.api_client.param_serialize(
1545            method='PATCH',
1546            resource_path='/org/{organizationId}/connectors/aiplatforms/{aiPlatformConnectorId}',
1547            path_params=_path_params,
1548            query_params=_query_params,
1549            header_params=_header_params,
1550            body=_body_params,
1551            post_params=_form_params,
1552            files=_files,
1553            auth_settings=_auth_settings,
1554            collection_formats=_collection_formats,
1555            _host=_host,
1556            _request_auth=_request_auth
1557        )
class AIPlatformConnectorsApi:
  35class AIPlatformConnectorsApi:
  36    """NOTE: This class is auto generated by OpenAPI Generator
  37    Ref: https://openapi-generator.tech
  38
  39    Do not edit the class manually.
  40    """
  41
  42    def __init__(self, api_client=None) -> None:
  43        if api_client is None:
  44            api_client = ApiClient.get_default()
  45        self.api_client = api_client
  46
  47
  48    @validate_call
  49    def create_ai_platform_connector(
  50        self,
  51        organization_id: StrictStr,
  52        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
  53        workspace_id: Optional[StrictStr] = None,
  54        _request_timeout: Union[
  55            None,
  56            Annotated[StrictFloat, Field(gt=0)],
  57            Tuple[
  58                Annotated[StrictFloat, Field(gt=0)],
  59                Annotated[StrictFloat, Field(gt=0)]
  60            ]
  61        ] = None,
  62        _request_auth: Optional[Dict[StrictStr, Any]] = None,
  63        _content_type: Optional[StrictStr] = None,
  64        _headers: Optional[Dict[StrictStr, Any]] = None,
  65        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
  66    ) -> CreateAIPlatformConnectorResponse:
  67        """Create a new AI platform connector
  68
  69        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
  70
  71        :param organization_id: (required)
  72        :type organization_id: str
  73        :param create_ai_platform_connector_request: (required)
  74        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
  75        :param workspace_id:
  76        :type workspace_id: str
  77        :param _request_timeout: timeout setting for this request. If one
  78                                 number provided, it will be total request
  79                                 timeout. It can also be a pair (tuple) of
  80                                 (connection, read) timeouts.
  81        :type _request_timeout: int, tuple(int, int), optional
  82        :param _request_auth: set to override the auth_settings for an a single
  83                              request; this effectively ignores the
  84                              authentication in the spec for a single request.
  85        :type _request_auth: dict, optional
  86        :param _content_type: force content-type for the request.
  87        :type _content_type: str, Optional
  88        :param _headers: set to override the headers for a single
  89                         request; this effectively ignores the headers
  90                         in the spec for a single request.
  91        :type _headers: dict, optional
  92        :param _host_index: set to override the host_index for a single
  93                            request; this effectively ignores the host_index
  94                            in the spec for a single request.
  95        :type _host_index: int, optional
  96        :return: Returns the result object.
  97        """ # noqa: E501
  98
  99        _param = self._create_ai_platform_connector_serialize(
 100            organization_id=organization_id,
 101            create_ai_platform_connector_request=create_ai_platform_connector_request,
 102            workspace_id=workspace_id,
 103            _request_auth=_request_auth,
 104            _content_type=_content_type,
 105            _headers=_headers,
 106            _host_index=_host_index
 107        )
 108
 109        _response_types_map: Dict[str, Optional[str]] = {
 110            '200': "CreateAIPlatformConnectorResponse",
 111            '400': "GetPipelines400Response",
 112            '401': "GetPipelines400Response",
 113            '403': "GetPipelines400Response",
 114            '404': "GetPipelines400Response",
 115            '500': "GetPipelines400Response",
 116        }
 117        response_data = self.api_client.call_api(
 118            *_param,
 119            _request_timeout=_request_timeout
 120        )
 121        response_data.read()
 122        return self.api_client.response_deserialize(
 123            response_data=response_data,
 124            response_types_map=_response_types_map,
 125        ).data
 126
 127
 128    @validate_call
 129    def create_ai_platform_connector_with_http_info(
 130        self,
 131        organization_id: StrictStr,
 132        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
 133        workspace_id: Optional[StrictStr] = None,
 134        _request_timeout: Union[
 135            None,
 136            Annotated[StrictFloat, Field(gt=0)],
 137            Tuple[
 138                Annotated[StrictFloat, Field(gt=0)],
 139                Annotated[StrictFloat, Field(gt=0)]
 140            ]
 141        ] = None,
 142        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 143        _content_type: Optional[StrictStr] = None,
 144        _headers: Optional[Dict[StrictStr, Any]] = None,
 145        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 146    ) -> ApiResponse[CreateAIPlatformConnectorResponse]:
 147        """Create a new AI platform connector
 148
 149        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
 150
 151        :param organization_id: (required)
 152        :type organization_id: str
 153        :param create_ai_platform_connector_request: (required)
 154        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
 155        :param workspace_id:
 156        :type workspace_id: str
 157        :param _request_timeout: timeout setting for this request. If one
 158                                 number provided, it will be total request
 159                                 timeout. It can also be a pair (tuple) of
 160                                 (connection, read) timeouts.
 161        :type _request_timeout: int, tuple(int, int), optional
 162        :param _request_auth: set to override the auth_settings for an a single
 163                              request; this effectively ignores the
 164                              authentication in the spec for a single request.
 165        :type _request_auth: dict, optional
 166        :param _content_type: force content-type for the request.
 167        :type _content_type: str, Optional
 168        :param _headers: set to override the headers for a single
 169                         request; this effectively ignores the headers
 170                         in the spec for a single request.
 171        :type _headers: dict, optional
 172        :param _host_index: set to override the host_index for a single
 173                            request; this effectively ignores the host_index
 174                            in the spec for a single request.
 175        :type _host_index: int, optional
 176        :return: Returns the result object.
 177        """ # noqa: E501
 178
 179        _param = self._create_ai_platform_connector_serialize(
 180            organization_id=organization_id,
 181            create_ai_platform_connector_request=create_ai_platform_connector_request,
 182            workspace_id=workspace_id,
 183            _request_auth=_request_auth,
 184            _content_type=_content_type,
 185            _headers=_headers,
 186            _host_index=_host_index
 187        )
 188
 189        _response_types_map: Dict[str, Optional[str]] = {
 190            '200': "CreateAIPlatformConnectorResponse",
 191            '400': "GetPipelines400Response",
 192            '401': "GetPipelines400Response",
 193            '403': "GetPipelines400Response",
 194            '404': "GetPipelines400Response",
 195            '500': "GetPipelines400Response",
 196        }
 197        response_data = self.api_client.call_api(
 198            *_param,
 199            _request_timeout=_request_timeout
 200        )
 201        response_data.read()
 202        return self.api_client.response_deserialize(
 203            response_data=response_data,
 204            response_types_map=_response_types_map,
 205        )
 206
 207
 208    @validate_call
 209    def create_ai_platform_connector_without_preload_content(
 210        self,
 211        organization_id: StrictStr,
 212        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
 213        workspace_id: Optional[StrictStr] = None,
 214        _request_timeout: Union[
 215            None,
 216            Annotated[StrictFloat, Field(gt=0)],
 217            Tuple[
 218                Annotated[StrictFloat, Field(gt=0)],
 219                Annotated[StrictFloat, Field(gt=0)]
 220            ]
 221        ] = None,
 222        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 223        _content_type: Optional[StrictStr] = None,
 224        _headers: Optional[Dict[StrictStr, Any]] = None,
 225        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 226    ) -> RESTResponseType:
 227        """Create a new AI platform connector
 228
 229        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
 230
 231        :param organization_id: (required)
 232        :type organization_id: str
 233        :param create_ai_platform_connector_request: (required)
 234        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
 235        :param workspace_id:
 236        :type workspace_id: str
 237        :param _request_timeout: timeout setting for this request. If one
 238                                 number provided, it will be total request
 239                                 timeout. It can also be a pair (tuple) of
 240                                 (connection, read) timeouts.
 241        :type _request_timeout: int, tuple(int, int), optional
 242        :param _request_auth: set to override the auth_settings for an a single
 243                              request; this effectively ignores the
 244                              authentication in the spec for a single request.
 245        :type _request_auth: dict, optional
 246        :param _content_type: force content-type for the request.
 247        :type _content_type: str, Optional
 248        :param _headers: set to override the headers for a single
 249                         request; this effectively ignores the headers
 250                         in the spec for a single request.
 251        :type _headers: dict, optional
 252        :param _host_index: set to override the host_index for a single
 253                            request; this effectively ignores the host_index
 254                            in the spec for a single request.
 255        :type _host_index: int, optional
 256        :return: Returns the result object.
 257        """ # noqa: E501
 258
 259        _param = self._create_ai_platform_connector_serialize(
 260            organization_id=organization_id,
 261            create_ai_platform_connector_request=create_ai_platform_connector_request,
 262            workspace_id=workspace_id,
 263            _request_auth=_request_auth,
 264            _content_type=_content_type,
 265            _headers=_headers,
 266            _host_index=_host_index
 267        )
 268
 269        _response_types_map: Dict[str, Optional[str]] = {
 270            '200': "CreateAIPlatformConnectorResponse",
 271            '400': "GetPipelines400Response",
 272            '401': "GetPipelines400Response",
 273            '403': "GetPipelines400Response",
 274            '404': "GetPipelines400Response",
 275            '500': "GetPipelines400Response",
 276        }
 277        response_data = self.api_client.call_api(
 278            *_param,
 279            _request_timeout=_request_timeout
 280        )
 281        return response_data.response
 282
 283
 284    def _create_ai_platform_connector_serialize(
 285        self,
 286        organization_id,
 287        create_ai_platform_connector_request,
 288        workspace_id,
 289        _request_auth,
 290        _content_type,
 291        _headers,
 292        _host_index,
 293    ) -> RequestSerialized:
 294
 295        _host = None
 296
 297        _collection_formats: Dict[str, str] = {
 298        }
 299
 300        _path_params: Dict[str, str] = {}
 301        _query_params: List[Tuple[str, str]] = []
 302        _header_params: Dict[str, Optional[str]] = _headers or {}
 303        _form_params: List[Tuple[str, str]] = []
 304        _files: Dict[
 305            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
 306        ] = {}
 307        _body_params: Optional[bytes] = None
 308
 309        # process the path parameters
 310        if organization_id is not None:
 311            _path_params['organizationId'] = organization_id
 312        # process the query parameters
 313        if workspace_id is not None:
 314            
 315            _query_params.append(('workspaceId', workspace_id))
 316            
 317        # process the header parameters
 318        # process the form parameters
 319        # process the body parameter
 320        if create_ai_platform_connector_request is not None:
 321            _body_params = create_ai_platform_connector_request
 322
 323
 324        # set the HTTP header `Accept`
 325        if 'Accept' not in _header_params:
 326            _header_params['Accept'] = self.api_client.select_header_accept(
 327                [
 328                    'application/json'
 329                ]
 330            )
 331
 332        # set the HTTP header `Content-Type`
 333        if _content_type:
 334            _header_params['Content-Type'] = _content_type
 335        else:
 336            _default_content_type = (
 337                self.api_client.select_header_content_type(
 338                    [
 339                        'application/json'
 340                    ]
 341                )
 342            )
 343            if _default_content_type is not None:
 344                _header_params['Content-Type'] = _default_content_type
 345
 346        # authentication setting
 347        _auth_settings: List[str] = [
 348            'bearerAuth'
 349        ]
 350
 351        return self.api_client.param_serialize(
 352            method='POST',
 353            resource_path='/org/{organizationId}/connectors/aiplatforms',
 354            path_params=_path_params,
 355            query_params=_query_params,
 356            header_params=_header_params,
 357            body=_body_params,
 358            post_params=_form_params,
 359            files=_files,
 360            auth_settings=_auth_settings,
 361            collection_formats=_collection_formats,
 362            _host=_host,
 363            _request_auth=_request_auth
 364        )
 365
 366
 367
 368
 369    @validate_call
 370    def delete_ai_platform_connector(
 371        self,
 372        organization_id: StrictStr,
 373        ai_platform_connector_id: StrictStr,
 374        _request_timeout: Union[
 375            None,
 376            Annotated[StrictFloat, Field(gt=0)],
 377            Tuple[
 378                Annotated[StrictFloat, Field(gt=0)],
 379                Annotated[StrictFloat, Field(gt=0)]
 380            ]
 381        ] = None,
 382        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 383        _content_type: Optional[StrictStr] = None,
 384        _headers: Optional[Dict[StrictStr, Any]] = None,
 385        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 386    ) -> DeleteAIPlatformConnectorResponse:
 387        """Delete an AI platform connector
 388
 389        Delete an AI platform connector
 390
 391        :param organization_id: (required)
 392        :type organization_id: str
 393        :param ai_platform_connector_id: (required)
 394        :type ai_platform_connector_id: str
 395        :param _request_timeout: timeout setting for this request. If one
 396                                 number provided, it will be total request
 397                                 timeout. It can also be a pair (tuple) of
 398                                 (connection, read) timeouts.
 399        :type _request_timeout: int, tuple(int, int), optional
 400        :param _request_auth: set to override the auth_settings for an a single
 401                              request; this effectively ignores the
 402                              authentication in the spec for a single request.
 403        :type _request_auth: dict, optional
 404        :param _content_type: force content-type for the request.
 405        :type _content_type: str, Optional
 406        :param _headers: set to override the headers for a single
 407                         request; this effectively ignores the headers
 408                         in the spec for a single request.
 409        :type _headers: dict, optional
 410        :param _host_index: set to override the host_index for a single
 411                            request; this effectively ignores the host_index
 412                            in the spec for a single request.
 413        :type _host_index: int, optional
 414        :return: Returns the result object.
 415        """ # noqa: E501
 416
 417        _param = self._delete_ai_platform_connector_serialize(
 418            organization_id=organization_id,
 419            ai_platform_connector_id=ai_platform_connector_id,
 420            _request_auth=_request_auth,
 421            _content_type=_content_type,
 422            _headers=_headers,
 423            _host_index=_host_index
 424        )
 425
 426        _response_types_map: Dict[str, Optional[str]] = {
 427            '200': "DeleteAIPlatformConnectorResponse",
 428            '400': "GetPipelines400Response",
 429            '401': "GetPipelines400Response",
 430            '403': "GetPipelines400Response",
 431            '404': "GetPipelines400Response",
 432            '500': "GetPipelines400Response",
 433        }
 434        response_data = self.api_client.call_api(
 435            *_param,
 436            _request_timeout=_request_timeout
 437        )
 438        response_data.read()
 439        return self.api_client.response_deserialize(
 440            response_data=response_data,
 441            response_types_map=_response_types_map,
 442        ).data
 443
 444
 445    @validate_call
 446    def delete_ai_platform_connector_with_http_info(
 447        self,
 448        organization_id: StrictStr,
 449        ai_platform_connector_id: StrictStr,
 450        _request_timeout: Union[
 451            None,
 452            Annotated[StrictFloat, Field(gt=0)],
 453            Tuple[
 454                Annotated[StrictFloat, Field(gt=0)],
 455                Annotated[StrictFloat, Field(gt=0)]
 456            ]
 457        ] = None,
 458        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 459        _content_type: Optional[StrictStr] = None,
 460        _headers: Optional[Dict[StrictStr, Any]] = None,
 461        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 462    ) -> ApiResponse[DeleteAIPlatformConnectorResponse]:
 463        """Delete an AI platform connector
 464
 465        Delete an AI platform connector
 466
 467        :param organization_id: (required)
 468        :type organization_id: str
 469        :param ai_platform_connector_id: (required)
 470        :type ai_platform_connector_id: str
 471        :param _request_timeout: timeout setting for this request. If one
 472                                 number provided, it will be total request
 473                                 timeout. It can also be a pair (tuple) of
 474                                 (connection, read) timeouts.
 475        :type _request_timeout: int, tuple(int, int), optional
 476        :param _request_auth: set to override the auth_settings for an a single
 477                              request; this effectively ignores the
 478                              authentication in the spec for a single request.
 479        :type _request_auth: dict, optional
 480        :param _content_type: force content-type for the request.
 481        :type _content_type: str, Optional
 482        :param _headers: set to override the headers for a single
 483                         request; this effectively ignores the headers
 484                         in the spec for a single request.
 485        :type _headers: dict, optional
 486        :param _host_index: set to override the host_index for a single
 487                            request; this effectively ignores the host_index
 488                            in the spec for a single request.
 489        :type _host_index: int, optional
 490        :return: Returns the result object.
 491        """ # noqa: E501
 492
 493        _param = self._delete_ai_platform_connector_serialize(
 494            organization_id=organization_id,
 495            ai_platform_connector_id=ai_platform_connector_id,
 496            _request_auth=_request_auth,
 497            _content_type=_content_type,
 498            _headers=_headers,
 499            _host_index=_host_index
 500        )
 501
 502        _response_types_map: Dict[str, Optional[str]] = {
 503            '200': "DeleteAIPlatformConnectorResponse",
 504            '400': "GetPipelines400Response",
 505            '401': "GetPipelines400Response",
 506            '403': "GetPipelines400Response",
 507            '404': "GetPipelines400Response",
 508            '500': "GetPipelines400Response",
 509        }
 510        response_data = self.api_client.call_api(
 511            *_param,
 512            _request_timeout=_request_timeout
 513        )
 514        response_data.read()
 515        return self.api_client.response_deserialize(
 516            response_data=response_data,
 517            response_types_map=_response_types_map,
 518        )
 519
 520
 521    @validate_call
 522    def delete_ai_platform_connector_without_preload_content(
 523        self,
 524        organization_id: StrictStr,
 525        ai_platform_connector_id: StrictStr,
 526        _request_timeout: Union[
 527            None,
 528            Annotated[StrictFloat, Field(gt=0)],
 529            Tuple[
 530                Annotated[StrictFloat, Field(gt=0)],
 531                Annotated[StrictFloat, Field(gt=0)]
 532            ]
 533        ] = None,
 534        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 535        _content_type: Optional[StrictStr] = None,
 536        _headers: Optional[Dict[StrictStr, Any]] = None,
 537        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 538    ) -> RESTResponseType:
 539        """Delete an AI platform connector
 540
 541        Delete an AI platform connector
 542
 543        :param organization_id: (required)
 544        :type organization_id: str
 545        :param ai_platform_connector_id: (required)
 546        :type ai_platform_connector_id: str
 547        :param _request_timeout: timeout setting for this request. If one
 548                                 number provided, it will be total request
 549                                 timeout. It can also be a pair (tuple) of
 550                                 (connection, read) timeouts.
 551        :type _request_timeout: int, tuple(int, int), optional
 552        :param _request_auth: set to override the auth_settings for an a single
 553                              request; this effectively ignores the
 554                              authentication in the spec for a single request.
 555        :type _request_auth: dict, optional
 556        :param _content_type: force content-type for the request.
 557        :type _content_type: str, Optional
 558        :param _headers: set to override the headers for a single
 559                         request; this effectively ignores the headers
 560                         in the spec for a single request.
 561        :type _headers: dict, optional
 562        :param _host_index: set to override the host_index for a single
 563                            request; this effectively ignores the host_index
 564                            in the spec for a single request.
 565        :type _host_index: int, optional
 566        :return: Returns the result object.
 567        """ # noqa: E501
 568
 569        _param = self._delete_ai_platform_connector_serialize(
 570            organization_id=organization_id,
 571            ai_platform_connector_id=ai_platform_connector_id,
 572            _request_auth=_request_auth,
 573            _content_type=_content_type,
 574            _headers=_headers,
 575            _host_index=_host_index
 576        )
 577
 578        _response_types_map: Dict[str, Optional[str]] = {
 579            '200': "DeleteAIPlatformConnectorResponse",
 580            '400': "GetPipelines400Response",
 581            '401': "GetPipelines400Response",
 582            '403': "GetPipelines400Response",
 583            '404': "GetPipelines400Response",
 584            '500': "GetPipelines400Response",
 585        }
 586        response_data = self.api_client.call_api(
 587            *_param,
 588            _request_timeout=_request_timeout
 589        )
 590        return response_data.response
 591
 592
 593    def _delete_ai_platform_connector_serialize(
 594        self,
 595        organization_id,
 596        ai_platform_connector_id,
 597        _request_auth,
 598        _content_type,
 599        _headers,
 600        _host_index,
 601    ) -> RequestSerialized:
 602
 603        _host = None
 604
 605        _collection_formats: Dict[str, str] = {
 606        }
 607
 608        _path_params: Dict[str, str] = {}
 609        _query_params: List[Tuple[str, str]] = []
 610        _header_params: Dict[str, Optional[str]] = _headers or {}
 611        _form_params: List[Tuple[str, str]] = []
 612        _files: Dict[
 613            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
 614        ] = {}
 615        _body_params: Optional[bytes] = None
 616
 617        # process the path parameters
 618        if organization_id is not None:
 619            _path_params['organizationId'] = organization_id
 620        if ai_platform_connector_id is not None:
 621            _path_params['aiPlatformConnectorId'] = ai_platform_connector_id
 622        # process the query parameters
 623        # process the header parameters
 624        # process the form parameters
 625        # process the body parameter
 626
 627
 628        # set the HTTP header `Accept`
 629        if 'Accept' not in _header_params:
 630            _header_params['Accept'] = self.api_client.select_header_accept(
 631                [
 632                    'application/json'
 633                ]
 634            )
 635
 636
 637        # authentication setting
 638        _auth_settings: List[str] = [
 639            'bearerAuth'
 640        ]
 641
 642        return self.api_client.param_serialize(
 643            method='DELETE',
 644            resource_path='/org/{organizationId}/connectors/aiplatforms/{aiPlatformConnectorId}',
 645            path_params=_path_params,
 646            query_params=_query_params,
 647            header_params=_header_params,
 648            body=_body_params,
 649            post_params=_form_params,
 650            files=_files,
 651            auth_settings=_auth_settings,
 652            collection_formats=_collection_formats,
 653            _host=_host,
 654            _request_auth=_request_auth
 655        )
 656
 657
 658
 659
 660    @validate_call
 661    def get_ai_platform_connector(
 662        self,
 663        organization_id: StrictStr,
 664        ai_platform_connector_id: StrictStr,
 665        _request_timeout: Union[
 666            None,
 667            Annotated[StrictFloat, Field(gt=0)],
 668            Tuple[
 669                Annotated[StrictFloat, Field(gt=0)],
 670                Annotated[StrictFloat, Field(gt=0)]
 671            ]
 672        ] = None,
 673        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 674        _content_type: Optional[StrictStr] = None,
 675        _headers: Optional[Dict[StrictStr, Any]] = None,
 676        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 677    ) -> AIPlatformConnector:
 678        """Get an AI platform connector
 679
 680        Get an AI platform connector
 681
 682        :param organization_id: (required)
 683        :type organization_id: str
 684        :param ai_platform_connector_id: (required)
 685        :type ai_platform_connector_id: str
 686        :param _request_timeout: timeout setting for this request. If one
 687                                 number provided, it will be total request
 688                                 timeout. It can also be a pair (tuple) of
 689                                 (connection, read) timeouts.
 690        :type _request_timeout: int, tuple(int, int), optional
 691        :param _request_auth: set to override the auth_settings for an a single
 692                              request; this effectively ignores the
 693                              authentication in the spec for a single request.
 694        :type _request_auth: dict, optional
 695        :param _content_type: force content-type for the request.
 696        :type _content_type: str, Optional
 697        :param _headers: set to override the headers for a single
 698                         request; this effectively ignores the headers
 699                         in the spec for a single request.
 700        :type _headers: dict, optional
 701        :param _host_index: set to override the host_index for a single
 702                            request; this effectively ignores the host_index
 703                            in the spec for a single request.
 704        :type _host_index: int, optional
 705        :return: Returns the result object.
 706        """ # noqa: E501
 707
 708        _param = self._get_ai_platform_connector_serialize(
 709            organization_id=organization_id,
 710            ai_platform_connector_id=ai_platform_connector_id,
 711            _request_auth=_request_auth,
 712            _content_type=_content_type,
 713            _headers=_headers,
 714            _host_index=_host_index
 715        )
 716
 717        _response_types_map: Dict[str, Optional[str]] = {
 718            '200': "AIPlatformConnector",
 719            '400': "GetPipelines400Response",
 720            '401': "GetPipelines400Response",
 721            '403': "GetPipelines400Response",
 722            '404': "GetPipelines400Response",
 723            '500': "GetPipelines400Response",
 724        }
 725        response_data = self.api_client.call_api(
 726            *_param,
 727            _request_timeout=_request_timeout
 728        )
 729        response_data.read()
 730        return self.api_client.response_deserialize(
 731            response_data=response_data,
 732            response_types_map=_response_types_map,
 733        ).data
 734
 735
 736    @validate_call
 737    def get_ai_platform_connector_with_http_info(
 738        self,
 739        organization_id: StrictStr,
 740        ai_platform_connector_id: StrictStr,
 741        _request_timeout: Union[
 742            None,
 743            Annotated[StrictFloat, Field(gt=0)],
 744            Tuple[
 745                Annotated[StrictFloat, Field(gt=0)],
 746                Annotated[StrictFloat, Field(gt=0)]
 747            ]
 748        ] = None,
 749        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 750        _content_type: Optional[StrictStr] = None,
 751        _headers: Optional[Dict[StrictStr, Any]] = None,
 752        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 753    ) -> ApiResponse[AIPlatformConnector]:
 754        """Get an AI platform connector
 755
 756        Get an AI platform connector
 757
 758        :param organization_id: (required)
 759        :type organization_id: str
 760        :param ai_platform_connector_id: (required)
 761        :type ai_platform_connector_id: str
 762        :param _request_timeout: timeout setting for this request. If one
 763                                 number provided, it will be total request
 764                                 timeout. It can also be a pair (tuple) of
 765                                 (connection, read) timeouts.
 766        :type _request_timeout: int, tuple(int, int), optional
 767        :param _request_auth: set to override the auth_settings for an a single
 768                              request; this effectively ignores the
 769                              authentication in the spec for a single request.
 770        :type _request_auth: dict, optional
 771        :param _content_type: force content-type for the request.
 772        :type _content_type: str, Optional
 773        :param _headers: set to override the headers for a single
 774                         request; this effectively ignores the headers
 775                         in the spec for a single request.
 776        :type _headers: dict, optional
 777        :param _host_index: set to override the host_index for a single
 778                            request; this effectively ignores the host_index
 779                            in the spec for a single request.
 780        :type _host_index: int, optional
 781        :return: Returns the result object.
 782        """ # noqa: E501
 783
 784        _param = self._get_ai_platform_connector_serialize(
 785            organization_id=organization_id,
 786            ai_platform_connector_id=ai_platform_connector_id,
 787            _request_auth=_request_auth,
 788            _content_type=_content_type,
 789            _headers=_headers,
 790            _host_index=_host_index
 791        )
 792
 793        _response_types_map: Dict[str, Optional[str]] = {
 794            '200': "AIPlatformConnector",
 795            '400': "GetPipelines400Response",
 796            '401': "GetPipelines400Response",
 797            '403': "GetPipelines400Response",
 798            '404': "GetPipelines400Response",
 799            '500': "GetPipelines400Response",
 800        }
 801        response_data = self.api_client.call_api(
 802            *_param,
 803            _request_timeout=_request_timeout
 804        )
 805        response_data.read()
 806        return self.api_client.response_deserialize(
 807            response_data=response_data,
 808            response_types_map=_response_types_map,
 809        )
 810
 811
 812    @validate_call
 813    def get_ai_platform_connector_without_preload_content(
 814        self,
 815        organization_id: StrictStr,
 816        ai_platform_connector_id: StrictStr,
 817        _request_timeout: Union[
 818            None,
 819            Annotated[StrictFloat, Field(gt=0)],
 820            Tuple[
 821                Annotated[StrictFloat, Field(gt=0)],
 822                Annotated[StrictFloat, Field(gt=0)]
 823            ]
 824        ] = None,
 825        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 826        _content_type: Optional[StrictStr] = None,
 827        _headers: Optional[Dict[StrictStr, Any]] = None,
 828        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 829    ) -> RESTResponseType:
 830        """Get an AI platform connector
 831
 832        Get an AI platform connector
 833
 834        :param organization_id: (required)
 835        :type organization_id: str
 836        :param ai_platform_connector_id: (required)
 837        :type ai_platform_connector_id: str
 838        :param _request_timeout: timeout setting for this request. If one
 839                                 number provided, it will be total request
 840                                 timeout. It can also be a pair (tuple) of
 841                                 (connection, read) timeouts.
 842        :type _request_timeout: int, tuple(int, int), optional
 843        :param _request_auth: set to override the auth_settings for an a single
 844                              request; this effectively ignores the
 845                              authentication in the spec for a single request.
 846        :type _request_auth: dict, optional
 847        :param _content_type: force content-type for the request.
 848        :type _content_type: str, Optional
 849        :param _headers: set to override the headers for a single
 850                         request; this effectively ignores the headers
 851                         in the spec for a single request.
 852        :type _headers: dict, optional
 853        :param _host_index: set to override the host_index for a single
 854                            request; this effectively ignores the host_index
 855                            in the spec for a single request.
 856        :type _host_index: int, optional
 857        :return: Returns the result object.
 858        """ # noqa: E501
 859
 860        _param = self._get_ai_platform_connector_serialize(
 861            organization_id=organization_id,
 862            ai_platform_connector_id=ai_platform_connector_id,
 863            _request_auth=_request_auth,
 864            _content_type=_content_type,
 865            _headers=_headers,
 866            _host_index=_host_index
 867        )
 868
 869        _response_types_map: Dict[str, Optional[str]] = {
 870            '200': "AIPlatformConnector",
 871            '400': "GetPipelines400Response",
 872            '401': "GetPipelines400Response",
 873            '403': "GetPipelines400Response",
 874            '404': "GetPipelines400Response",
 875            '500': "GetPipelines400Response",
 876        }
 877        response_data = self.api_client.call_api(
 878            *_param,
 879            _request_timeout=_request_timeout
 880        )
 881        return response_data.response
 882
 883
 884    def _get_ai_platform_connector_serialize(
 885        self,
 886        organization_id,
 887        ai_platform_connector_id,
 888        _request_auth,
 889        _content_type,
 890        _headers,
 891        _host_index,
 892    ) -> RequestSerialized:
 893
 894        _host = None
 895
 896        _collection_formats: Dict[str, str] = {
 897        }
 898
 899        _path_params: Dict[str, str] = {}
 900        _query_params: List[Tuple[str, str]] = []
 901        _header_params: Dict[str, Optional[str]] = _headers or {}
 902        _form_params: List[Tuple[str, str]] = []
 903        _files: Dict[
 904            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
 905        ] = {}
 906        _body_params: Optional[bytes] = None
 907
 908        # process the path parameters
 909        if organization_id is not None:
 910            _path_params['organizationId'] = organization_id
 911        if ai_platform_connector_id is not None:
 912            _path_params['aiPlatformConnectorId'] = ai_platform_connector_id
 913        # process the query parameters
 914        # process the header parameters
 915        # process the form parameters
 916        # process the body parameter
 917
 918
 919        # set the HTTP header `Accept`
 920        if 'Accept' not in _header_params:
 921            _header_params['Accept'] = self.api_client.select_header_accept(
 922                [
 923                    'application/json'
 924                ]
 925            )
 926
 927
 928        # authentication setting
 929        _auth_settings: List[str] = [
 930            'bearerAuth'
 931        ]
 932
 933        return self.api_client.param_serialize(
 934            method='GET',
 935            resource_path='/org/{organizationId}/connectors/aiplatforms/{aiPlatformConnectorId}',
 936            path_params=_path_params,
 937            query_params=_query_params,
 938            header_params=_header_params,
 939            body=_body_params,
 940            post_params=_form_params,
 941            files=_files,
 942            auth_settings=_auth_settings,
 943            collection_formats=_collection_formats,
 944            _host=_host,
 945            _request_auth=_request_auth
 946        )
 947
 948
 949
 950
 951    @validate_call
 952    def get_ai_platform_connectors(
 953        self,
 954        organization_id: StrictStr,
 955        workspace_id: Optional[StrictStr] = None,
 956        _request_timeout: Union[
 957            None,
 958            Annotated[StrictFloat, Field(gt=0)],
 959            Tuple[
 960                Annotated[StrictFloat, Field(gt=0)],
 961                Annotated[StrictFloat, Field(gt=0)]
 962            ]
 963        ] = None,
 964        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 965        _content_type: Optional[StrictStr] = None,
 966        _headers: Optional[Dict[StrictStr, Any]] = None,
 967        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 968    ) -> GetAIPlatformConnectors200Response:
 969        """Get all existing AI Platform connectors
 970
 971        Get all existing AI Platform connectors
 972
 973        :param organization_id: (required)
 974        :type organization_id: str
 975        :param workspace_id:
 976        :type workspace_id: str
 977        :param _request_timeout: timeout setting for this request. If one
 978                                 number provided, it will be total request
 979                                 timeout. It can also be a pair (tuple) of
 980                                 (connection, read) timeouts.
 981        :type _request_timeout: int, tuple(int, int), optional
 982        :param _request_auth: set to override the auth_settings for an a single
 983                              request; this effectively ignores the
 984                              authentication in the spec for a single request.
 985        :type _request_auth: dict, optional
 986        :param _content_type: force content-type for the request.
 987        :type _content_type: str, Optional
 988        :param _headers: set to override the headers for a single
 989                         request; this effectively ignores the headers
 990                         in the spec for a single request.
 991        :type _headers: dict, optional
 992        :param _host_index: set to override the host_index for a single
 993                            request; this effectively ignores the host_index
 994                            in the spec for a single request.
 995        :type _host_index: int, optional
 996        :return: Returns the result object.
 997        """ # noqa: E501
 998
 999        _param = self._get_ai_platform_connectors_serialize(
1000            organization_id=organization_id,
1001            workspace_id=workspace_id,
1002            _request_auth=_request_auth,
1003            _content_type=_content_type,
1004            _headers=_headers,
1005            _host_index=_host_index
1006        )
1007
1008        _response_types_map: Dict[str, Optional[str]] = {
1009            '200': "GetAIPlatformConnectors200Response",
1010            '400': "GetPipelines400Response",
1011            '401': "GetPipelines400Response",
1012            '403': "GetPipelines400Response",
1013            '404': "GetPipelines400Response",
1014            '500': "GetPipelines400Response",
1015        }
1016        response_data = self.api_client.call_api(
1017            *_param,
1018            _request_timeout=_request_timeout
1019        )
1020        response_data.read()
1021        return self.api_client.response_deserialize(
1022            response_data=response_data,
1023            response_types_map=_response_types_map,
1024        ).data
1025
1026
1027    @validate_call
1028    def get_ai_platform_connectors_with_http_info(
1029        self,
1030        organization_id: StrictStr,
1031        workspace_id: Optional[StrictStr] = None,
1032        _request_timeout: Union[
1033            None,
1034            Annotated[StrictFloat, Field(gt=0)],
1035            Tuple[
1036                Annotated[StrictFloat, Field(gt=0)],
1037                Annotated[StrictFloat, Field(gt=0)]
1038            ]
1039        ] = None,
1040        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1041        _content_type: Optional[StrictStr] = None,
1042        _headers: Optional[Dict[StrictStr, Any]] = None,
1043        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1044    ) -> ApiResponse[GetAIPlatformConnectors200Response]:
1045        """Get all existing AI Platform connectors
1046
1047        Get all existing AI Platform connectors
1048
1049        :param organization_id: (required)
1050        :type organization_id: str
1051        :param workspace_id:
1052        :type workspace_id: str
1053        :param _request_timeout: timeout setting for this request. If one
1054                                 number provided, it will be total request
1055                                 timeout. It can also be a pair (tuple) of
1056                                 (connection, read) timeouts.
1057        :type _request_timeout: int, tuple(int, int), optional
1058        :param _request_auth: set to override the auth_settings for an a single
1059                              request; this effectively ignores the
1060                              authentication in the spec for a single request.
1061        :type _request_auth: dict, optional
1062        :param _content_type: force content-type for the request.
1063        :type _content_type: str, Optional
1064        :param _headers: set to override the headers for a single
1065                         request; this effectively ignores the headers
1066                         in the spec for a single request.
1067        :type _headers: dict, optional
1068        :param _host_index: set to override the host_index for a single
1069                            request; this effectively ignores the host_index
1070                            in the spec for a single request.
1071        :type _host_index: int, optional
1072        :return: Returns the result object.
1073        """ # noqa: E501
1074
1075        _param = self._get_ai_platform_connectors_serialize(
1076            organization_id=organization_id,
1077            workspace_id=workspace_id,
1078            _request_auth=_request_auth,
1079            _content_type=_content_type,
1080            _headers=_headers,
1081            _host_index=_host_index
1082        )
1083
1084        _response_types_map: Dict[str, Optional[str]] = {
1085            '200': "GetAIPlatformConnectors200Response",
1086            '400': "GetPipelines400Response",
1087            '401': "GetPipelines400Response",
1088            '403': "GetPipelines400Response",
1089            '404': "GetPipelines400Response",
1090            '500': "GetPipelines400Response",
1091        }
1092        response_data = self.api_client.call_api(
1093            *_param,
1094            _request_timeout=_request_timeout
1095        )
1096        response_data.read()
1097        return self.api_client.response_deserialize(
1098            response_data=response_data,
1099            response_types_map=_response_types_map,
1100        )
1101
1102
1103    @validate_call
1104    def get_ai_platform_connectors_without_preload_content(
1105        self,
1106        organization_id: StrictStr,
1107        workspace_id: Optional[StrictStr] = None,
1108        _request_timeout: Union[
1109            None,
1110            Annotated[StrictFloat, Field(gt=0)],
1111            Tuple[
1112                Annotated[StrictFloat, Field(gt=0)],
1113                Annotated[StrictFloat, Field(gt=0)]
1114            ]
1115        ] = None,
1116        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1117        _content_type: Optional[StrictStr] = None,
1118        _headers: Optional[Dict[StrictStr, Any]] = None,
1119        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1120    ) -> RESTResponseType:
1121        """Get all existing AI Platform connectors
1122
1123        Get all existing AI Platform connectors
1124
1125        :param organization_id: (required)
1126        :type organization_id: str
1127        :param workspace_id:
1128        :type workspace_id: str
1129        :param _request_timeout: timeout setting for this request. If one
1130                                 number provided, it will be total request
1131                                 timeout. It can also be a pair (tuple) of
1132                                 (connection, read) timeouts.
1133        :type _request_timeout: int, tuple(int, int), optional
1134        :param _request_auth: set to override the auth_settings for an a single
1135                              request; this effectively ignores the
1136                              authentication in the spec for a single request.
1137        :type _request_auth: dict, optional
1138        :param _content_type: force content-type for the request.
1139        :type _content_type: str, Optional
1140        :param _headers: set to override the headers for a single
1141                         request; this effectively ignores the headers
1142                         in the spec for a single request.
1143        :type _headers: dict, optional
1144        :param _host_index: set to override the host_index for a single
1145                            request; this effectively ignores the host_index
1146                            in the spec for a single request.
1147        :type _host_index: int, optional
1148        :return: Returns the result object.
1149        """ # noqa: E501
1150
1151        _param = self._get_ai_platform_connectors_serialize(
1152            organization_id=organization_id,
1153            workspace_id=workspace_id,
1154            _request_auth=_request_auth,
1155            _content_type=_content_type,
1156            _headers=_headers,
1157            _host_index=_host_index
1158        )
1159
1160        _response_types_map: Dict[str, Optional[str]] = {
1161            '200': "GetAIPlatformConnectors200Response",
1162            '400': "GetPipelines400Response",
1163            '401': "GetPipelines400Response",
1164            '403': "GetPipelines400Response",
1165            '404': "GetPipelines400Response",
1166            '500': "GetPipelines400Response",
1167        }
1168        response_data = self.api_client.call_api(
1169            *_param,
1170            _request_timeout=_request_timeout
1171        )
1172        return response_data.response
1173
1174
1175    def _get_ai_platform_connectors_serialize(
1176        self,
1177        organization_id,
1178        workspace_id,
1179        _request_auth,
1180        _content_type,
1181        _headers,
1182        _host_index,
1183    ) -> RequestSerialized:
1184
1185        _host = None
1186
1187        _collection_formats: Dict[str, str] = {
1188        }
1189
1190        _path_params: Dict[str, str] = {}
1191        _query_params: List[Tuple[str, str]] = []
1192        _header_params: Dict[str, Optional[str]] = _headers or {}
1193        _form_params: List[Tuple[str, str]] = []
1194        _files: Dict[
1195            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1196        ] = {}
1197        _body_params: Optional[bytes] = None
1198
1199        # process the path parameters
1200        if organization_id is not None:
1201            _path_params['organizationId'] = organization_id
1202        # process the query parameters
1203        if workspace_id is not None:
1204            
1205            _query_params.append(('workspaceId', workspace_id))
1206            
1207        # process the header parameters
1208        # process the form parameters
1209        # process the body parameter
1210
1211
1212        # set the HTTP header `Accept`
1213        if 'Accept' not in _header_params:
1214            _header_params['Accept'] = self.api_client.select_header_accept(
1215                [
1216                    'application/json'
1217                ]
1218            )
1219
1220
1221        # authentication setting
1222        _auth_settings: List[str] = [
1223            'bearerAuth'
1224        ]
1225
1226        return self.api_client.param_serialize(
1227            method='GET',
1228            resource_path='/org/{organizationId}/connectors/aiplatforms',
1229            path_params=_path_params,
1230            query_params=_query_params,
1231            header_params=_header_params,
1232            body=_body_params,
1233            post_params=_form_params,
1234            files=_files,
1235            auth_settings=_auth_settings,
1236            collection_formats=_collection_formats,
1237            _host=_host,
1238            _request_auth=_request_auth
1239        )
1240
1241
1242
1243
1244    @validate_call
1245    def update_ai_platform_connector(
1246        self,
1247        organization_id: StrictStr,
1248        ai_platform_connector_id: StrictStr,
1249        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1250        _request_timeout: Union[
1251            None,
1252            Annotated[StrictFloat, Field(gt=0)],
1253            Tuple[
1254                Annotated[StrictFloat, Field(gt=0)],
1255                Annotated[StrictFloat, Field(gt=0)]
1256            ]
1257        ] = None,
1258        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1259        _content_type: Optional[StrictStr] = None,
1260        _headers: Optional[Dict[StrictStr, Any]] = None,
1261        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1262    ) -> UpdateAIPlatformConnectorResponse:
1263        """Update an AI Platform connector
1264
1265        Update an AI Platform connector
1266
1267        :param organization_id: (required)
1268        :type organization_id: str
1269        :param ai_platform_connector_id: (required)
1270        :type ai_platform_connector_id: str
1271        :param update_ai_platform_connector_request: (required)
1272        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1273        :param _request_timeout: timeout setting for this request. If one
1274                                 number provided, it will be total request
1275                                 timeout. It can also be a pair (tuple) of
1276                                 (connection, read) timeouts.
1277        :type _request_timeout: int, tuple(int, int), optional
1278        :param _request_auth: set to override the auth_settings for an a single
1279                              request; this effectively ignores the
1280                              authentication in the spec for a single request.
1281        :type _request_auth: dict, optional
1282        :param _content_type: force content-type for the request.
1283        :type _content_type: str, Optional
1284        :param _headers: set to override the headers for a single
1285                         request; this effectively ignores the headers
1286                         in the spec for a single request.
1287        :type _headers: dict, optional
1288        :param _host_index: set to override the host_index for a single
1289                            request; this effectively ignores the host_index
1290                            in the spec for a single request.
1291        :type _host_index: int, optional
1292        :return: Returns the result object.
1293        """ # noqa: E501
1294
1295        _param = self._update_ai_platform_connector_serialize(
1296            organization_id=organization_id,
1297            ai_platform_connector_id=ai_platform_connector_id,
1298            update_ai_platform_connector_request=update_ai_platform_connector_request,
1299            _request_auth=_request_auth,
1300            _content_type=_content_type,
1301            _headers=_headers,
1302            _host_index=_host_index
1303        )
1304
1305        _response_types_map: Dict[str, Optional[str]] = {
1306            '200': "UpdateAIPlatformConnectorResponse",
1307            '400': "GetPipelines400Response",
1308            '401': "GetPipelines400Response",
1309            '403': "GetPipelines400Response",
1310            '404': "GetPipelines400Response",
1311            '500': "GetPipelines400Response",
1312        }
1313        response_data = self.api_client.call_api(
1314            *_param,
1315            _request_timeout=_request_timeout
1316        )
1317        response_data.read()
1318        return self.api_client.response_deserialize(
1319            response_data=response_data,
1320            response_types_map=_response_types_map,
1321        ).data
1322
1323
1324    @validate_call
1325    def update_ai_platform_connector_with_http_info(
1326        self,
1327        organization_id: StrictStr,
1328        ai_platform_connector_id: StrictStr,
1329        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1330        _request_timeout: Union[
1331            None,
1332            Annotated[StrictFloat, Field(gt=0)],
1333            Tuple[
1334                Annotated[StrictFloat, Field(gt=0)],
1335                Annotated[StrictFloat, Field(gt=0)]
1336            ]
1337        ] = None,
1338        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1339        _content_type: Optional[StrictStr] = None,
1340        _headers: Optional[Dict[StrictStr, Any]] = None,
1341        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1342    ) -> ApiResponse[UpdateAIPlatformConnectorResponse]:
1343        """Update an AI Platform connector
1344
1345        Update an AI Platform connector
1346
1347        :param organization_id: (required)
1348        :type organization_id: str
1349        :param ai_platform_connector_id: (required)
1350        :type ai_platform_connector_id: str
1351        :param update_ai_platform_connector_request: (required)
1352        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1353        :param _request_timeout: timeout setting for this request. If one
1354                                 number provided, it will be total request
1355                                 timeout. It can also be a pair (tuple) of
1356                                 (connection, read) timeouts.
1357        :type _request_timeout: int, tuple(int, int), optional
1358        :param _request_auth: set to override the auth_settings for an a single
1359                              request; this effectively ignores the
1360                              authentication in the spec for a single request.
1361        :type _request_auth: dict, optional
1362        :param _content_type: force content-type for the request.
1363        :type _content_type: str, Optional
1364        :param _headers: set to override the headers for a single
1365                         request; this effectively ignores the headers
1366                         in the spec for a single request.
1367        :type _headers: dict, optional
1368        :param _host_index: set to override the host_index for a single
1369                            request; this effectively ignores the host_index
1370                            in the spec for a single request.
1371        :type _host_index: int, optional
1372        :return: Returns the result object.
1373        """ # noqa: E501
1374
1375        _param = self._update_ai_platform_connector_serialize(
1376            organization_id=organization_id,
1377            ai_platform_connector_id=ai_platform_connector_id,
1378            update_ai_platform_connector_request=update_ai_platform_connector_request,
1379            _request_auth=_request_auth,
1380            _content_type=_content_type,
1381            _headers=_headers,
1382            _host_index=_host_index
1383        )
1384
1385        _response_types_map: Dict[str, Optional[str]] = {
1386            '200': "UpdateAIPlatformConnectorResponse",
1387            '400': "GetPipelines400Response",
1388            '401': "GetPipelines400Response",
1389            '403': "GetPipelines400Response",
1390            '404': "GetPipelines400Response",
1391            '500': "GetPipelines400Response",
1392        }
1393        response_data = self.api_client.call_api(
1394            *_param,
1395            _request_timeout=_request_timeout
1396        )
1397        response_data.read()
1398        return self.api_client.response_deserialize(
1399            response_data=response_data,
1400            response_types_map=_response_types_map,
1401        )
1402
1403
1404    @validate_call
1405    def update_ai_platform_connector_without_preload_content(
1406        self,
1407        organization_id: StrictStr,
1408        ai_platform_connector_id: StrictStr,
1409        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1410        _request_timeout: Union[
1411            None,
1412            Annotated[StrictFloat, Field(gt=0)],
1413            Tuple[
1414                Annotated[StrictFloat, Field(gt=0)],
1415                Annotated[StrictFloat, Field(gt=0)]
1416            ]
1417        ] = None,
1418        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1419        _content_type: Optional[StrictStr] = None,
1420        _headers: Optional[Dict[StrictStr, Any]] = None,
1421        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1422    ) -> RESTResponseType:
1423        """Update an AI Platform connector
1424
1425        Update an AI Platform connector
1426
1427        :param organization_id: (required)
1428        :type organization_id: str
1429        :param ai_platform_connector_id: (required)
1430        :type ai_platform_connector_id: str
1431        :param update_ai_platform_connector_request: (required)
1432        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1433        :param _request_timeout: timeout setting for this request. If one
1434                                 number provided, it will be total request
1435                                 timeout. It can also be a pair (tuple) of
1436                                 (connection, read) timeouts.
1437        :type _request_timeout: int, tuple(int, int), optional
1438        :param _request_auth: set to override the auth_settings for an a single
1439                              request; this effectively ignores the
1440                              authentication in the spec for a single request.
1441        :type _request_auth: dict, optional
1442        :param _content_type: force content-type for the request.
1443        :type _content_type: str, Optional
1444        :param _headers: set to override the headers for a single
1445                         request; this effectively ignores the headers
1446                         in the spec for a single request.
1447        :type _headers: dict, optional
1448        :param _host_index: set to override the host_index for a single
1449                            request; this effectively ignores the host_index
1450                            in the spec for a single request.
1451        :type _host_index: int, optional
1452        :return: Returns the result object.
1453        """ # noqa: E501
1454
1455        _param = self._update_ai_platform_connector_serialize(
1456            organization_id=organization_id,
1457            ai_platform_connector_id=ai_platform_connector_id,
1458            update_ai_platform_connector_request=update_ai_platform_connector_request,
1459            _request_auth=_request_auth,
1460            _content_type=_content_type,
1461            _headers=_headers,
1462            _host_index=_host_index
1463        )
1464
1465        _response_types_map: Dict[str, Optional[str]] = {
1466            '200': "UpdateAIPlatformConnectorResponse",
1467            '400': "GetPipelines400Response",
1468            '401': "GetPipelines400Response",
1469            '403': "GetPipelines400Response",
1470            '404': "GetPipelines400Response",
1471            '500': "GetPipelines400Response",
1472        }
1473        response_data = self.api_client.call_api(
1474            *_param,
1475            _request_timeout=_request_timeout
1476        )
1477        return response_data.response
1478
1479
1480    def _update_ai_platform_connector_serialize(
1481        self,
1482        organization_id,
1483        ai_platform_connector_id,
1484        update_ai_platform_connector_request,
1485        _request_auth,
1486        _content_type,
1487        _headers,
1488        _host_index,
1489    ) -> RequestSerialized:
1490
1491        _host = None
1492
1493        _collection_formats: Dict[str, str] = {
1494        }
1495
1496        _path_params: Dict[str, str] = {}
1497        _query_params: List[Tuple[str, str]] = []
1498        _header_params: Dict[str, Optional[str]] = _headers or {}
1499        _form_params: List[Tuple[str, str]] = []
1500        _files: Dict[
1501            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1502        ] = {}
1503        _body_params: Optional[bytes] = None
1504
1505        # process the path parameters
1506        if organization_id is not None:
1507            _path_params['organizationId'] = organization_id
1508        if ai_platform_connector_id is not None:
1509            _path_params['aiPlatformConnectorId'] = ai_platform_connector_id
1510        # process the query parameters
1511        # process the header parameters
1512        # process the form parameters
1513        # process the body parameter
1514        if update_ai_platform_connector_request is not None:
1515            _body_params = update_ai_platform_connector_request
1516
1517
1518        # set the HTTP header `Accept`
1519        if 'Accept' not in _header_params:
1520            _header_params['Accept'] = self.api_client.select_header_accept(
1521                [
1522                    'application/json'
1523                ]
1524            )
1525
1526        # set the HTTP header `Content-Type`
1527        if _content_type:
1528            _header_params['Content-Type'] = _content_type
1529        else:
1530            _default_content_type = (
1531                self.api_client.select_header_content_type(
1532                    [
1533                        'application/json'
1534                    ]
1535                )
1536            )
1537            if _default_content_type is not None:
1538                _header_params['Content-Type'] = _default_content_type
1539
1540        # authentication setting
1541        _auth_settings: List[str] = [
1542            'bearerAuth'
1543        ]
1544
1545        return self.api_client.param_serialize(
1546            method='PATCH',
1547            resource_path='/org/{organizationId}/connectors/aiplatforms/{aiPlatformConnectorId}',
1548            path_params=_path_params,
1549            query_params=_query_params,
1550            header_params=_header_params,
1551            body=_body_params,
1552            post_params=_form_params,
1553            files=_files,
1554            auth_settings=_auth_settings,
1555            collection_formats=_collection_formats,
1556            _host=_host,
1557            _request_auth=_request_auth
1558        )

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

AIPlatformConnectorsApi(api_client=None)
42    def __init__(self, api_client=None) -> None:
43        if api_client is None:
44            api_client = ApiClient.get_default()
45        self.api_client = api_client
api_client
@validate_call
def create_ai_platform_connector( self, organization_id: typing.Annotated[str, Strict(strict=True)], create_ai_platform_connector_request: vectorize_client.models.create_ai_platform_connector_request.CreateAIPlatformConnectorRequest, workspace_id: Optional[Annotated[str, Strict(strict=True)]] = None, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.models.create_ai_platform_connector_response.CreateAIPlatformConnectorResponse:
 48    @validate_call
 49    def create_ai_platform_connector(
 50        self,
 51        organization_id: StrictStr,
 52        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
 53        workspace_id: Optional[StrictStr] = None,
 54        _request_timeout: Union[
 55            None,
 56            Annotated[StrictFloat, Field(gt=0)],
 57            Tuple[
 58                Annotated[StrictFloat, Field(gt=0)],
 59                Annotated[StrictFloat, Field(gt=0)]
 60            ]
 61        ] = None,
 62        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 63        _content_type: Optional[StrictStr] = None,
 64        _headers: Optional[Dict[StrictStr, Any]] = None,
 65        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 66    ) -> CreateAIPlatformConnectorResponse:
 67        """Create a new AI platform connector
 68
 69        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
 70
 71        :param organization_id: (required)
 72        :type organization_id: str
 73        :param create_ai_platform_connector_request: (required)
 74        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
 75        :param workspace_id:
 76        :type workspace_id: str
 77        :param _request_timeout: timeout setting for this request. If one
 78                                 number provided, it will be total request
 79                                 timeout. It can also be a pair (tuple) of
 80                                 (connection, read) timeouts.
 81        :type _request_timeout: int, tuple(int, int), optional
 82        :param _request_auth: set to override the auth_settings for an a single
 83                              request; this effectively ignores the
 84                              authentication in the spec for a single request.
 85        :type _request_auth: dict, optional
 86        :param _content_type: force content-type for the request.
 87        :type _content_type: str, Optional
 88        :param _headers: set to override the headers for a single
 89                         request; this effectively ignores the headers
 90                         in the spec for a single request.
 91        :type _headers: dict, optional
 92        :param _host_index: set to override the host_index for a single
 93                            request; this effectively ignores the host_index
 94                            in the spec for a single request.
 95        :type _host_index: int, optional
 96        :return: Returns the result object.
 97        """ # noqa: E501
 98
 99        _param = self._create_ai_platform_connector_serialize(
100            organization_id=organization_id,
101            create_ai_platform_connector_request=create_ai_platform_connector_request,
102            workspace_id=workspace_id,
103            _request_auth=_request_auth,
104            _content_type=_content_type,
105            _headers=_headers,
106            _host_index=_host_index
107        )
108
109        _response_types_map: Dict[str, Optional[str]] = {
110            '200': "CreateAIPlatformConnectorResponse",
111            '400': "GetPipelines400Response",
112            '401': "GetPipelines400Response",
113            '403': "GetPipelines400Response",
114            '404': "GetPipelines400Response",
115            '500': "GetPipelines400Response",
116        }
117        response_data = self.api_client.call_api(
118            *_param,
119            _request_timeout=_request_timeout
120        )
121        response_data.read()
122        return self.api_client.response_deserialize(
123            response_data=response_data,
124            response_types_map=_response_types_map,
125        ).data

Create a new AI platform connector

Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.

Parameters
  • organization_id: (required)
  • create_ai_platform_connector_request: (required)
  • workspace_id:
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def create_ai_platform_connector_with_http_info( self, organization_id: typing.Annotated[str, Strict(strict=True)], create_ai_platform_connector_request: vectorize_client.models.create_ai_platform_connector_request.CreateAIPlatformConnectorRequest, workspace_id: Optional[Annotated[str, Strict(strict=True)]] = None, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.api_response.ApiResponse[CreateAIPlatformConnectorResponse]:
128    @validate_call
129    def create_ai_platform_connector_with_http_info(
130        self,
131        organization_id: StrictStr,
132        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
133        workspace_id: Optional[StrictStr] = None,
134        _request_timeout: Union[
135            None,
136            Annotated[StrictFloat, Field(gt=0)],
137            Tuple[
138                Annotated[StrictFloat, Field(gt=0)],
139                Annotated[StrictFloat, Field(gt=0)]
140            ]
141        ] = None,
142        _request_auth: Optional[Dict[StrictStr, Any]] = None,
143        _content_type: Optional[StrictStr] = None,
144        _headers: Optional[Dict[StrictStr, Any]] = None,
145        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
146    ) -> ApiResponse[CreateAIPlatformConnectorResponse]:
147        """Create a new AI platform connector
148
149        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
150
151        :param organization_id: (required)
152        :type organization_id: str
153        :param create_ai_platform_connector_request: (required)
154        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
155        :param workspace_id:
156        :type workspace_id: str
157        :param _request_timeout: timeout setting for this request. If one
158                                 number provided, it will be total request
159                                 timeout. It can also be a pair (tuple) of
160                                 (connection, read) timeouts.
161        :type _request_timeout: int, tuple(int, int), optional
162        :param _request_auth: set to override the auth_settings for an a single
163                              request; this effectively ignores the
164                              authentication in the spec for a single request.
165        :type _request_auth: dict, optional
166        :param _content_type: force content-type for the request.
167        :type _content_type: str, Optional
168        :param _headers: set to override the headers for a single
169                         request; this effectively ignores the headers
170                         in the spec for a single request.
171        :type _headers: dict, optional
172        :param _host_index: set to override the host_index for a single
173                            request; this effectively ignores the host_index
174                            in the spec for a single request.
175        :type _host_index: int, optional
176        :return: Returns the result object.
177        """ # noqa: E501
178
179        _param = self._create_ai_platform_connector_serialize(
180            organization_id=organization_id,
181            create_ai_platform_connector_request=create_ai_platform_connector_request,
182            workspace_id=workspace_id,
183            _request_auth=_request_auth,
184            _content_type=_content_type,
185            _headers=_headers,
186            _host_index=_host_index
187        )
188
189        _response_types_map: Dict[str, Optional[str]] = {
190            '200': "CreateAIPlatformConnectorResponse",
191            '400': "GetPipelines400Response",
192            '401': "GetPipelines400Response",
193            '403': "GetPipelines400Response",
194            '404': "GetPipelines400Response",
195            '500': "GetPipelines400Response",
196        }
197        response_data = self.api_client.call_api(
198            *_param,
199            _request_timeout=_request_timeout
200        )
201        response_data.read()
202        return self.api_client.response_deserialize(
203            response_data=response_data,
204            response_types_map=_response_types_map,
205        )

Create a new AI platform connector

Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.

Parameters
  • organization_id: (required)
  • create_ai_platform_connector_request: (required)
  • workspace_id:
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def create_ai_platform_connector_without_preload_content( self, organization_id: typing.Annotated[str, Strict(strict=True)], create_ai_platform_connector_request: vectorize_client.models.create_ai_platform_connector_request.CreateAIPlatformConnectorRequest, workspace_id: Optional[Annotated[str, Strict(strict=True)]] = None, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> urllib3.response.HTTPResponse:
208    @validate_call
209    def create_ai_platform_connector_without_preload_content(
210        self,
211        organization_id: StrictStr,
212        create_ai_platform_connector_request: CreateAIPlatformConnectorRequest,
213        workspace_id: Optional[StrictStr] = None,
214        _request_timeout: Union[
215            None,
216            Annotated[StrictFloat, Field(gt=0)],
217            Tuple[
218                Annotated[StrictFloat, Field(gt=0)],
219                Annotated[StrictFloat, Field(gt=0)]
220            ]
221        ] = None,
222        _request_auth: Optional[Dict[StrictStr, Any]] = None,
223        _content_type: Optional[StrictStr] = None,
224        _headers: Optional[Dict[StrictStr, Any]] = None,
225        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
226    ) -> RESTResponseType:
227        """Create a new AI platform connector
228
229        Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.
230
231        :param organization_id: (required)
232        :type organization_id: str
233        :param create_ai_platform_connector_request: (required)
234        :type create_ai_platform_connector_request: CreateAIPlatformConnectorRequest
235        :param workspace_id:
236        :type workspace_id: str
237        :param _request_timeout: timeout setting for this request. If one
238                                 number provided, it will be total request
239                                 timeout. It can also be a pair (tuple) of
240                                 (connection, read) timeouts.
241        :type _request_timeout: int, tuple(int, int), optional
242        :param _request_auth: set to override the auth_settings for an a single
243                              request; this effectively ignores the
244                              authentication in the spec for a single request.
245        :type _request_auth: dict, optional
246        :param _content_type: force content-type for the request.
247        :type _content_type: str, Optional
248        :param _headers: set to override the headers for a single
249                         request; this effectively ignores the headers
250                         in the spec for a single request.
251        :type _headers: dict, optional
252        :param _host_index: set to override the host_index for a single
253                            request; this effectively ignores the host_index
254                            in the spec for a single request.
255        :type _host_index: int, optional
256        :return: Returns the result object.
257        """ # noqa: E501
258
259        _param = self._create_ai_platform_connector_serialize(
260            organization_id=organization_id,
261            create_ai_platform_connector_request=create_ai_platform_connector_request,
262            workspace_id=workspace_id,
263            _request_auth=_request_auth,
264            _content_type=_content_type,
265            _headers=_headers,
266            _host_index=_host_index
267        )
268
269        _response_types_map: Dict[str, Optional[str]] = {
270            '200': "CreateAIPlatformConnectorResponse",
271            '400': "GetPipelines400Response",
272            '401': "GetPipelines400Response",
273            '403': "GetPipelines400Response",
274            '404': "GetPipelines400Response",
275            '500': "GetPipelines400Response",
276        }
277        response_data = self.api_client.call_api(
278            *_param,
279            _request_timeout=_request_timeout
280        )
281        return response_data.response

Create a new AI platform connector

Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected.

Parameters
  • organization_id: (required)
  • create_ai_platform_connector_request: (required)
  • workspace_id:
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def delete_ai_platform_connector( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.models.delete_ai_platform_connector_response.DeleteAIPlatformConnectorResponse:
369    @validate_call
370    def delete_ai_platform_connector(
371        self,
372        organization_id: StrictStr,
373        ai_platform_connector_id: StrictStr,
374        _request_timeout: Union[
375            None,
376            Annotated[StrictFloat, Field(gt=0)],
377            Tuple[
378                Annotated[StrictFloat, Field(gt=0)],
379                Annotated[StrictFloat, Field(gt=0)]
380            ]
381        ] = None,
382        _request_auth: Optional[Dict[StrictStr, Any]] = None,
383        _content_type: Optional[StrictStr] = None,
384        _headers: Optional[Dict[StrictStr, Any]] = None,
385        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
386    ) -> DeleteAIPlatformConnectorResponse:
387        """Delete an AI platform connector
388
389        Delete an AI platform connector
390
391        :param organization_id: (required)
392        :type organization_id: str
393        :param ai_platform_connector_id: (required)
394        :type ai_platform_connector_id: str
395        :param _request_timeout: timeout setting for this request. If one
396                                 number provided, it will be total request
397                                 timeout. It can also be a pair (tuple) of
398                                 (connection, read) timeouts.
399        :type _request_timeout: int, tuple(int, int), optional
400        :param _request_auth: set to override the auth_settings for an a single
401                              request; this effectively ignores the
402                              authentication in the spec for a single request.
403        :type _request_auth: dict, optional
404        :param _content_type: force content-type for the request.
405        :type _content_type: str, Optional
406        :param _headers: set to override the headers for a single
407                         request; this effectively ignores the headers
408                         in the spec for a single request.
409        :type _headers: dict, optional
410        :param _host_index: set to override the host_index for a single
411                            request; this effectively ignores the host_index
412                            in the spec for a single request.
413        :type _host_index: int, optional
414        :return: Returns the result object.
415        """ # noqa: E501
416
417        _param = self._delete_ai_platform_connector_serialize(
418            organization_id=organization_id,
419            ai_platform_connector_id=ai_platform_connector_id,
420            _request_auth=_request_auth,
421            _content_type=_content_type,
422            _headers=_headers,
423            _host_index=_host_index
424        )
425
426        _response_types_map: Dict[str, Optional[str]] = {
427            '200': "DeleteAIPlatformConnectorResponse",
428            '400': "GetPipelines400Response",
429            '401': "GetPipelines400Response",
430            '403': "GetPipelines400Response",
431            '404': "GetPipelines400Response",
432            '500': "GetPipelines400Response",
433        }
434        response_data = self.api_client.call_api(
435            *_param,
436            _request_timeout=_request_timeout
437        )
438        response_data.read()
439        return self.api_client.response_deserialize(
440            response_data=response_data,
441            response_types_map=_response_types_map,
442        ).data

Delete an AI platform connector

Delete an AI platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def delete_ai_platform_connector_with_http_info( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.api_response.ApiResponse[DeleteAIPlatformConnectorResponse]:
445    @validate_call
446    def delete_ai_platform_connector_with_http_info(
447        self,
448        organization_id: StrictStr,
449        ai_platform_connector_id: StrictStr,
450        _request_timeout: Union[
451            None,
452            Annotated[StrictFloat, Field(gt=0)],
453            Tuple[
454                Annotated[StrictFloat, Field(gt=0)],
455                Annotated[StrictFloat, Field(gt=0)]
456            ]
457        ] = None,
458        _request_auth: Optional[Dict[StrictStr, Any]] = None,
459        _content_type: Optional[StrictStr] = None,
460        _headers: Optional[Dict[StrictStr, Any]] = None,
461        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
462    ) -> ApiResponse[DeleteAIPlatformConnectorResponse]:
463        """Delete an AI platform connector
464
465        Delete an AI platform connector
466
467        :param organization_id: (required)
468        :type organization_id: str
469        :param ai_platform_connector_id: (required)
470        :type ai_platform_connector_id: str
471        :param _request_timeout: timeout setting for this request. If one
472                                 number provided, it will be total request
473                                 timeout. It can also be a pair (tuple) of
474                                 (connection, read) timeouts.
475        :type _request_timeout: int, tuple(int, int), optional
476        :param _request_auth: set to override the auth_settings for an a single
477                              request; this effectively ignores the
478                              authentication in the spec for a single request.
479        :type _request_auth: dict, optional
480        :param _content_type: force content-type for the request.
481        :type _content_type: str, Optional
482        :param _headers: set to override the headers for a single
483                         request; this effectively ignores the headers
484                         in the spec for a single request.
485        :type _headers: dict, optional
486        :param _host_index: set to override the host_index for a single
487                            request; this effectively ignores the host_index
488                            in the spec for a single request.
489        :type _host_index: int, optional
490        :return: Returns the result object.
491        """ # noqa: E501
492
493        _param = self._delete_ai_platform_connector_serialize(
494            organization_id=organization_id,
495            ai_platform_connector_id=ai_platform_connector_id,
496            _request_auth=_request_auth,
497            _content_type=_content_type,
498            _headers=_headers,
499            _host_index=_host_index
500        )
501
502        _response_types_map: Dict[str, Optional[str]] = {
503            '200': "DeleteAIPlatformConnectorResponse",
504            '400': "GetPipelines400Response",
505            '401': "GetPipelines400Response",
506            '403': "GetPipelines400Response",
507            '404': "GetPipelines400Response",
508            '500': "GetPipelines400Response",
509        }
510        response_data = self.api_client.call_api(
511            *_param,
512            _request_timeout=_request_timeout
513        )
514        response_data.read()
515        return self.api_client.response_deserialize(
516            response_data=response_data,
517            response_types_map=_response_types_map,
518        )

Delete an AI platform connector

Delete an AI platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def delete_ai_platform_connector_without_preload_content( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> urllib3.response.HTTPResponse:
521    @validate_call
522    def delete_ai_platform_connector_without_preload_content(
523        self,
524        organization_id: StrictStr,
525        ai_platform_connector_id: StrictStr,
526        _request_timeout: Union[
527            None,
528            Annotated[StrictFloat, Field(gt=0)],
529            Tuple[
530                Annotated[StrictFloat, Field(gt=0)],
531                Annotated[StrictFloat, Field(gt=0)]
532            ]
533        ] = None,
534        _request_auth: Optional[Dict[StrictStr, Any]] = None,
535        _content_type: Optional[StrictStr] = None,
536        _headers: Optional[Dict[StrictStr, Any]] = None,
537        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
538    ) -> RESTResponseType:
539        """Delete an AI platform connector
540
541        Delete an AI platform connector
542
543        :param organization_id: (required)
544        :type organization_id: str
545        :param ai_platform_connector_id: (required)
546        :type ai_platform_connector_id: str
547        :param _request_timeout: timeout setting for this request. If one
548                                 number provided, it will be total request
549                                 timeout. It can also be a pair (tuple) of
550                                 (connection, read) timeouts.
551        :type _request_timeout: int, tuple(int, int), optional
552        :param _request_auth: set to override the auth_settings for an a single
553                              request; this effectively ignores the
554                              authentication in the spec for a single request.
555        :type _request_auth: dict, optional
556        :param _content_type: force content-type for the request.
557        :type _content_type: str, Optional
558        :param _headers: set to override the headers for a single
559                         request; this effectively ignores the headers
560                         in the spec for a single request.
561        :type _headers: dict, optional
562        :param _host_index: set to override the host_index for a single
563                            request; this effectively ignores the host_index
564                            in the spec for a single request.
565        :type _host_index: int, optional
566        :return: Returns the result object.
567        """ # noqa: E501
568
569        _param = self._delete_ai_platform_connector_serialize(
570            organization_id=organization_id,
571            ai_platform_connector_id=ai_platform_connector_id,
572            _request_auth=_request_auth,
573            _content_type=_content_type,
574            _headers=_headers,
575            _host_index=_host_index
576        )
577
578        _response_types_map: Dict[str, Optional[str]] = {
579            '200': "DeleteAIPlatformConnectorResponse",
580            '400': "GetPipelines400Response",
581            '401': "GetPipelines400Response",
582            '403': "GetPipelines400Response",
583            '404': "GetPipelines400Response",
584            '500': "GetPipelines400Response",
585        }
586        response_data = self.api_client.call_api(
587            *_param,
588            _request_timeout=_request_timeout
589        )
590        return response_data.response

Delete an AI platform connector

Delete an AI platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def get_ai_platform_connector( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.models.ai_platform_connector.AIPlatformConnector:
660    @validate_call
661    def get_ai_platform_connector(
662        self,
663        organization_id: StrictStr,
664        ai_platform_connector_id: StrictStr,
665        _request_timeout: Union[
666            None,
667            Annotated[StrictFloat, Field(gt=0)],
668            Tuple[
669                Annotated[StrictFloat, Field(gt=0)],
670                Annotated[StrictFloat, Field(gt=0)]
671            ]
672        ] = None,
673        _request_auth: Optional[Dict[StrictStr, Any]] = None,
674        _content_type: Optional[StrictStr] = None,
675        _headers: Optional[Dict[StrictStr, Any]] = None,
676        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
677    ) -> AIPlatformConnector:
678        """Get an AI platform connector
679
680        Get an AI platform connector
681
682        :param organization_id: (required)
683        :type organization_id: str
684        :param ai_platform_connector_id: (required)
685        :type ai_platform_connector_id: str
686        :param _request_timeout: timeout setting for this request. If one
687                                 number provided, it will be total request
688                                 timeout. It can also be a pair (tuple) of
689                                 (connection, read) timeouts.
690        :type _request_timeout: int, tuple(int, int), optional
691        :param _request_auth: set to override the auth_settings for an a single
692                              request; this effectively ignores the
693                              authentication in the spec for a single request.
694        :type _request_auth: dict, optional
695        :param _content_type: force content-type for the request.
696        :type _content_type: str, Optional
697        :param _headers: set to override the headers for a single
698                         request; this effectively ignores the headers
699                         in the spec for a single request.
700        :type _headers: dict, optional
701        :param _host_index: set to override the host_index for a single
702                            request; this effectively ignores the host_index
703                            in the spec for a single request.
704        :type _host_index: int, optional
705        :return: Returns the result object.
706        """ # noqa: E501
707
708        _param = self._get_ai_platform_connector_serialize(
709            organization_id=organization_id,
710            ai_platform_connector_id=ai_platform_connector_id,
711            _request_auth=_request_auth,
712            _content_type=_content_type,
713            _headers=_headers,
714            _host_index=_host_index
715        )
716
717        _response_types_map: Dict[str, Optional[str]] = {
718            '200': "AIPlatformConnector",
719            '400': "GetPipelines400Response",
720            '401': "GetPipelines400Response",
721            '403': "GetPipelines400Response",
722            '404': "GetPipelines400Response",
723            '500': "GetPipelines400Response",
724        }
725        response_data = self.api_client.call_api(
726            *_param,
727            _request_timeout=_request_timeout
728        )
729        response_data.read()
730        return self.api_client.response_deserialize(
731            response_data=response_data,
732            response_types_map=_response_types_map,
733        ).data

Get an AI platform connector

Get an AI platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def get_ai_platform_connector_with_http_info( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.api_response.ApiResponse[AIPlatformConnector]:
736    @validate_call
737    def get_ai_platform_connector_with_http_info(
738        self,
739        organization_id: StrictStr,
740        ai_platform_connector_id: StrictStr,
741        _request_timeout: Union[
742            None,
743            Annotated[StrictFloat, Field(gt=0)],
744            Tuple[
745                Annotated[StrictFloat, Field(gt=0)],
746                Annotated[StrictFloat, Field(gt=0)]
747            ]
748        ] = None,
749        _request_auth: Optional[Dict[StrictStr, Any]] = None,
750        _content_type: Optional[StrictStr] = None,
751        _headers: Optional[Dict[StrictStr, Any]] = None,
752        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
753    ) -> ApiResponse[AIPlatformConnector]:
754        """Get an AI platform connector
755
756        Get an AI platform connector
757
758        :param organization_id: (required)
759        :type organization_id: str
760        :param ai_platform_connector_id: (required)
761        :type ai_platform_connector_id: str
762        :param _request_timeout: timeout setting for this request. If one
763                                 number provided, it will be total request
764                                 timeout. It can also be a pair (tuple) of
765                                 (connection, read) timeouts.
766        :type _request_timeout: int, tuple(int, int), optional
767        :param _request_auth: set to override the auth_settings for an a single
768                              request; this effectively ignores the
769                              authentication in the spec for a single request.
770        :type _request_auth: dict, optional
771        :param _content_type: force content-type for the request.
772        :type _content_type: str, Optional
773        :param _headers: set to override the headers for a single
774                         request; this effectively ignores the headers
775                         in the spec for a single request.
776        :type _headers: dict, optional
777        :param _host_index: set to override the host_index for a single
778                            request; this effectively ignores the host_index
779                            in the spec for a single request.
780        :type _host_index: int, optional
781        :return: Returns the result object.
782        """ # noqa: E501
783
784        _param = self._get_ai_platform_connector_serialize(
785            organization_id=organization_id,
786            ai_platform_connector_id=ai_platform_connector_id,
787            _request_auth=_request_auth,
788            _content_type=_content_type,
789            _headers=_headers,
790            _host_index=_host_index
791        )
792
793        _response_types_map: Dict[str, Optional[str]] = {
794            '200': "AIPlatformConnector",
795            '400': "GetPipelines400Response",
796            '401': "GetPipelines400Response",
797            '403': "GetPipelines400Response",
798            '404': "GetPipelines400Response",
799            '500': "GetPipelines400Response",
800        }
801        response_data = self.api_client.call_api(
802            *_param,
803            _request_timeout=_request_timeout
804        )
805        response_data.read()
806        return self.api_client.response_deserialize(
807            response_data=response_data,
808            response_types_map=_response_types_map,
809        )

Get an AI platform connector

Get an AI platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def get_ai_platform_connector_without_preload_content( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> urllib3.response.HTTPResponse:
812    @validate_call
813    def get_ai_platform_connector_without_preload_content(
814        self,
815        organization_id: StrictStr,
816        ai_platform_connector_id: StrictStr,
817        _request_timeout: Union[
818            None,
819            Annotated[StrictFloat, Field(gt=0)],
820            Tuple[
821                Annotated[StrictFloat, Field(gt=0)],
822                Annotated[StrictFloat, Field(gt=0)]
823            ]
824        ] = None,
825        _request_auth: Optional[Dict[StrictStr, Any]] = None,
826        _content_type: Optional[StrictStr] = None,
827        _headers: Optional[Dict[StrictStr, Any]] = None,
828        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
829    ) -> RESTResponseType:
830        """Get an AI platform connector
831
832        Get an AI platform connector
833
834        :param organization_id: (required)
835        :type organization_id: str
836        :param ai_platform_connector_id: (required)
837        :type ai_platform_connector_id: str
838        :param _request_timeout: timeout setting for this request. If one
839                                 number provided, it will be total request
840                                 timeout. It can also be a pair (tuple) of
841                                 (connection, read) timeouts.
842        :type _request_timeout: int, tuple(int, int), optional
843        :param _request_auth: set to override the auth_settings for an a single
844                              request; this effectively ignores the
845                              authentication in the spec for a single request.
846        :type _request_auth: dict, optional
847        :param _content_type: force content-type for the request.
848        :type _content_type: str, Optional
849        :param _headers: set to override the headers for a single
850                         request; this effectively ignores the headers
851                         in the spec for a single request.
852        :type _headers: dict, optional
853        :param _host_index: set to override the host_index for a single
854                            request; this effectively ignores the host_index
855                            in the spec for a single request.
856        :type _host_index: int, optional
857        :return: Returns the result object.
858        """ # noqa: E501
859
860        _param = self._get_ai_platform_connector_serialize(
861            organization_id=organization_id,
862            ai_platform_connector_id=ai_platform_connector_id,
863            _request_auth=_request_auth,
864            _content_type=_content_type,
865            _headers=_headers,
866            _host_index=_host_index
867        )
868
869        _response_types_map: Dict[str, Optional[str]] = {
870            '200': "AIPlatformConnector",
871            '400': "GetPipelines400Response",
872            '401': "GetPipelines400Response",
873            '403': "GetPipelines400Response",
874            '404': "GetPipelines400Response",
875            '500': "GetPipelines400Response",
876        }
877        response_data = self.api_client.call_api(
878            *_param,
879            _request_timeout=_request_timeout
880        )
881        return response_data.response

Get an AI platform connector

Get an AI platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def get_ai_platform_connectors( self, organization_id: typing.Annotated[str, Strict(strict=True)], workspace_id: Optional[Annotated[str, Strict(strict=True)]] = None, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.models.get_ai_platform_connectors200_response.GetAIPlatformConnectors200Response:
 951    @validate_call
 952    def get_ai_platform_connectors(
 953        self,
 954        organization_id: StrictStr,
 955        workspace_id: Optional[StrictStr] = None,
 956        _request_timeout: Union[
 957            None,
 958            Annotated[StrictFloat, Field(gt=0)],
 959            Tuple[
 960                Annotated[StrictFloat, Field(gt=0)],
 961                Annotated[StrictFloat, Field(gt=0)]
 962            ]
 963        ] = None,
 964        _request_auth: Optional[Dict[StrictStr, Any]] = None,
 965        _content_type: Optional[StrictStr] = None,
 966        _headers: Optional[Dict[StrictStr, Any]] = None,
 967        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
 968    ) -> GetAIPlatformConnectors200Response:
 969        """Get all existing AI Platform connectors
 970
 971        Get all existing AI Platform connectors
 972
 973        :param organization_id: (required)
 974        :type organization_id: str
 975        :param workspace_id:
 976        :type workspace_id: str
 977        :param _request_timeout: timeout setting for this request. If one
 978                                 number provided, it will be total request
 979                                 timeout. It can also be a pair (tuple) of
 980                                 (connection, read) timeouts.
 981        :type _request_timeout: int, tuple(int, int), optional
 982        :param _request_auth: set to override the auth_settings for an a single
 983                              request; this effectively ignores the
 984                              authentication in the spec for a single request.
 985        :type _request_auth: dict, optional
 986        :param _content_type: force content-type for the request.
 987        :type _content_type: str, Optional
 988        :param _headers: set to override the headers for a single
 989                         request; this effectively ignores the headers
 990                         in the spec for a single request.
 991        :type _headers: dict, optional
 992        :param _host_index: set to override the host_index for a single
 993                            request; this effectively ignores the host_index
 994                            in the spec for a single request.
 995        :type _host_index: int, optional
 996        :return: Returns the result object.
 997        """ # noqa: E501
 998
 999        _param = self._get_ai_platform_connectors_serialize(
1000            organization_id=organization_id,
1001            workspace_id=workspace_id,
1002            _request_auth=_request_auth,
1003            _content_type=_content_type,
1004            _headers=_headers,
1005            _host_index=_host_index
1006        )
1007
1008        _response_types_map: Dict[str, Optional[str]] = {
1009            '200': "GetAIPlatformConnectors200Response",
1010            '400': "GetPipelines400Response",
1011            '401': "GetPipelines400Response",
1012            '403': "GetPipelines400Response",
1013            '404': "GetPipelines400Response",
1014            '500': "GetPipelines400Response",
1015        }
1016        response_data = self.api_client.call_api(
1017            *_param,
1018            _request_timeout=_request_timeout
1019        )
1020        response_data.read()
1021        return self.api_client.response_deserialize(
1022            response_data=response_data,
1023            response_types_map=_response_types_map,
1024        ).data

Get all existing AI Platform connectors

Get all existing AI Platform connectors

Parameters
  • organization_id: (required)
  • workspace_id:
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def get_ai_platform_connectors_with_http_info( self, organization_id: typing.Annotated[str, Strict(strict=True)], workspace_id: Optional[Annotated[str, Strict(strict=True)]] = None, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.api_response.ApiResponse[GetAIPlatformConnectors200Response]:
1027    @validate_call
1028    def get_ai_platform_connectors_with_http_info(
1029        self,
1030        organization_id: StrictStr,
1031        workspace_id: Optional[StrictStr] = None,
1032        _request_timeout: Union[
1033            None,
1034            Annotated[StrictFloat, Field(gt=0)],
1035            Tuple[
1036                Annotated[StrictFloat, Field(gt=0)],
1037                Annotated[StrictFloat, Field(gt=0)]
1038            ]
1039        ] = None,
1040        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1041        _content_type: Optional[StrictStr] = None,
1042        _headers: Optional[Dict[StrictStr, Any]] = None,
1043        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1044    ) -> ApiResponse[GetAIPlatformConnectors200Response]:
1045        """Get all existing AI Platform connectors
1046
1047        Get all existing AI Platform connectors
1048
1049        :param organization_id: (required)
1050        :type organization_id: str
1051        :param workspace_id:
1052        :type workspace_id: str
1053        :param _request_timeout: timeout setting for this request. If one
1054                                 number provided, it will be total request
1055                                 timeout. It can also be a pair (tuple) of
1056                                 (connection, read) timeouts.
1057        :type _request_timeout: int, tuple(int, int), optional
1058        :param _request_auth: set to override the auth_settings for an a single
1059                              request; this effectively ignores the
1060                              authentication in the spec for a single request.
1061        :type _request_auth: dict, optional
1062        :param _content_type: force content-type for the request.
1063        :type _content_type: str, Optional
1064        :param _headers: set to override the headers for a single
1065                         request; this effectively ignores the headers
1066                         in the spec for a single request.
1067        :type _headers: dict, optional
1068        :param _host_index: set to override the host_index for a single
1069                            request; this effectively ignores the host_index
1070                            in the spec for a single request.
1071        :type _host_index: int, optional
1072        :return: Returns the result object.
1073        """ # noqa: E501
1074
1075        _param = self._get_ai_platform_connectors_serialize(
1076            organization_id=organization_id,
1077            workspace_id=workspace_id,
1078            _request_auth=_request_auth,
1079            _content_type=_content_type,
1080            _headers=_headers,
1081            _host_index=_host_index
1082        )
1083
1084        _response_types_map: Dict[str, Optional[str]] = {
1085            '200': "GetAIPlatformConnectors200Response",
1086            '400': "GetPipelines400Response",
1087            '401': "GetPipelines400Response",
1088            '403': "GetPipelines400Response",
1089            '404': "GetPipelines400Response",
1090            '500': "GetPipelines400Response",
1091        }
1092        response_data = self.api_client.call_api(
1093            *_param,
1094            _request_timeout=_request_timeout
1095        )
1096        response_data.read()
1097        return self.api_client.response_deserialize(
1098            response_data=response_data,
1099            response_types_map=_response_types_map,
1100        )

Get all existing AI Platform connectors

Get all existing AI Platform connectors

Parameters
  • organization_id: (required)
  • workspace_id:
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def get_ai_platform_connectors_without_preload_content( self, organization_id: typing.Annotated[str, Strict(strict=True)], workspace_id: Optional[Annotated[str, Strict(strict=True)]] = None, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> urllib3.response.HTTPResponse:
1103    @validate_call
1104    def get_ai_platform_connectors_without_preload_content(
1105        self,
1106        organization_id: StrictStr,
1107        workspace_id: Optional[StrictStr] = None,
1108        _request_timeout: Union[
1109            None,
1110            Annotated[StrictFloat, Field(gt=0)],
1111            Tuple[
1112                Annotated[StrictFloat, Field(gt=0)],
1113                Annotated[StrictFloat, Field(gt=0)]
1114            ]
1115        ] = None,
1116        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1117        _content_type: Optional[StrictStr] = None,
1118        _headers: Optional[Dict[StrictStr, Any]] = None,
1119        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1120    ) -> RESTResponseType:
1121        """Get all existing AI Platform connectors
1122
1123        Get all existing AI Platform connectors
1124
1125        :param organization_id: (required)
1126        :type organization_id: str
1127        :param workspace_id:
1128        :type workspace_id: str
1129        :param _request_timeout: timeout setting for this request. If one
1130                                 number provided, it will be total request
1131                                 timeout. It can also be a pair (tuple) of
1132                                 (connection, read) timeouts.
1133        :type _request_timeout: int, tuple(int, int), optional
1134        :param _request_auth: set to override the auth_settings for an a single
1135                              request; this effectively ignores the
1136                              authentication in the spec for a single request.
1137        :type _request_auth: dict, optional
1138        :param _content_type: force content-type for the request.
1139        :type _content_type: str, Optional
1140        :param _headers: set to override the headers for a single
1141                         request; this effectively ignores the headers
1142                         in the spec for a single request.
1143        :type _headers: dict, optional
1144        :param _host_index: set to override the host_index for a single
1145                            request; this effectively ignores the host_index
1146                            in the spec for a single request.
1147        :type _host_index: int, optional
1148        :return: Returns the result object.
1149        """ # noqa: E501
1150
1151        _param = self._get_ai_platform_connectors_serialize(
1152            organization_id=organization_id,
1153            workspace_id=workspace_id,
1154            _request_auth=_request_auth,
1155            _content_type=_content_type,
1156            _headers=_headers,
1157            _host_index=_host_index
1158        )
1159
1160        _response_types_map: Dict[str, Optional[str]] = {
1161            '200': "GetAIPlatformConnectors200Response",
1162            '400': "GetPipelines400Response",
1163            '401': "GetPipelines400Response",
1164            '403': "GetPipelines400Response",
1165            '404': "GetPipelines400Response",
1166            '500': "GetPipelines400Response",
1167        }
1168        response_data = self.api_client.call_api(
1169            *_param,
1170            _request_timeout=_request_timeout
1171        )
1172        return response_data.response

Get all existing AI Platform connectors

Get all existing AI Platform connectors

Parameters
  • organization_id: (required)
  • workspace_id:
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def update_ai_platform_connector( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], update_ai_platform_connector_request: vectorize_client.models.update_ai_platform_connector_request.UpdateAIPlatformConnectorRequest, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.models.update_ai_platform_connector_response.UpdateAIPlatformConnectorResponse:
1244    @validate_call
1245    def update_ai_platform_connector(
1246        self,
1247        organization_id: StrictStr,
1248        ai_platform_connector_id: StrictStr,
1249        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1250        _request_timeout: Union[
1251            None,
1252            Annotated[StrictFloat, Field(gt=0)],
1253            Tuple[
1254                Annotated[StrictFloat, Field(gt=0)],
1255                Annotated[StrictFloat, Field(gt=0)]
1256            ]
1257        ] = None,
1258        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1259        _content_type: Optional[StrictStr] = None,
1260        _headers: Optional[Dict[StrictStr, Any]] = None,
1261        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1262    ) -> UpdateAIPlatformConnectorResponse:
1263        """Update an AI Platform connector
1264
1265        Update an AI Platform connector
1266
1267        :param organization_id: (required)
1268        :type organization_id: str
1269        :param ai_platform_connector_id: (required)
1270        :type ai_platform_connector_id: str
1271        :param update_ai_platform_connector_request: (required)
1272        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1273        :param _request_timeout: timeout setting for this request. If one
1274                                 number provided, it will be total request
1275                                 timeout. It can also be a pair (tuple) of
1276                                 (connection, read) timeouts.
1277        :type _request_timeout: int, tuple(int, int), optional
1278        :param _request_auth: set to override the auth_settings for an a single
1279                              request; this effectively ignores the
1280                              authentication in the spec for a single request.
1281        :type _request_auth: dict, optional
1282        :param _content_type: force content-type for the request.
1283        :type _content_type: str, Optional
1284        :param _headers: set to override the headers for a single
1285                         request; this effectively ignores the headers
1286                         in the spec for a single request.
1287        :type _headers: dict, optional
1288        :param _host_index: set to override the host_index for a single
1289                            request; this effectively ignores the host_index
1290                            in the spec for a single request.
1291        :type _host_index: int, optional
1292        :return: Returns the result object.
1293        """ # noqa: E501
1294
1295        _param = self._update_ai_platform_connector_serialize(
1296            organization_id=organization_id,
1297            ai_platform_connector_id=ai_platform_connector_id,
1298            update_ai_platform_connector_request=update_ai_platform_connector_request,
1299            _request_auth=_request_auth,
1300            _content_type=_content_type,
1301            _headers=_headers,
1302            _host_index=_host_index
1303        )
1304
1305        _response_types_map: Dict[str, Optional[str]] = {
1306            '200': "UpdateAIPlatformConnectorResponse",
1307            '400': "GetPipelines400Response",
1308            '401': "GetPipelines400Response",
1309            '403': "GetPipelines400Response",
1310            '404': "GetPipelines400Response",
1311            '500': "GetPipelines400Response",
1312        }
1313        response_data = self.api_client.call_api(
1314            *_param,
1315            _request_timeout=_request_timeout
1316        )
1317        response_data.read()
1318        return self.api_client.response_deserialize(
1319            response_data=response_data,
1320            response_types_map=_response_types_map,
1321        ).data

Update an AI Platform connector

Update an AI Platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • update_ai_platform_connector_request: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def update_ai_platform_connector_with_http_info( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], update_ai_platform_connector_request: vectorize_client.models.update_ai_platform_connector_request.UpdateAIPlatformConnectorRequest, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> vectorize_client.api_response.ApiResponse[UpdateAIPlatformConnectorResponse]:
1324    @validate_call
1325    def update_ai_platform_connector_with_http_info(
1326        self,
1327        organization_id: StrictStr,
1328        ai_platform_connector_id: StrictStr,
1329        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1330        _request_timeout: Union[
1331            None,
1332            Annotated[StrictFloat, Field(gt=0)],
1333            Tuple[
1334                Annotated[StrictFloat, Field(gt=0)],
1335                Annotated[StrictFloat, Field(gt=0)]
1336            ]
1337        ] = None,
1338        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1339        _content_type: Optional[StrictStr] = None,
1340        _headers: Optional[Dict[StrictStr, Any]] = None,
1341        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1342    ) -> ApiResponse[UpdateAIPlatformConnectorResponse]:
1343        """Update an AI Platform connector
1344
1345        Update an AI Platform connector
1346
1347        :param organization_id: (required)
1348        :type organization_id: str
1349        :param ai_platform_connector_id: (required)
1350        :type ai_platform_connector_id: str
1351        :param update_ai_platform_connector_request: (required)
1352        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1353        :param _request_timeout: timeout setting for this request. If one
1354                                 number provided, it will be total request
1355                                 timeout. It can also be a pair (tuple) of
1356                                 (connection, read) timeouts.
1357        :type _request_timeout: int, tuple(int, int), optional
1358        :param _request_auth: set to override the auth_settings for an a single
1359                              request; this effectively ignores the
1360                              authentication in the spec for a single request.
1361        :type _request_auth: dict, optional
1362        :param _content_type: force content-type for the request.
1363        :type _content_type: str, Optional
1364        :param _headers: set to override the headers for a single
1365                         request; this effectively ignores the headers
1366                         in the spec for a single request.
1367        :type _headers: dict, optional
1368        :param _host_index: set to override the host_index for a single
1369                            request; this effectively ignores the host_index
1370                            in the spec for a single request.
1371        :type _host_index: int, optional
1372        :return: Returns the result object.
1373        """ # noqa: E501
1374
1375        _param = self._update_ai_platform_connector_serialize(
1376            organization_id=organization_id,
1377            ai_platform_connector_id=ai_platform_connector_id,
1378            update_ai_platform_connector_request=update_ai_platform_connector_request,
1379            _request_auth=_request_auth,
1380            _content_type=_content_type,
1381            _headers=_headers,
1382            _host_index=_host_index
1383        )
1384
1385        _response_types_map: Dict[str, Optional[str]] = {
1386            '200': "UpdateAIPlatformConnectorResponse",
1387            '400': "GetPipelines400Response",
1388            '401': "GetPipelines400Response",
1389            '403': "GetPipelines400Response",
1390            '404': "GetPipelines400Response",
1391            '500': "GetPipelines400Response",
1392        }
1393        response_data = self.api_client.call_api(
1394            *_param,
1395            _request_timeout=_request_timeout
1396        )
1397        response_data.read()
1398        return self.api_client.response_deserialize(
1399            response_data=response_data,
1400            response_types_map=_response_types_map,
1401        )

Update an AI Platform connector

Update an AI Platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • update_ai_platform_connector_request: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.

@validate_call
def update_ai_platform_connector_without_preload_content( self, organization_id: typing.Annotated[str, Strict(strict=True)], ai_platform_connector_id: typing.Annotated[str, Strict(strict=True)], update_ai_platform_connector_request: vectorize_client.models.update_ai_platform_connector_request.UpdateAIPlatformConnectorRequest, _request_timeout: Union[NoneType, Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]]] = None, _request_auth: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _content_type: Optional[Annotated[str, Strict(strict=True)]] = None, _headers: Optional[Dict[Annotated[str, Strict(strict=True)], Any]] = None, _host_index: typing.Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) -> urllib3.response.HTTPResponse:
1404    @validate_call
1405    def update_ai_platform_connector_without_preload_content(
1406        self,
1407        organization_id: StrictStr,
1408        ai_platform_connector_id: StrictStr,
1409        update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest,
1410        _request_timeout: Union[
1411            None,
1412            Annotated[StrictFloat, Field(gt=0)],
1413            Tuple[
1414                Annotated[StrictFloat, Field(gt=0)],
1415                Annotated[StrictFloat, Field(gt=0)]
1416            ]
1417        ] = None,
1418        _request_auth: Optional[Dict[StrictStr, Any]] = None,
1419        _content_type: Optional[StrictStr] = None,
1420        _headers: Optional[Dict[StrictStr, Any]] = None,
1421        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1422    ) -> RESTResponseType:
1423        """Update an AI Platform connector
1424
1425        Update an AI Platform connector
1426
1427        :param organization_id: (required)
1428        :type organization_id: str
1429        :param ai_platform_connector_id: (required)
1430        :type ai_platform_connector_id: str
1431        :param update_ai_platform_connector_request: (required)
1432        :type update_ai_platform_connector_request: UpdateAIPlatformConnectorRequest
1433        :param _request_timeout: timeout setting for this request. If one
1434                                 number provided, it will be total request
1435                                 timeout. It can also be a pair (tuple) of
1436                                 (connection, read) timeouts.
1437        :type _request_timeout: int, tuple(int, int), optional
1438        :param _request_auth: set to override the auth_settings for an a single
1439                              request; this effectively ignores the
1440                              authentication in the spec for a single request.
1441        :type _request_auth: dict, optional
1442        :param _content_type: force content-type for the request.
1443        :type _content_type: str, Optional
1444        :param _headers: set to override the headers for a single
1445                         request; this effectively ignores the headers
1446                         in the spec for a single request.
1447        :type _headers: dict, optional
1448        :param _host_index: set to override the host_index for a single
1449                            request; this effectively ignores the host_index
1450                            in the spec for a single request.
1451        :type _host_index: int, optional
1452        :return: Returns the result object.
1453        """ # noqa: E501
1454
1455        _param = self._update_ai_platform_connector_serialize(
1456            organization_id=organization_id,
1457            ai_platform_connector_id=ai_platform_connector_id,
1458            update_ai_platform_connector_request=update_ai_platform_connector_request,
1459            _request_auth=_request_auth,
1460            _content_type=_content_type,
1461            _headers=_headers,
1462            _host_index=_host_index
1463        )
1464
1465        _response_types_map: Dict[str, Optional[str]] = {
1466            '200': "UpdateAIPlatformConnectorResponse",
1467            '400': "GetPipelines400Response",
1468            '401': "GetPipelines400Response",
1469            '403': "GetPipelines400Response",
1470            '404': "GetPipelines400Response",
1471            '500': "GetPipelines400Response",
1472        }
1473        response_data = self.api_client.call_api(
1474            *_param,
1475            _request_timeout=_request_timeout
1476        )
1477        return response_data.response

Update an AI Platform connector

Update an AI Platform connector

Parameters
  • organization_id: (required)
  • ai_platform_connector_id: (required)
  • update_ai_platform_connector_request: (required)
  • _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
  • _request_auth: set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
  • _content_type: force content-type for the request.
  • _headers: set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
  • _host_index: set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
Returns

Returns the result object.