Class ExtractionApi

Hierarchy (View Summary)

BaseAPI
- ExtractionApi

Index

Constructors

Properties

Methods

getExtractionResult getExtractionResultRaw isJsonMime request startExtraction startExtractionRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

getExtractionResult

getExtractionResult(
requestParameters: GetExtractionResultRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ExtractionResultResponse>
Get extraction result Get extraction result
Parameters
- requestParameters: GetExtractionResultRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ExtractionResultResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/ExtractionApi.ts:94

getExtractionResultRaw

getExtractionResultRaw(
requestParameters: GetExtractionResultRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ExtractionResultResponse>>
Get extraction result Get extraction result
Parameters
- requestParameters: GetExtractionResultRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ExtractionResultResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/ExtractionApi.ts:53

`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

startExtraction

startExtraction(
requestParameters: StartExtractionOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StartExtractionResponse>
Start content extraction from a file Start content extraction from a file
Parameters
- requestParameters: StartExtractionOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StartExtractionResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/ExtractionApi.ts:147

startExtractionRaw

startExtractionRaw(
requestParameters: StartExtractionOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StartExtractionResponse>>
Start content extraction from a file Start content extraction from a file
Parameters
- requestParameters: StartExtractionOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StartExtractionResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/ExtractionApi.ts:103

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 ExtractionApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ExtractionApi

Properties

Protectedconfiguration

Methods

getExtractionResult

Parameters

Returns Promise<ExtractionResultResponse>

getExtractionResultRaw

Parameters

Returns Promise<ApiResponse<ExtractionResultResponse>>

ProtectedisJsonMime

Parameters

Returns boolean

Protectedrequest

Parameters

Returns Promise<Response>

startExtraction

Parameters

Returns Promise<StartExtractionResponse>

startExtractionRaw

Parameters

Returns Promise<ApiResponse<StartExtractionResponse>>

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