@spec checkdocumentaccess(
  body :: Gleanex.Indexing.CheckDocumentAccessRequest.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.CheckDocumentAccessResponse.t()}
  | {:error, Gleanex.Error.t()}

Check document access

Check if a given user has access to access a document in a custom datasource

Tip: Refer to the Troubleshooting tutorial for more information.

Request Body

Content Types: application/json

@spec debug_datasource_document(
  datasource :: String.t(),
  body :: Gleanex.Indexing.DebugDocumentRequest.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.DebugDocumentResponse.t()}
  | {:error, Gleanex.Error.t()}

Beta: Get document information

Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice.

Tip: Refer to the Troubleshooting tutorial for more information.

Request Body

Content Types: application/json

@spec debug_datasource_document_events(
  datasource :: String.t(),
  body :: Gleanex.Indexing.DebugDocumentLifecycleRequest.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.DebugDocumentLifecycleResponse.t()}
  | {:error, Gleanex.Error.t()}

Beta: Get document lifecycle events

Retrieves lifecycle events for a specific document including upload time, index times and deletions. Rate limited to 1 request per minute per datasource. Currently in beta, might undergo breaking changes without prior notice.

Request Body

Content Types: application/json

@spec debug_datasource_documents(
  datasource :: String.t(),
  body :: Gleanex.Indexing.DebugDocumentsRequest.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.DebugDocumentsResponse.t()}
  | {:error, Gleanex.Error.t()}

Beta: Get information of a batch of documents

Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice.

Tip: Refer to the Troubleshooting tutorial for more information.

Request Body

Content Types: application/json

@spec debug_datasource_status(datasource :: String.t(), opts :: keyword()) ::
  {:ok, Gleanex.Indexing.DebugDatasourceStatusResponse.t()}
  | {:error, Gleanex.Error.t()}

Beta: Get datasource status

Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice.

Tip: Refer to the Troubleshooting tutorial for more information.

@spec debug_datasource_user(
  datasource :: String.t(),
  body :: Gleanex.Indexing.DebugUserRequest.t(),
  opts :: keyword()
) :: {:ok, Gleanex.Indexing.DebugUserResponse.t()} | {:error, Gleanex.Error.t()}

Beta: Get user information

Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice.

Tip: Refer to the Troubleshooting tutorial for more information.

Request Body

Content Types: application/json

@spec getdocumentcount(
  body :: Gleanex.Indexing.GetDocumentCountRequest.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.GetDocumentCountResponse.t()}
  | {:error, Gleanex.Error.t()}

Get document count

Fetches document count for the specified custom datasource.

Tip: Use /debug/{datasource}/status for richer information.

Request Body

Content Types: application/json

@spec getdocumentstatus(
  body :: Gleanex.Indexing.GetDocumentStatusRequest.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.GetDocumentStatusResponse.t()}
  | {:error, Gleanex.Error.t()}

Get document upload and indexing status

Intended for debugging/validation. Fetches the current upload and indexing status of documents.

Tip: Use /debug/{datasource}/document for richer information.

Request Body

Content Types: application/json

@spec getusercount(
  body :: Gleanex.Indexing.GetUserCountRequest.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.GetUserCountResponse.t()} | {:error, Gleanex.Error.t()}

Get user count

Fetches user count for the specified custom datasource.

Tip: Use /debug/{datasource}/status for richer information.

Request Body

Content Types: application/json