Skip to content

Latest commit

 

History

History
689 lines (508 loc) · 49.3 KB

api.md

File metadata and controls

689 lines (508 loc) · 49.3 KB

Shared

Types:

Files

Types:

Methods:

  • client.files.create({ ...params }) -> FileCreateResponse
  • client.files.query({ ...params }) -> FileQueryResponse
  • client.files.list({ ...params }) -> FileListResponsesPaginatedCursor
  • client.files.retrieve(fileID, { ...params }) -> FileRetrieveResponse
  • client.files.delete(fileID, { ...params }) -> void
  • client.files.content(fileID, { ...params }) -> PresignedURL

Sheets

Types:

Methods:

  • client.sheets.create({ ...params }) -> SheetsJob
  • client.sheets.list({ ...params }) -> SheetsJobsPaginatedCursor
  • client.sheets.get(spreadsheetJobID, { ...params }) -> SheetsJob
  • client.sheets.getResultTable(regionType, { ...params }) -> PresignedURL
  • client.sheets.deleteJob(spreadsheetJobID, { ...params }) -> unknown

Split

Types:

Methods:

  • client.split.create({ ...params }) -> SplitCreateResponse
  • client.split.list({ ...params }) -> SplitListResponsesPaginatedCursor
  • client.split.get(splitJobID, { ...params }) -> SplitGetResponse
  • client.split.delete(splitJobID, { ...params }) -> unknown
  • client.split.cancel(splitJobID, { ...params }) -> SplitCancelResponse

Parsing

Types:

Methods:

  • client.parsing.create({ ...params }) -> ParsingCreateResponse
  • client.parsing.get(jobID, { ...params }) -> ParsingGetResponse
  • client.parsing.list({ ...params }) -> ParsingListResponsesPaginatedCursor
  • client.parsing.cancel(jobID, { ...params }) -> ParsingCancelResponse
  • client.parsing.listVersions() -> ParsingListVersionsResponse

Extract

Types:

Methods:

  • client.extract.create({ ...params }) -> ExtractV2Job
  • client.extract.list({ ...params }) -> ExtractV2JobsPaginatedCursor
  • client.extract.get(jobID, { ...params }) -> ExtractV2Job
  • client.extract.delete(jobID, { ...params }) -> unknown
  • client.extract.cancel(jobID, { ...params }) -> ExtractV2Job
  • client.extract.validateSchema({ ...params }) -> ExtractV2SchemaValidateResponse
  • client.extract.generateSchema({ ...params }) -> ConfigurationCreate

Classifier

Jobs

Types:

Methods:

  • client.classifier.jobs.create({ ...params }) -> ClassifyJob
  • client.classifier.jobs.list({ ...params }) -> ClassifyJobsPaginatedCursor
  • client.classifier.jobs.get(classifyJobID, { ...params }) -> ClassifyJob
  • client.classifier.jobs.getResults(classifyJobID, { ...params }) -> JobGetResultsResponse

Batches

Types:

Methods:

  • client.batches.create({ ...params }) -> BatchCreateResponse
  • client.batches.list({ ...params }) -> BatchListResponsesPaginatedCursor
  • client.batches.get(batchID, { ...params }) -> BatchGetResponse
  • client.batches.cancel(batchID, { ...params }) -> BatchCancelResponse

Classify

Types:

Methods:

  • client.classify.create({ ...params }) -> ClassifyCreateResponse
  • client.classify.list({ ...params }) -> ClassifyListResponsesPaginatedCursor
  • client.classify.get(jobID, { ...params }) -> ClassifyGetResponse
  • client.classify.cancel(jobID, { ...params }) -> ClassifyCancelResponse
  • client.classify.delete(jobID, { ...params }) -> ClassifyDeleteResponse

Configurations

Types:

Methods:

  • client.configurations.create({ ...params }) -> ConfigurationResponse
  • client.configurations.list({ ...params }) -> ConfigurationResponsesPaginatedCursor
  • client.configurations.retrieve(configID, { ...params }) -> ConfigurationResponse
  • client.configurations.update(configID, { ...params }) -> ConfigurationResponse
  • client.configurations.delete(configID, { ...params }) -> void

