Class AIPlatformConnectorsApi

Hierarchy (View Summary)

BaseAPI
- AIPlatformConnectorsApi

Index

Constructors

Properties

Methods

createAIPlatformConnector createAIPlatformConnectorRaw deleteAIPlatformConnector deleteAIPlatformConnectorRaw getAIPlatformConnector getAIPlatformConnectorRaw getAIPlatformConnectors getAIPlatformConnectorsRaw isJsonMime request updateAIPlatformConnector updateAIPlatformConnectorRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new AIPlatformConnectorsApi(
configuration?: Configuration,
): AIPlatformConnectorsApi
Parameters
- configuration: Configuration = DefaultConfig
Returns AIPlatformConnectorsApi
Inherited from BaseAPI.constructor
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:97

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

createAIPlatformConnector

createAIPlatformConnector(
requestParameters: CreateAIPlatformConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<CreateAIPlatformConnectorResponse>
Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected. Create a new AI platform connector
Parameters
- requestParameters: CreateAIPlatformConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<CreateAIPlatformConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:130

createAIPlatformConnectorRaw

createAIPlatformConnectorRaw(
requestParameters: CreateAIPlatformConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<CreateAIPlatformConnectorResponse>>
Creates a new AI platform connector for embeddings and processing. The specific configuration fields required depend on the platform type selected. Create a new AI platform connector
Parameters
- requestParameters: CreateAIPlatformConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<CreateAIPlatformConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:82

deleteAIPlatformConnector

deleteAIPlatformConnector(
requestParameters: DeleteAIPlatformConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<DeleteAIPlatformConnectorResponse>
Delete an AI platform connector Delete an AI platform connector
Parameters
- requestParameters: DeleteAIPlatformConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<DeleteAIPlatformConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:180

deleteAIPlatformConnectorRaw

deleteAIPlatformConnectorRaw(
requestParameters: DeleteAIPlatformConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<DeleteAIPlatformConnectorResponse>>
Delete an AI platform connector Delete an AI platform connector
Parameters
- requestParameters: DeleteAIPlatformConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<DeleteAIPlatformConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:139

getAIPlatformConnector

getAIPlatformConnector(
requestParameters: GetAIPlatformConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<AIPlatformConnector>
Get an AI platform connector Get an AI platform connector
Parameters
- requestParameters: GetAIPlatformConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<AIPlatformConnector>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:230

getAIPlatformConnectorRaw

getAIPlatformConnectorRaw(
requestParameters: GetAIPlatformConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<AIPlatformConnector>>
Get an AI platform connector Get an AI platform connector
Parameters
- requestParameters: GetAIPlatformConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<AIPlatformConnector>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:189

getAIPlatformConnectors

getAIPlatformConnectors(
requestParameters: GetAIPlatformConnectorsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetAIPlatformConnectors200Response>
Get all existing AI Platform connectors Get all existing AI Platform connectors
Parameters
- requestParameters: GetAIPlatformConnectorsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetAIPlatformConnectors200Response>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:277

getAIPlatformConnectorsRaw

getAIPlatformConnectorsRaw(
requestParameters: GetAIPlatformConnectorsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetAIPlatformConnectors200Response>>
Get all existing AI Platform connectors Get all existing AI Platform connectors
Parameters
- requestParameters: GetAIPlatformConnectorsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetAIPlatformConnectors200Response>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:239

`Protected`isJsonMime

isJsonMime(mime: string): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:127

`Protected`request

request(
context: RequestOpts,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<Response>
Parameters
- context: RequestOpts
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:134

updateAIPlatformConnector

updateAIPlatformConnector(
requestParameters: UpdateAIPlatformConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<UpdateAIPlatformConnectorResponse>
Update an AI Platform connector Update an AI Platform connector
Parameters
- requestParameters: UpdateAIPlatformConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<UpdateAIPlatformConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:337

updateAIPlatformConnectorRaw

updateAIPlatformConnectorRaw(
requestParameters: UpdateAIPlatformConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<UpdateAIPlatformConnectorResponse>>
Update an AI Platform connector Update an AI Platform connector
Parameters
- requestParameters: UpdateAIPlatformConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<UpdateAIPlatformConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/AIPlatformConnectorsApi.ts:286

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:101

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        (context: ResponseContext) => Promise<void | Response>
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:112

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        (context: RequestContext) => Promise<void | FetchParams>
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:107

Class AIPlatformConnectorsApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AIPlatformConnectorsApi

Properties

Protectedconfiguration

Methods

createAIPlatformConnector

Parameters

Returns Promise<CreateAIPlatformConnectorResponse>

createAIPlatformConnectorRaw

Parameters

Returns Promise<ApiResponse<CreateAIPlatformConnectorResponse>>

deleteAIPlatformConnector

Parameters

Returns Promise<DeleteAIPlatformConnectorResponse>

deleteAIPlatformConnectorRaw

Parameters

Returns Promise<ApiResponse<DeleteAIPlatformConnectorResponse>>

getAIPlatformConnector

Parameters

Returns Promise<AIPlatformConnector>

getAIPlatformConnectorRaw

Parameters

Returns Promise<ApiResponse<AIPlatformConnector>>

getAIPlatformConnectors

Parameters

Returns Promise<GetAIPlatformConnectors200Response>

getAIPlatformConnectorsRaw

Parameters

Returns Promise<ApiResponse<GetAIPlatformConnectors200Response>>

ProtectedisJsonMime

Parameters

Returns boolean

Protectedrequest

Parameters

Returns Promise<Response>

updateAIPlatformConnector

Parameters

Returns Promise<UpdateAIPlatformConnectorResponse>

updateAIPlatformConnectorRaw

Parameters

Returns Promise<ApiResponse<UpdateAIPlatformConnectorResponse>>

withMiddleware

Type Parameters

Parameters

Returns T

withPostMiddleware

Type Parameters

Parameters

Returns T

withPreMiddleware

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected`configuration

`Protected`isJsonMime

`Protected`request