Documentation
Preparing search index...
@quatrain/okf-ingest-catalog
CatalogIngestionOptions
Interface CatalogIngestionOptions
Configuration options for catalog monograph ingestion.
interface
CatalogIngestionOptions
{
adapter
?:
AbstractAiAdapter
;
apiKey
?:
string
;
defaultCategory
?:
string
;
entryType
?:
OkfDocumentType
;
fileHash
:
string
;
filename
:
string
;
gitLocalPath
:
string
;
languages
?:
string
[]
;
model
?:
string
;
onProgress
?:
(
current
:
number
,
total
:
number
,
entryTitle
:
string
)
=>
void
;
originalFileUri
:
string
;
revision
?:
string
;
runner
?:
AiStructuredRunner
;
soa
?:
string
;
targetLanguages
?:
string
[]
;
taxonomyProfile
?:
DomainTaxonomyProfile
;
}
Index
Properties
adapter?
api
Key?
default
Category?
entry
Type?
file
Hash
filename
git
Local
Path
languages?
model?
on
Progress?
original
File
Uri
revision?
runner?
soa?
target
Languages?
taxonomy
Profile?
Properties
Optional
adapter
adapter
?:
AbstractAiAdapter
Optional
api
Key
apiKey
?:
string
Optional
default
Category
defaultCategory
?:
string
Optional
entry
Type
entryType
?:
OkfDocumentType
file
Hash
fileHash
:
string
filename
filename
:
string
git
Local
Path
gitLocalPath
:
string
Optional
languages
languages
?:
string
[]
Optional
model
model
?:
string
Optional
on
Progress
onProgress
?:
(
current
:
number
,
total
:
number
,
entryTitle
:
string
)
=>
void
original
File
Uri
originalFileUri
:
string
Optional
revision
revision
?:
string
Optional
runner
runner
?:
AiStructuredRunner
Optional
soa
soa
?:
string
Optional
target
Languages
targetLanguages
?:
string
[]
Optional
taxonomy
Profile
taxonomyProfile
?:
DomainTaxonomyProfile
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
adapter
api
Key
default
Category
entry
Type
file
Hash
filename
git
Local
Path
languages
model
on
Progress
original
File
Uri
revision
runner
soa
target
Languages
taxonomy
Profile
Documentation
Loading...
Configuration options for catalog monograph ingestion.