WebhookConfigs

Types:

Methods:

  • client.webhookConfigs.create({ ...params }) -> WebhookConfigResponse
  • client.webhookConfigs.list({ ...params }) -> WebhookConfigListResponse
  • client.webhookConfigs.listPaginated({ ...params }) -> WebhookConfigResponsesPaginatedCursor
  • client.webhookConfigs.retrieve(configID, { ...params }) -> WebhookConfigResponse
  • client.webhookConfigs.update(configID, { ...params }) -> WebhookConfigResponse
  • client.webhookConfigs.delete(configID, { ...params }) -> void

Projects

Types:

Methods:

  • client.projects.list({ ...params }) -> ProjectListResponse
  • client.projects.get(projectID, { ...params }) -> Project

V2Projects

Types:

Methods:

  • client.v2Projects.list({ ...params }) -> V2ProjectListResponsesPaginatedCursor
  • client.v2Projects.get(projectID, { ...params }) -> V2ProjectGetResponse

DataSinks

Types:

Methods:

  • client.dataSinks.list({ ...params }) -> DataSinkListResponse
  • client.dataSinks.create({ ...params }) -> DataSink
  • client.dataSinks.get(dataSinkID) -> DataSink
  • client.dataSinks.update(dataSinkID, { ...params }) -> DataSink
  • client.dataSinks.delete(dataSinkID) -> void

DataSources

Types:

Methods:

  • client.dataSources.list({ ...params }) -> DataSourceListResponse
  • client.dataSources.create({ ...params }) -> DataSource
  • client.dataSources.get(dataSourceID) -> DataSource
  • client.dataSources.update(dataSourceID, { ...params }) -> DataSource
  • client.dataSources.delete(dataSourceID) -> void

Pipelines

Types:

Methods:

  • client.pipelines.list({ ...params }) -> PipelineListResponse
  • client.pipelines.create({ ...params }) -> Pipeline
  • client.pipelines.get(pipelineID) -> Pipeline
  • client.pipelines.update(pipelineID, { ...params }) -> Pipeline
  • client.pipelines.delete(pipelineID) -> void
  • client.pipelines.getStatus(pipelineID, { ...params }) -> ManagedIngestionStatusResponse
  • client.pipelines.upsert({ ...params }) -> Pipeline
  • client.pipelines.retrieve(pipelineID, { ...params }) -> PipelineRetrieveResponse

Sync

Methods:

  • client.pipelines.sync.create(pipelineID) -> Pipeline
  • client.pipelines.sync.cancel(pipelineID) -> Pipeline

DataSources

Types:

Methods:

  • client.pipelines.dataSources.getDataSources(pipelineID) -> DataSourceGetDataSourcesResponse
  • client.pipelines.dataSources.updateDataSources(pipelineID, [ ...body ]) -> DataSourceUpdateDataSourcesResponse
  • client.pipelines.dataSources.update(dataSourceID, { ...params }) -> PipelineDataSource
  • client.pipelines.dataSources.getStatus(dataSourceID, { ...params }) -> ManagedIngestionStatusResponse
  • client.pipelines.dataSources.sync(dataSourceID, { ...params }) -> Pipeline

Images

Types:

Methods:

  • client.pipelines.images.listPageScreenshots(id, { ...params }) -> ImageListPageScreenshotsResponse
  • client.pipelines.images.getPageScreenshot(pageIndex, { ...params }) -> unknown
  • client.pipelines.images.getPageFigure(figureName, { ...params }) -> unknown
  • client.pipelines.images.listPageFigures(id, { ...params }) -> ImageListPageFiguresResponse

Files

Types:

Methods:

  • client.pipelines.files.getStatusCounts(pipelineID, { ...params }) -> FileGetStatusCountsResponse
  • client.pipelines.files.getStatus(fileID, { ...params }) -> ManagedIngestionStatusResponse
  • client.pipelines.files.create(pipelineID, [ ...body ]) -> FileCreateResponse
  • client.pipelines.files.update(fileID, { ...params }) -> PipelineFile
  • client.pipelines.files.delete(fileID, { ...params }) -> void
  • client.pipelines.files.list(pipelineID, { ...params }) -> PipelineFilesPaginatedPipelineFiles

