Interface CreateDocumentExtractionParams

Parameters for the createDocumentExtraction operation.

interface CreateDocumentExtractionParams {
    documentReferences: WatsonXAI.DocumentExtractionObjectLocation[];
    headers?: OutgoingHttpHeaders;
    name: string;
    projectId?: string;
    resultsReference: WatsonXAI.ObjectLocationGithub;
    signal?: AbortSignal;
    spaceId?: string;
    tags?: string[];
}

Hierarchy

  • DefaultParams
    • CreateDocumentExtractionParams

Properties

documentReferences headers? name projectId? resultsReference signal? spaceId? tags?

Properties

documentReferences

documentReferences: WatsonXAI.DocumentExtractionObjectLocation[]

The documents for text extraction.

Optional headers

headers?: OutgoingHttpHeaders

name

name: string

The name of the document.

Optional projectId

projectId?: string

The project that contains the resource. Either space_id or project_id has to be given.

resultsReference

resultsReference: WatsonXAI.ObjectLocationGithub

A reference to data.

Optional signal

signal?: AbortSignal

Optional spaceId

spaceId?: string

The space that contains the resource. Either space_id or project_id has to be given.

Optional tags

tags?: string[]

A list of tags for this resource.

Settings

Member Visibility

Theme

On This Page

documentReferencesheadersnameprojectIdresultsReferencesignalspaceIdtags