api.md

Ping

Types:

• PingCheckResponse
• PingStatusResponse

Methods:

• client.ping.check() -> PingCheckResponse
• client.ping.status() -> PingStatusResponse

Models

Types:

• ModelResponse
• ModelListResponse
• ModelDeleteResponse
• ModelListAvailableResponse
• ModelListCustomResponse

Methods:

• client.models.create({ ...params }) -> ModelResponse
• client.models.list() -> ModelListResponse
• client.models.delete(modelID) -> ModelDeleteResponse
• client.models.listAvailable() -> unknown
• client.models.listCustom() -> ModelListCustomResponse

Ingest

Types:

• TextRequest
• IngestBatchIngestFilesResponse
• IngestDocumentQueryResponse
• IngestRequeueResponse

Methods:

• client.ingest.batchIngestFiles({ ...params }) -> IngestBatchIngestFilesResponse
• client.ingest.documentQuery({ ...params }) -> IngestDocumentQueryResponse
• client.ingest.ingestFile({ ...params }) -> Document
• client.ingest.ingestText({ ...params }) -> Document
• client.ingest.requeue({ ...params }) -> IngestRequeueResponse

Folders

Types:

• Folder
• FolderDetails
• FolderDetailsResponse
• FolderSummary
• FolderListResponse
• FolderDeleteResponse
• FolderListSummariesResponse

Methods:

• client.folders.create({ ...params }) -> Folder
• client.folders.retrieve(folderIDOrName) -> Folder
• client.folders.list() -> FolderListResponse
• client.folders.delete(folderIDOrName, { ...params }) -> FolderDeleteResponse
• client.folders.details({ ...params }) -> FolderDetailsResponse
• client.folders.getSummary(folderIDOrName) -> SummaryResponse
• client.folders.listSummaries() -> FolderListSummariesResponse
• client.folders.upsertSummary(folderIDOrName, { ...params }) -> SummaryResponse

Documents

Types:

• DocumentAddResponse

Methods:

• client.folders.documents.add(documentID, { ...params }) -> DocumentAddResponse
• client.folders.documents.remove(documentID, { ...params }) -> DocumentDeleteResponse

APIKeys

Types:

• APIKeyCreateResponse
• APIKeyListResponse

Methods:

• client.apiKeys.create({ ...params }) -> APIKeyCreateResponse
• client.apiKeys.list() -> APIKeyListResponse

Logs

Types:

• LogListResponse

Methods:

• client.logs.list({ ...params }) -> LogListResponse

Ee

Connectors

Types:

• ConnectorDisconnectResponse
• ConnectorFinalizeAuthResponse
• ConnectorGetAuthStatusResponse
• ConnectorHandleOAuthCallbackResponse
• ConnectorIngestFileResponse
• ConnectorIngestRepositoryResponse
• ConnectorInitiateAuthResponse
• ConnectorListFilesResponse
• ConnectorListFilesViaBodyResponse
• ConnectorStatusResponse

Methods:

• client.ee.connectors.disconnect({ ...params }) -> unknown
• client.ee.connectors.finalizeAuth({ ...params }) -> unknown
• client.ee.connectors.getAuthStatus(connectorType) -> ConnectorGetAuthStatusResponse
• client.ee.connectors.handleOAuthCallback(connectorType, { ...params }) -> unknown
• client.ee.connectors.ingestFile(connectorType, { ...params }) -> unknown
• client.ee.connectors.ingestRepository(connectorType, { ...params }) -> unknown
• client.ee.connectors.initiateAuth({ ...params }) -> unknown
• client.ee.connectors.listFiles(connectorType, { ...params }) -> ConnectorListFilesResponse
• client.ee.connectors.listFilesViaBody({ ...params }) -> unknown
• client.ee.connectors.status({ ...params }) -> unknown

Auth

Types:

• AuthFinalizeManualAuthResponse
• AuthGetInitiateAuthURLResponse

Methods:

• client.ee.connectors.auth.finalizeManualAuth(connectorType, { ...params }) -> AuthFinalizeManualAuthResponse
• client.ee.connectors.auth.getInitiateAuthURL(connectorType, { ...params }) -> AuthGetInitiateAuthURLResponse

Retrieve

Types:

• RetrieveCreateDocsResponse

Methods:

• client.retrieve.createDocs({ ...params }) -> RetrieveCreateDocsResponse

Chunks

Types:

• ChunkResult
• RetrieveRequest
• ChunkCreateResponse
• ChunkCreateGroupedResponse

Methods:

• client.retrieve.chunks.create({ ...params }) -> ChunkCreateResponse
• client.retrieve.chunks.createGrouped({ ...params }) -> ChunkCreateGroupedResponse

Batch

Types:

• BatchRetrieveChunksResponse
• BatchRetrieveDocumentsResponse

Methods:

• client.batch.retrieveChunks({ ...params }) -> BatchRetrieveChunksResponse
• client.batch.retrieveDocuments({ ...params }) -> BatchRetrieveDocumentsResponse

Search

Types:

• SearchDocumentsResponse

Methods:

• client.search.documents({ ...params }) -> SearchDocumentsResponse

Query

Types:

• QueryGenerateCompletionResponse

Methods:

• client.query.generateCompletion({ ...params }) -> QueryGenerateCompletionResponse

Cloud

Types:

• CloudDeleteAppResponse
• CloudGenerateUriResponse
• CloudListAppsResponse
• CloudRenameAppResponse
• CloudRotateAppTokenResponse

Methods:

• client.cloud.deleteApp({ ...params }) -> CloudDeleteAppResponse
• client.cloud.generateUri({ ...params }) -> CloudGenerateUriResponse
• client.cloud.listApps({ ...params }) -> unknown
• client.cloud.renameApp({ ...params }) -> CloudRenameAppResponse
• client.cloud.rotateAppToken({ ...params }) -> CloudRotateAppTokenResponse

Usage

Types:

• AppStorageUsageResponse

Methods:

• client.usage.appStorageUsage() -> AppStorageUsageResponse

Documents

Types:

• Document
• DocumentDeleteResponse
• DocumentDownloadURLResponse
• SummaryResponse
• DocumentListResponse
• DocumentDownloadFileResponse
• DocumentGetStatusResponse
• DocumentListDocsResponse
• DocumentPagesResponse

Methods:

• client.documents.retrieve(documentID) -> Document
• client.documents.list({ ...params }) -> DocumentListResponse
• client.documents.delete(documentID) -> DocumentDeleteResponse
• client.documents.downloadFile(documentID) -> unknown
• client.documents.getByFilename(filename, { ...params }) -> Document
• client.documents.getDownloadURL(documentID, { ...params }) -> DocumentDownloadURLResponse
• client.documents.getStatus(documentID) -> DocumentGetStatusResponse
• client.documents.getSummary(documentID) -> SummaryResponse
• client.documents.listDocs({ ...params }) -> DocumentListDocsResponse
• client.documents.pages({ ...params }) -> DocumentPagesResponse
• client.documents.updateFile(documentID, { ...params }) -> Document
• client.documents.updateMetadata(documentID, { ...params }) -> Document
• client.documents.updateText(documentID, { ...params }) -> Document
• client.documents.upsertSummary(documentID, { ...params }) -> SummaryResponse

Chat

Types:

• ChatListResponse
• ChatRetrieveHistoryResponse
• ChatUpdateTitleResponse

Methods:

• client.chat.list({ ...params }) -> ChatListResponse
• client.chat.retrieveHistory(chatID) -> ChatRetrieveHistoryResponse
• client.chat.updateTitle(chatID, { ...params }) -> ChatUpdateTitleResponse