Metadata

Types:

Methods:

  • client.pipelines.metadata.create(pipelineID, { ...params }) -> MetadataCreateResponse
  • client.pipelines.metadata.deleteAll(pipelineID) -> void

Documents

Types:

Methods:

  • client.pipelines.documents.create(pipelineID, [ ...body ]) -> DocumentCreateResponse
  • client.pipelines.documents.list(pipelineID, { ...params }) -> CloudDocumentsPaginatedCloudDocuments
  • client.pipelines.documents.getStatusCounts(pipelineID, { ...params }) -> DocumentGetStatusCountsResponse
  • client.pipelines.documents.get(documentID, { ...params }) -> CloudDocument
  • client.pipelines.documents.delete(documentID, { ...params }) -> void
  • client.pipelines.documents.getStatus(documentID, { ...params }) -> ManagedIngestionStatusResponse
  • client.pipelines.documents.sync(documentID, { ...params }) -> unknown
  • client.pipelines.documents.getChunks(documentID, { ...params }) -> DocumentGetChunksResponse
  • client.pipelines.documents.upsert(pipelineID, [ ...body ]) -> DocumentUpsertResponse

Retrievers

Types:

Methods:

  • client.retrievers.create({ ...params }) -> Retriever
  • client.retrievers.upsert({ ...params }) -> Retriever
  • client.retrievers.list({ ...params }) -> RetrieverListResponse
  • client.retrievers.listPaginated({ ...params }) -> RetrieversPaginatedCursor
  • client.retrievers.get(retrieverID, { ...params }) -> Retriever
  • client.retrievers.update(retrieverID, { ...params }) -> Retriever
  • client.retrievers.delete(retrieverID, { ...params }) -> void
  • client.retrievers.search({ ...params }) -> CompositeRetrievalResult

Retriever

Methods:

  • client.retrievers.retriever.search(retrieverID, { ...params }) -> CompositeRetrievalResult

Indexes

Types:

Methods:

  • client.indexes.get(indexID, { ...params }) -> IndexGetResponse
  • client.indexes.delete(indexID, { ...params }) -> void
  • client.indexes.create({ ...params }) -> IndexCreateResponse
  • client.indexes.sync(indexID, { ...params }) -> unknown
  • client.indexes.cancelSync(indexID, { ...params }) -> unknown
  • client.indexes.list({ ...params }) -> IndexListResponsesPaginatedCursor

Retrieval

Types:

Methods:

  • client.retrieval.retrieve({ ...params }) -> RetrievalRetrieveResponse
  • client.retrieval.find({ ...params }) -> RetrievalFindResponsesPaginatedCursorPost
  • client.retrieval.grep({ ...params }) -> RetrievalGrepResponsesPaginatedCursorPost
  • client.retrieval.read({ ...params }) -> RetrievalReadResponse

Chat

Types:

Methods:

  • client.chat.list({ ...params }) -> ChatListResponsesPaginatedCursor
  • client.chat.create({ ...params }) -> ChatCreateResponse
  • client.chat.retrieve(sessionID, { ...params }) -> ChatRetrieveResponse
  • client.chat.delete(sessionID, { ...params }) -> void
  • client.chat.getSummary(sessionID, { ...params }) -> ChatGetSummaryResponse
  • client.chat.stream(sessionID, { ...params }) -> unknown

Beta

Indexes

Types:

Methods:

  • client.beta.indexes.get(indexID, { ...params }) -> IndexGetResponse
  • client.beta.indexes.delete(indexID, { ...params }) -> void
  • client.beta.indexes.create({ ...params }) -> IndexCreateResponse
  • client.beta.indexes.sync(indexID, { ...params }) -> unknown
  • client.beta.indexes.list({ ...params }) -> IndexListResponsesPaginatedCursor

Retrieval

Types:

