Provides API endpoints related to verification
Summary
Types
@type t() :: %Gleanex.Client.Verification{ metadata: Gleanex.Client.VerificationMetadata.t() | nil, state: String.t() }
Functions
@spec addverificationreminder( body :: Gleanex.Client.ReminderRequest.t(), opts :: keyword() ) :: {:ok, t()} | {:error, Gleanex.Error.t()}
Create verification
Creates a verification reminder for the document. Users can create verification reminders from different product surfaces.
Options
locale: The client's preferred locale in rfc5646 format (e.g.en,ja,pt-BR). If omitted, theAccept-Languagewill be used. If not present or not supported, defaults to the closest match oren.
Request Body
Content Types: application/json
Details about the reminder.
@spec listverifications(opts :: keyword()) :: {:ok, Gleanex.Client.VerificationFeed.t()} | {:error, Gleanex.Error.t()}
List verifications
Returns the information to be rendered in verification dashboard. Includes information for each document owned by user regarding their verifications.
Options
count: Maximum number of documents to returnlocale: The client's preferred locale in rfc5646 format (e.g.en,ja,pt-BR). If omitted, theAccept-Languagewill be used. If not present or not supported, defaults to the closest match oren.
@spec verify(body :: Gleanex.Client.VerifyRequest.t(), opts :: keyword()) :: {:ok, t()} | {:error, Gleanex.Error.t()}
Update verification
Verify documents to keep the knowledge up to date within customer corpus.
Options
locale: The client's preferred locale in rfc5646 format (e.g.en,ja,pt-BR). If omitted, theAccept-Languagewill be used. If not present or not supported, defaults to the closest match oren.
Request Body
Content Types: application/json
Details about the verification request.