@nestbox-ai/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @nestbox-ai/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ArtifactsApi | artifactsControllerDownloadDocumentArtifacts | GET /documents/{documentId}/artifacts | Download document artifacts DocumentsApi | documentsControllerCreateDocument | POST /documents | Create document processing job DocumentsApi | documentsControllerGetDocument | GET /documents/{documentId} | Read document DocumentsApi | documentsControllerListDocuments | GET /documents | List documents EvalsApi | evalsControllerCreateEval | POST /documents/{documentId}/evals | Create an eval from YAML EvalsApi | evalsControllerGetEval | GET /documents/{documentId}/evals/{evalId} | Read eval EvalsApi | evalsControllerListEvals | GET /documents/{documentId}/evals | List evals for a document EvalsApi | evalsControllerValidateEvalYaml | POST /documents/{documentId}/evals/validate | Validate eval YAML HealthApi | healthControllerGetHealth | GET /health | Get system health JobsApi | jobsControllerGetJob | GET /jobs/{jobId} | Read job JobsApi | jobsControllerGetJobStatus | GET /jobs/{jobId}/status | Get job status JobsApi | jobsControllerListJobs | GET /jobs | List jobs ProfilesApi | profilesControllerCreateProfile | POST /profiles | Create profile from YAML ProfilesApi | profilesControllerGetProfile | GET /profiles/{profileId} | Read profile ProfilesApi | profilesControllerGetProfileSchema | GET /profiles/schema | Get profile schema ProfilesApi | profilesControllerListProfiles | GET /profiles | List profiles QueriesApi | queriesControllerCreateQuery | POST /query | Create batch query from YAML QueriesApi | queriesControllerGetQuery | GET /query/{queryId} | Read batch query QueriesApi | queriesControllerListQueries | GET /query | List batch queries QueriesApi | queriesControllerValidateQueryYaml | POST /query/validate | Validate batch query YAML SourcesApi | sourcesControllerGetDocumentSources | GET /documents/{documentId}/sources | Read document sources WebhooksApi | webhooksControllerCreateWebhook | POST /webhooks | Create webhook WebhooksApi | webhooksControllerDeleteWebhook | DELETE /webhooks/{webhookId} | Delete webhook WebhooksApi | webhooksControllerGetWebhook | GET /webhooks/{webhookId} | Read webhook WebhooksApi | webhooksControllerListWebhooks | GET /webhooks | List webhooks WebhooksApi | webhooksControllerUpdateWebhook | PATCH /webhooks/{webhookId} | Update webhook

Documentation For Models

• BatchQueryDto
• CreateWebhookInputDto
• DocumentCreateResponseDto
• DocumentDto
• DocumentSourcesResponseDto
• ErrorDto
• EvalCreateResponseDto
• EvalDto
• GpuDeviceDto
• GpuHealthCheckDto
• HealthCheckItemDto
• HealthChecksDto
• HealthResponseDto
• JobDto
• JobLinksDto
• JobStatusDto
• PaginatedDocumentsDto
• PaginatedEvalsDto
• PaginatedJobsDto
• PaginatedProfilesDto
• PaginatedQueriesDto
• PaginatedWebhooksDto
• PaginationDto
• ProfileDto
• QueryCreateResponseDto
• SourceItemDto
• UpdateWebhookBodyInputDto
• ValidationErrorDto
• ValidationIssueDto
• ValidationResultDto
• WebhookDto

Documentation For Authorization

Endpoints do not require authorization.