Methods:

  • client.beta.retrieval.retrieve({ ...params }) -> RetrievalRetrieveResponse
  • client.beta.retrieval.find({ ...params }) -> RetrievalFindResponsesPaginatedCursorPost
  • client.beta.retrieval.grep({ ...params }) -> RetrievalGrepResponsesPaginatedCursorPost
  • client.beta.retrieval.read({ ...params }) -> RetrievalReadResponse

Chat

Types:

Methods:

  • client.beta.chat.list({ ...params }) -> ChatListResponsesPaginatedCursor
  • client.beta.chat.create({ ...params }) -> ChatCreateResponse
  • client.beta.chat.retrieve(sessionID, { ...params }) -> ChatRetrieveResponse
  • client.beta.chat.delete(sessionID, { ...params }) -> void
  • client.beta.chat.getSummary(sessionID, { ...params }) -> ChatGetSummaryResponse
  • client.beta.chat.stream(sessionID, { ...params }) -> unknown

Attachments

Types:

Methods:

  • client.beta.attachments.list({ ...params }) -> AttachmentListResponsesPaginatedCursor
  • client.beta.attachments.get(attachmentName, { ...params }) -> PresignedURL

AgentData

Types:

Methods:

  • client.beta.agentData.get(itemID, { ...params }) -> AgentData
  • client.beta.agentData.update(itemID, { ...params }) -> AgentData
  • client.beta.agentData.delete(itemID, { ...params }) -> AgentDataDeleteResponse
  • client.beta.agentData.create({ ...params }) -> AgentData
  • client.beta.agentData.search({ ...params }) -> AgentDataPaginatedCursorPost
  • client.beta.agentData.aggregate({ ...params }) -> AgentDataAggregateResponsesPaginatedCursorPost
  • client.beta.agentData.deleteByQuery({ ...params }) -> AgentDataDeleteByQueryResponse

Sheets

Types:

Methods:

  • client.beta.sheets.create({ ...params }) -> SheetsJob
  • client.beta.sheets.list({ ...params }) -> SheetsJobsPaginatedCursor
  • client.beta.sheets.get(spreadsheetJobID, { ...params }) -> SheetsJob
  • client.beta.sheets.getResultTable(regionType, { ...params }) -> PresignedURL
  • client.beta.sheets.deleteJob(spreadsheetJobID, { ...params }) -> unknown

Directories

Types:

Methods:

  • client.beta.directories.create({ ...params }) -> DirectoryCreateResponse
  • client.beta.directories.list({ ...params }) -> DirectoryListResponsesPaginatedCursor
  • client.beta.directories.get(directoryID, { ...params }) -> DirectoryGetResponse
  • client.beta.directories.update(directoryID, { ...params }) -> DirectoryUpdateResponse
  • client.beta.directories.delete(directoryID, { ...params }) -> void

Files

Types:

Methods:

  • client.beta.directories.files.add(directoryID, { ...params }) -> FileAddResponse
  • client.beta.directories.files.list(directoryID, { ...params }) -> FileListResponsesPaginatedCursor
  • client.beta.directories.files.get(directoryFileID, { ...params }) -> FileGetResponse
  • client.beta.directories.files.update(directoryFileID, { ...params }) -> FileUpdateResponse
  • client.beta.directories.files.delete(directoryFileID, { ...params }) -> void
  • client.beta.directories.files.upload(directoryID, { ...params }) -> FileUploadResponse

Split

Types:

Methods:

  • client.beta.split.create({ ...params }) -> SplitCreateResponse
  • client.beta.split.list({ ...params }) -> SplitListResponsesPaginatedCursor
  • client.beta.split.get(splitJobID, { ...params }) -> SplitGetResponse

Alpha

Verify

Types:

Methods:

  • client.alpha.verify.list({ ...params }) -> VerifyListResponsesPaginatedCursor
  • client.alpha.verify.create({ ...params }) -> VerifyCreateResponse
  • client.alpha.verify.get(jobID, { ...params }) -> VerifyGetResponse
  • client.alpha.verify.cancel(jobID, { ...params }) -> VerifyCancelResponse
  • client.alpha.verify.getDetails(jobID, { ...params }) -> VerifyGetDetailsResponse