Chatbot Factory Service (CFS) Client Library

The client library allows consuming the service REST API.

Index

Service Client

Class Description
ChatbotFactoryClient The entry point of the Chatbot Factory Service client library.

^ Back to top

Controllers

Class Description
AlertDefinition The alert definition controller.
AlertEventMetric The alert event metric controller.
AlertExecution The alert execution controller.
AlertJobSchedule The alert job schedule controller.
App The application controller.
Audit The audit controller.
Chat The chat controller.
Chatbot The chatbot controller.
Feedback The feedback controller.
Metric The metric controller.
ModelDefinition The model definition controller.
Prompt The prompt controller.
PromptFunction The prompt function controller.
PromptSession The prompt session controller.
Session The session controller.
SessionItem The session item controller.
TestDefinition The test definition controller.
TestExecution The test execution controller.
UsageMetric The usage metric controller.
UsagePlan The usage plan controller.
UsagePlanItem The usage plan item controller.
UsageRecord The usage record controller.
WorkflowRun The workflow run controller.
WorkflowRunItem The workflow run item controller.

^ Back to top

Models

Class Description
AlertDefinition Describes an alert definition.
AlertDefinitionAction Describes an alert definition action.
AlertDefinitionEvaluation Describes an alert definition evaluation.
AlertDefinitionEvent Describes an alert definition event.
AlertDefinitionSchedule Describes an alert definition schedule.
AlertEventMetric Describes an alert event metric.
AlertExecution Describes an alert execution.
AlertJobSchedule Describes an alert job schedule.
AssistantTestExecutionRes Describes an assistant test execution res.
Audit Describes an audit.
BaseEntity Describes a base entity.
BasePage Describes a base page.
Chatbot Describes a chatbot.
ChatRequest Describes a chat request.
ChatResponse Describes a chat response.
ConnectAnonymousResponse Describes a connect anonymous response.
DashboardMetricFilterRes Describes a dashboard metric filter resource.
DashboardMetricRes Describes a dashboard metric resource.
DashboardMetricValuesRes Describes a dashboard metric values resource.
DashboardReferenceFilterRes Describes a dashboard reference filter resource.
DashboardReferenceRes Describes a dashboard reference resource.
Feedback Describes a feedback.
HistoryRes Describes a history resource.
HistoryResContent Describes a history resource content.
HistoryResPage Describes a history resource page.
KeyValuePair Describes a key-value pair.
Metric Describes a metric.
ModelDefinition Describes a model definition.
Prompt Describes a prompt.
PromptFunctionRequest Describes a prompt function request.
PromptFunctionResponse Describes a prompt function response.
PromptSession Describes a prompt session.
QueryExpression Describes a query expression.
RoleAccessControlRes Describes a role access control request resource.
RoleAccessControlResponseRes Describes a role access control response resource.
RoleAccessControlResponseResPage Describes a role access control response resource page.
Session Describes a session.
SessionItem Describes a session item.
SystemEntity Describes a system entity.
TestDefinition Describes a test definition.
TestExecution Describes a test execution.
TestExecutionChatRequest Describes a test execution chat request.
TestExecutionChatResponse Describes a test execution chat response.
TestExecutionOutputRes Describes a test execution output res.
TestExecutionRequest Describes a test execution request.
UsageMetric Describes an usage metric.
UsagePlan Describes an usage plan.
UsagePlanItem Describes an usage plan item.
UsagePlanItemRes Describes an usage plan item resource.
UsageQuota Describes a usage quota.
UsageRecord Describes an usage record.
UserInformation Describes a user information.
WorkflowRun Describes a workflow run.
WorkflowRunItem Describes a workflow run item.

^ Back to top

Enumerations

Enumeration Description
AlertDefinitionActionType Defines the alert action type.
AlertDefinitionEvaluationType Defines the alert evaluation type.
AlertDefinitionEventType Defines the alert event type.
AlertDefinitionReferenceType Defines the alert reference type.
AlertExecutionStatus The alert execution status.
AlertJobScheduleStatus The alert job schedule status.
AssistantTestExecutionStatus Defines the assistant test execution statuses.
AuditSourceType Defines the audit source types.
AuditType Defines the audit types.
ChunkType Defines a chunk type.
DashboardMetricPeriod Defines the usage periods.
FeedbackSourceType Defines the feedback source type.
FeedbackType Defines the feedback type.
HistoryOrder Defines the history order.
HistoryType Defines the history type.
MetricType Defines the metric types.
ModelProvider Defines the providers of a model.
PromptFormat Defines the formats of a prompt.
PromptSessionStatus The prompt session status.
PromptType Defines the types of a prompt.
RoleLevel Defines a role level.
SessionItemType Defines the types of a session item.
TestDefinitionTarget Defines targets of evaluation.
TestDefinitionType Defines the types of test definition.
TestExecutionStatus Defines the status of test definition execution.
UsageMetricStatus Defines the usage metric status.
UsagePeriod Defines the usage periods.
UsageRecordStatus Defines the usage record status.
UsageReferenceType Defines the usage reference type.
UsageSourceType Defines the usage source type.
WorkflowRunStatus Defines a workflow run status.

^ Back to top

Authorization Policies

Policy Description Scope
DefaultScope Defines an authorization policy that requires the default scope. lithium-chatbotfactory
Application Defines an authorization policy that requires the application scope. lithium-chatbotfactory-app
BackOffice Defines an authorization policy that requires the back office scope. lithium-chatbotfactory-backoffice
Hybrid Defines an authorization policy over authenticated and anonymous requests. N/A
SessionHub Defines an authorization policy that requires the session hub scope. N/A
TestExecutionHub Defines an authorization policy that requires the test execution hub scope. N/A

^ Back to top

Reference

Service Client

ChatbotFactoryClient

Constructors
ChatbotFactoryClient(Uri, BearerTokenCredential)
Parameter Type Description
serviceUri Uri The service URI.
credential BearerTokenCredential The credential that should be used to access the service.
ChatbotFactoryClient(Uri, BearerTokenCredential, ChatbotFactoryClientOptions)
Parameter Type Description
serviceUri Uri The service URI.
credential BearerTokenCredential The credential that should be used to access the service.
clientOptions ChatbotFactoryClientOptions The client options.
Example
Uri address = new Uri("[service-address]");
Uri authorizationServer = new Uri("[authorization-server]");
string clientId = "[client-id]"
string clientSecret = "[client-secret]"

ChatbotFactoryClient client = new ChatbotFactoryClient(
    new Uri(address),
    new ClientSecretCredential(
        authorizationServer,
        clientId,
        clientSecret));

^ Back to top

Error Codes

ErrorCodes

Constants
Constants Description Remarks
AlreadyExists The resource already exists.
FeatureNotEnabled The feature is not enabled.
InternalServerError An internal error occurred while processing your request.
MaintenanceMode The service is currently in maintenance mode.
NotAuthorized The requested action is not authorized.
NotExists The resource is not found.
NotImplemented The requested action is not implemented.
Processing There was a processing error while handling the request.
RequestArgsInvalid The request arguments are invalid.
TenantMismatch The tenants of the request do not match the resource.
Validation There was a validation error while handling the request.

Controllers

AlertDefinitionClientController

The alert definition controller.

Methods
CreateAsync()

Creates an alert definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition alertDefinition, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
alertDefinition Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition The alert definition. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The alert definition identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an alert definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an alert definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition The alert definition.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches alert definitions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition> The alerts.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an alert definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition alertDefinition, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
alertDefinition Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinition The alert definition. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

AlertEventMetricClientController

The alert event metric controller.

Methods
CreateAsync()

Creates an alert event metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric alertEventMetric, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
alertEventMetric Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric The alert event metric. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The alert event metric identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an alert event metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an alert event metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric The alert event metric.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches alert event metrics.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric> The alert event metrics.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an alert event metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric alertEventMetric, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
alertEventMetric Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertEventMetric The alert event metric. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

AlertExecutionClientController

The alert execution controller.

Methods
CreateAsync()

Creates an alert execution.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution alertExecution, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
alertExecution Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution The alert execution. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The alert execution identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an alert execution.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an alert execution.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution The alert execution.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches alerts executions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution> The alerts executions.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an alert execution.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution alertExecution, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
alertExecution Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecution The alert execution. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

AlertJobScheduleClientController

The alert job schedule controller.

Methods
CreateAsync()

Creates an alert job schedule.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule alertJobSchedule, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
alertJobSchedule Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule The alert job schedule. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The alert job schedule identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an alert job schedule.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an alert job schedule.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule The alert job schedule.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches alert job schedules.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule> The alert job schedules.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an alert job schedule.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule alertJobSchedule, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
alertJobSchedule Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobSchedule The alert job schedule. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

AppClientController

The application controller.

Methods
AddUsagePlanAsync()

Adds a usage plan.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> AddUsagePlanAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan usagePlan, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usagePlan Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan The usage plan. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The usage plan identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CreateRoleAccessControlAsync()

Creates a role access control.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateRoleAccessControlAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlRes roleAccessControl, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
roleAccessControl Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlRes The role access control. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The role access control identifier.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteRoleAccessControlAsync()

Deletes the role access control that matches the specified identifier.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteRoleAccessControlAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The role access control identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

IsAuthorizedAsync()

Determines whether the client is authorized to access the application.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<bool>> IsAuthorizedAsync(CancellationToken cancellationToken = default);
Parameters

The operation has no parameters.

Returns
Return Type Description
bool Returns true if the specified client is authorized; otherwise, false.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadHistoryAsync()

Reads the history of a given session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryResPage>> ReadHistoryAsync(string sessionId, string? sessionItemId, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryType type, string? continuationToken, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryOrder orderBy = HistoryOrder.Ascending, int pageSize = 200, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
sessionId string The session identifier. Required.
sessionItemId string? The session item identifier. Required.
type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryType The history type. Required.
continuationToken string? The history continuation token. Required.
orderBy Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryOrder The history order. Required.
pageSize int The history page size. Required.< 200. > 0.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryResPage The session history page.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadRoleAccessControlAsync()

Reads a role access control.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlResponseRes>> ReadRoleAccessControlAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The role access control identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlResponseRes The role access control response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAssistantTestExecutionAsync()

Searches assistant test execution resources.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AssistantTestExecutionRes>>> SearchAssistantTestExecutionAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AssistantTestExecutionRes> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AssistantTestExecutionRes> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AssistantTestExecutionRes> The assistant test execution resources.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchDashboardBusinessKeyAsync()

Searches the business keys of a given usage plan identifier.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<string>>> SearchDashboardBusinessKeyAsync(string usagePlanId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usagePlanId string The usage plan identifier. Required.
Returns
Return Type Description
System.Collections.Generic.IList<string> The business keys.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchDashboardMetricAsync()

Searches the dashboar metrics of a given dashboard metric filter.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardMetricRes>> SearchDashboardMetricAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardMetricFilterRes dashboardMetricFilter, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
dashboardMetricFilter Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardMetricFilterRes The dashboard metric filter. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardMetricRes The dashboard metrics.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchDashboardReferenceAsync()

Searches the references of a given dashboard reference filter.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardReferenceRes>>> SearchDashboardReferenceAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardReferenceFilterRes dashboardReferenceFilter, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
dashboardReferenceFilter Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardReferenceFilterRes The dashboard reference filter. Required.
Returns
Return Type Description
System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardReferenceRes> The usage metric references.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchRoleAccessControlAsync()

Searches the role access control pages.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlResponseResPage>> SearchRoleAccessControlAsync(System.Collections.Generic.IEnumerable<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.QueryExpression>? query, string? continuationToken, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
query System.Collections.Generic.IEnumerable<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.QueryExpression>? The query. Required.
continuationToken string? The continuation token. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlResponseResPage The items.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchTestExecutionOutputAsync()

Searches test execution output resources.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionOutputRes>>> SearchTestExecutionOutputAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionOutputRes> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionOutputRes> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionOutputRes> The test execution output resources.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchUsagePlanItemAsync()

Searches usage plan item resources.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItemRes>>> SearchUsagePlanItemAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItemRes> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItemRes> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItemRes> The usage plan item resources.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateRoleAccessControlAsync()

Updates the role access control.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateRoleAccessControlAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlRes roleAccessControl, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
roleAccessControl Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlRes The role access control. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateUsagePlanAsync()

Updates a usage plan.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateUsagePlanAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan usagePlan, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usagePlan Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan The usage plan. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

AuditClientController

The audit controller.

Methods
CreateAsync()

Creates an audit.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit audit, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
audit Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit The audit. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The audit identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an audit.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an audit.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit The audit identifier.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches audits.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit> The audits.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an audit.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit audit, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
audit Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Audit The audit. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ChatClientController

The chat controller.

Methods
ConnectAnonymousAsync()

Creates a temporary connection for anonymous users.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ConnectAnonymousResponse>> ConnectAnonymousAsync(string physicalKey, string businessKey, string? hostOrigin, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
hostOrigin string? The host origin. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ConnectAnonymousResponse The connection cookie and the connect anonymous response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CreateFeedbackAsync()

Adds a feedback.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateFeedbackAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback feedback, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
feedback Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback The feedback. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The feedback identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CreateSessionAsync()

Creates a session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateSessionAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session session, bool sideEffects = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
session Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session The session. Required.
sideEffects bool Indicates whether the operation should trigger side effects. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The session identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CreateSessionItemAsync()

Creates a session item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateSessionItemAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem sessionItem, bool sideEffects = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
sessionItem Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem The session item. Required.
sideEffects bool Indicates whether the operation should trigger side effects. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The session item identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteFeedbackAsync()

Updates a feedback.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteFeedbackAsync(string physicalKey, string businessKey, string feedbackId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
feedbackId string The feedback identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadChatbotAsync()

Reads a chatbot.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot>> ReadChatbotAsync(string physicalKey, string businessKey, string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot The chatbot.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadHistoryAsync()

Reads the history of a given session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryResPage>> ReadHistoryAsync(string physicalKey, string businessKey, string sessionId, string? sessionItemId, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryType type, string? continuationToken, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryOrder orderBy = HistoryOrder.Ascending, int pageSize = 200, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
sessionId string The session identifier. Required.
sessionItemId string? The session item identifier. Required.
type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryType The history type. Required.
continuationToken string? The history continuation token. Required.
orderBy Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryOrder The history order. Required.
pageSize int The history page size. Required.< 200. > 0.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryResPage The session history page.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadSessionAsync()

Reads a session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session>> ReadSessionAsync(string physicalKey, string businessKey, string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session The session.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadSessionItemAsync()

Reads a session item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem>> ReadSessionItemAsync(string physicalKey, string businessKey, string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem The session item.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadUserInformationAsync()

Reads the logged in user information.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UserInformation>> ReadUserInformationAsync(string physicalKey, string businessKey, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UserInformation The logged in user information.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchSessionAsync()

Searches sessions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session>>> SearchSessionAsync(string physicalKey, string businessKey, Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session> The sessions.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchUsageQuotaAsync()

Searches the usage quotas.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageQuota>>> SearchUsageQuotaAsync(string physicalKey, string businessKey, string usagePlanId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
usagePlanId string The usage plan identifier. Required.
Returns
Return Type Description
System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageQuota> The usage quotas.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SendMessageAsync()

Sends a message and returns the assistant response.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChatResponse>> SendMessageAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChatRequest chatRequest, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
chatRequest Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChatRequest The chat request. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChatResponse The assistant response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SendMessageStreamAsync()

Sends a message and streams the assistant response.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResultContainer<System.Collections.Generic.IAsyncEnumerable<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChatResponse?>>> SendMessageStreamAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChatRequest chatRequest, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
chatRequest Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChatRequest The chat request. Required.
Returns
Return Type Description
System.Collections.Generic.IAsyncEnumerable<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChatResponse?> The assistant response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateSessionAsync()

Updates a session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateSessionAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session session, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
session Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session The session. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateSessionItemAsync()

Updates a session item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateSessionItemAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem sessionItem, bool sideEffects = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The chat physical key. Required.
businessKey string The chat business key. Required.
sessionItem Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem The session item. Required.
sideEffects bool Indicates whether the operation should trigger side effects. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ChatbotClientController

The chatbot controller.

Methods
CreateAsync()

Creates a chatbot.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot chatbot, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
chatbot Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot The chatbot. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The chatbot identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a chatbot.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a chatbot.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot The chatbot.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches chatbots.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot> The chatbots.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a chatbot.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot chatbot, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
chatbot Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Chatbot The chatbot. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

FeedbackClientController

The feedback controller.

Methods
CreateAsync()

Creates a feedback.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback feedback, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
feedback Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback The feedback. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The feedback identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a feedback.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a feedback.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback The feedback.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches feedbacks.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback> The feedbacks.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a feedback.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback feedback, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
feedback Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Feedback The feedback. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

MetricClientController

The metric controller.

Methods
CreateAsync()

Creates a metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric metric, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
metric Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric The metric. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The metric identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric The metric.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches metrics.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric> The metrics.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric metric, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
metric Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Metric The metric. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ModelDefinitionClientController

The model definition controller.

Methods
CreateAsync()

Creates a model definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition modelDefinition, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
modelDefinition Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition The model definition. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The model definition identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a model definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a model definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition The model definition.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches model definitions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition> The model definitions.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a model definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition modelDefinition, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
modelDefinition Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelDefinition The model definition. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

PromptClientController

The prompt controller.

Methods
CreateAsync()

Creates a prompt.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt prompt, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
prompt Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt The prompt. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The prompt identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a prompt.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a prompt.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt The prompt.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches prompts.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt> The prompts.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a prompt.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt prompt, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
prompt Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt The prompt. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

PromptFunctionClientController

The prompt function controller.

Methods
InvokeAsync()

Invokes a prompt function.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionResponse>> InvokeAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionRequest promptFunctionRequest, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The physical key. Required.
businessKey string The business key. Required.
promptFunctionRequest Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionRequest The prompt function request. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionResponse The prompt function response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

InvokeStreamAsync()

Invokes a prompt function and streams the response.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResultContainer<System.Collections.Generic.IAsyncEnumerable<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionResponse?>>> InvokeStreamAsync(string physicalKey, string businessKey, Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionRequest promptFunctionRequest, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
physicalKey string The physical key. Required.
businessKey string The business key. Required.
promptFunctionRequest Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionRequest The prompt function request. Required.
Returns
Return Type Description
System.Collections.Generic.IAsyncEnumerable<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionResponse?> The prompt function response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

PromptSessionClientController

The prompt session controller.

Methods
CreateAsync()

Creates a prompt session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession promptSession, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
promptSession Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession The prompt session. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The prompt session identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a prompt session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reades a prompt session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession The prompt session.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches prompt sessions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession> The prompt sessions.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a prompt session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession promptSession, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
promptSession Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSession The prompt session. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SessionClientController

The session controller.

Methods
CreateAsync()

Creates a session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session session, bool sideEffects = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
session Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session The session. Required.
sideEffects bool Indicates whether the operation should trigger side effects. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The session identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session The session.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches sessions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session> The sessions.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a session.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session session, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
session Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Session The session. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SessionItemClientController

The session item controller.

Methods
CreateAsync()

Creates a session item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem sessionItem, bool sideEffects = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
sessionItem Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem The session item. Required.
sideEffects bool Indicates whether the operation should trigger side effects. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The session item identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a session item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, bool sideEffects = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
sideEffects bool Indicates whether the operation should trigger side effects. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a session item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem The session item.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches session items.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem> The session items.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a session item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem sessionItem, bool sideEffects = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
sessionItem Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItem The session item. Required.
sideEffects bool Indicates whether the operation should trigger side effects. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

TestDefinitionClientController

The test definition controller.

Methods
CreateAsync()

Create a test definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition testDefinition, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
testDefinition Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition The test definition. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The test definition identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a test definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a test definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition The test definition.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches test definitions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition> The test definitions.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a test definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition testDefinition, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
testDefinition Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinition The test definition. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

TestExecutionClientController

The test execution controller.

Methods
CallbackAsync()

Receives a test execution callback.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> CallbackAsync(CancellationToken cancellationToken = default);
Parameters

The operation has no parameters.

Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CreateAsync()

Create test definition execution.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution testExecution, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
testExecution Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution The test execution. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The test definition execution identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a test definition execution.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

InvokeAsync()

Invokes a test execution request.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> InvokeAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionRequest testExecutionRequest, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
testExecutionRequest Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionRequest The test execution request. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a test execution.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution The test definition execution.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches test executions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution> The test executions.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SendMessageAsync()

Sends a message and returns an assistant response.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionChatResponse>> SendMessageAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionChatRequest testExecutionChatRequest, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
testExecutionChatRequest Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionChatRequest The test execution chat request. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionChatResponse The assistant response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SendMessageStreamAsync()

Sends a message and streams an assistant response.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResultContainer<System.Collections.Generic.IAsyncEnumerable<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionChatResponse?>>> SendMessageStreamAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionChatRequest testExecutionChatRequest, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
testExecutionChatRequest Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionChatRequest The test execution chat request. Required.
Returns
Return Type Description
System.Collections.Generic.IAsyncEnumerable<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionChatResponse?> The assistant response.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a test definition execution.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution testExecution, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
testExecution Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecution The test execution. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UsageMetricClientController

The usage metric controller.

Methods
CreateAsync()

Creates an usage metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric usageMetric, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usageMetric Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric The usage metric. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The usage metric identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an usage metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an usage metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric The usage metric.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches usage metrics.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric> The usage metrics.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an usage metric.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric usageMetric, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usageMetric Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetric The usage metric. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UsagePlanClientController

The usage plan controller.

Methods
CreateAsync()

Creates an usage plan.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan usagePlan, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usagePlan Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan The usage plan. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The usage plan identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an usage plan.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an usage plan.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan The usage plan.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches usage plans.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan> The usage plans.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an usage plan.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan usagePlan, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usagePlan Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlan The usage plan. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UsagePlanItemClientController

The usage plan item controller.

Methods
CreateAsync()

Creates an usage plan item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem usagePlanItem, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usagePlanItem Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem The usage plan item. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The usage plan item identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an usage plan item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an usage plan item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem The usage plan item.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches usage plan items.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem> The usage plan items.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an usage plan item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem usagePlanItem, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usagePlanItem Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePlanItem The usage plan item. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UsageRecordClientController

The usage record controller.

Methods
CreateAsync()

Creates an usage record.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord usageRecord, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usageRecord Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord The usage record. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The usage record identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes an usage record.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads an usage record.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord The usage record.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches usage records.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord> The usage records.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates an usage record.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord usageRecord, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
usageRecord Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecord The usage record. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

WorkflowRunClientController

The workflow run controller.

Methods
CreateAsync()

Creates a workflow run.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun workflowRun, string? sessionId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workflowRun Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun The workflow run. Required.
sessionId string? The session identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The workflow run identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a workflow run.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a workflow run.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun The workflow run.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches workflow runs.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun> The workflow runs.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a workflow run.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun workflowRun, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workflowRun Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRun The workflow run. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

WorkflowRunItemClientController

The workflow run item controller.

Methods
CreateAsync()

Creates a workflow run item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity>> CreateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem workflowRunItem, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workflowRunItem Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem The workflow run item. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.BaseEntity The workflow run item identifier.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Deletes a workflow run item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ReadAsync()

Reads a workflow run item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem>> ReadAsync(string id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id string The identifier. Required.
Returns
Return Type Description
Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem The workflow run item.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SearchAsync()

Searches workflow run items.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem> The workflow run items.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Updates a workflow run item.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem workflowRunItem, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workflowRunItem Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunItem The workflow run item. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

Models

AlertDefinition

Describes an alert definition.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
ReferenceType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionReferenceType The reference type. Required.
ReferenceId string The reference identifier. Required.
Description string The description. Required.
Event Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionEvent The event. Required.
Actions System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionAction> The actions. Required.
Schedule Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionSchedule The schedule. Required.
Evaluation Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionEvaluation The evaluation. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The metadata.

^ Back to top

AlertDefinitionAction

Describes an alert definition action.

Properties
Property Type Description Rules
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionActionType The action type. Required.
Settings System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The settings.

^ Back to top

AlertDefinitionEvaluation

Describes an alert definition evaluation.

Properties
Property Type Description Rules
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionEvaluationType The evaluation type. Required.
Settings System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The settings.

^ Back to top

AlertDefinitionEvent

Describes an alert definition event.

Properties
Property Type Description Rules
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionEventType The event type. Required.
Settings System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The settings.

^ Back to top

AlertDefinitionSchedule

Describes an alert definition schedule.

Properties
Property Type Description Rules
StartDate System.DateTime The start date. Required.
EndDate System.DateTime? The end date.
EvalFrequency System.TimeSpan The eval frequency. Required.
LookbackPeriod System.TimeSpan The lookback period. Required.

^ Back to top

AlertEventMetric

Describes an alert event metric.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
AlertDefinitionId string The alert definition identifier. Required.
ReferenceType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionReferenceType The alert definition reference type. Required.
ReferenceId string The reference identifier. Required.
EventType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertDefinitionEventType The alert definition event type. Required.
EventValue int The event value. Required.

^ Back to top

AlertExecution

Describes an alert execution.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
AlertDefinitionId string The alert definition identifier. Required.
StartDate System.DateTime The start date. Required.
EndDate System.DateTime? The end date.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertExecutionStatus The status. Required.
StatusReason string The status reason. Required.
TriggeredActions bool Indicates whether the alert execution triggered actions. Required.
AlertReason System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The alert reason.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The metadata.

^ Back to top

AlertJobSchedule

Describes an alert job schedule.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
AlertDefinitionId string The alert definition identifier. Required.
ScheduledTime System.DateTime The next scheduled execution time. Required.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AlertJobScheduleStatus The status. Required.
RetryCount int The retry count. Required.> 0.
MaxRetryCount int The maximum retry count. Required.> 0.

^ Back to top

AssistantTestExecutionRes

Describes an assistant test execution res.

Properties
Property Type Description Rules
Id string Gets or sets the identifier. Required.
TestDefinitionId string Gets or sets the test definition identifier. Required.
TargetId string Gets or sets the target identifier. Required.
PhysicalKey string Gets or sets the physical key. Required.
BusinessKey string Gets or sets the business key. Required.
TargetName string Gets or sets the target name. Required.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AssistantTestExecutionStatus Gets or sets the status. Required.
StartDate System.DateTime Gets or sets the start date. Required.
EndDate System.DateTime? Gets or sets the end date.
EvaluationModelName string Gets or sets the evaluation model name. Required.
EvaluationIterations int Gets or sets the evaluation iterations. Required.
PassedRate double? Gets or sets the passed rate.
OverallScore double? Gets or sets the overall score.
ResponseTimeSeconds double? Gets or sets the response time seconds.
ExternalReportUrl string Gets or sets the external report URL. Required.
ExternalId string Gets or sets the external identifier. Required.

^ Back to top

Audit

Describes an audit.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
TrackingId string? The audit tracking identifier.
SourceId string The audit source identifier. Required.
SourceType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AuditSourceType The audit source type. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.AuditType The audit type. Required.
Name string The audit name. Required.
Key string The audit key. Required.
Value string The audit value. Required.
Timestamp System.DateTime The audit timestamp. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The audit metadata. Required.

^ Back to top

BaseEntity

Describes a base entity.

Properties
Property Type Description Rules
Id string? The identifier.

^ Back to top

BasePage

Describes a base page.

Properties
Property Type Description Rules
ContinuationToken string? The continuation token.

^ Back to top

Chatbot

Describes a chatbot.

Properties
Property Type Description Rules
PhysicalKey string The chatbot physical key. Required.
BusinessKey string The chatbot business key. Required.
ModelDefinitionId string The model definition identifier. Required.
Name string The chatbot name. Required.
Description string The chatbot description. Required.
Domain string The chatbot domain. Required.
Owner string The chatbot owner. Required.Email.
Settings System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The chatbot settings. Required.
Scopes System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The chatbot scopes. Required.
BasePrompt string The chatbot base prompt. Required.
UsagePlanId string The usage plan identifier. Required.

^ Back to top

ChatRequest

Describes a chat request.

Properties
Property Type Description Rules
SessionId string The chat request session identifier. Required.
UserMessage string The chat request user message. Required.

^ Back to top

ChatResponse

Describes a chat response.

Properties
Property Type Description Rules
Content string The chat response content. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The chat response metadata. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChunkType Gets or sets the type. Required.

^ Back to top

ConnectAnonymousResponse

Describes a connect anonymous response.

Properties
Property Type Description Rules
UserId string The user identifier. Required.

^ Back to top

DashboardMetricFilterRes

Describes a dashboard metric filter resource.

Properties
Property Type Description Rules
PhysicalKey string The usage plan item physical key. Required.
BusinessKey System.Collections.Generic.IList<string>? The usage plan item business key.
UsagePlanId string The usage plan identifier. Required.
MetricKey string The metric key. Required.
Period Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardMetricPeriod The dashboard metric period. Required.
StartDate System.DateTime The dashboard metric start date. Required.
EndDate System.DateTime The dashboard metric end date. Required.
ReferenceType System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageReferenceType>? The usage reference type.
ReferenceId System.Collections.Generic.IList<string>? The reference identifier.
Culture string The culture. Required.
TimeZone string The time zone. Required.

^ Back to top

DashboardMetricRes

Describes a dashboard metric resource.

Properties
Property Type Description Rules
MetricTotal double The dashboard metric period. Required.
MetricValues System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.DashboardMetricValuesRes>? Gets or sets the metric values.

^ Back to top

DashboardMetricValuesRes

Describes a dashboard metric values resource.

Properties
Property Type Description Rules
Value double The dashboard metric period. Required.
Period string The period. Required.

^ Back to top

DashboardReferenceFilterRes

Describes a dashboard reference filter resource.

Properties
Property Type Description Rules
ReferenceType System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageReferenceType>? The usage reference type.
UsagePlanId string The usage plan identifier. Required.

^ Back to top

DashboardReferenceRes

Describes a dashboard reference resource.

Properties
Property Type Description Rules
ReferenceType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageReferenceType The usage reference type. Required.
ReferenceId string The reference identifier. Required.
ReferenceName string The reference name. Required.

^ Back to top

Feedback

Describes a feedback.

Properties
Property Type Description Rules
PhysicalKey string? The physical key.
BusinessKey string? The business key.
SourceType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.FeedbackSourceType The feedback source type. Required.
SourceId string The feedback source identifier. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.FeedbackType The feedback type. Required.
Content string? The feedback content.

^ Back to top

HistoryRes

Describes a history resource.

Properties
Property Type Description Rules
Id string The identifier. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItemType The item type. Required.
Content System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryResContent> The history resource content. Required.
Timestamp System.DateTime The timestamp. Required.
HasNegativeFeedback bool Indicates if the session item has negative feedback. Required.
FeedbackId string Gets or sets the feedback identifier. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The metadata. Required.

^ Back to top

HistoryResContent

Describes a history resource content.

Properties
Property Type Description Rules
Title string? The title.
Message string The message. Required.

^ Back to top

HistoryResPage

Describes a history resource page.

Properties
Property Type Description Rules
Resources System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.HistoryRes> The history resources. Required.

^ Back to top

KeyValuePair

Describes a key-value pair.

Properties
Property Type Description Rules
Key string The pair key. Required.
Value string The pair value. Required.

^ Back to top

Metric

Describes a metric.

Properties
Property Type Description Rules
Key string The metric key. Required.
Name string The metric name. Required.
Description string The metric description. Required.
Unit string The metric unit. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.MetricType The metric type. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The metric metadata. Required.
Optional bool Indicates whether this metric is optional (not required) in each usage plan. Required.

^ Back to top

ModelDefinition

Describes a model definition.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
Name string The model definition name. Required.
Description string The model definition description. Required.
Provider Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ModelProvider The model definition provider. Required.
Settings System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The model definition settings. Required.

^ Back to top

Prompt

Describes a prompt.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptType? The prompt type.
Name string The prompt name. Required.
Description string The prompt description. Required.
Domain string The prompt domain. Required.
Format Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFormat The prompt format. Required.
Content string The prompt content. Required.
Settings System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The prompt settings. Required.
IsFunction bool Indicates whether the prompt can be invoked. Required.
ModelDefinitionId string? The model definition identifier.
UsagePlanId string? The usage plan identifier.

^ Back to top

PromptFunctionRequest

Describes a prompt function request.

Properties
Property Type Description Rules
PromptId string? The prompt function identifier.
Prompt Cegid.Lithium.ChatbotFactory.Client.Rest.Models.Prompt? The prompt function.
Parameters System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The prompt function request parameters.
Scopes System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The prompt function request scopes.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The prompt function request metadata.

^ Back to top

PromptFunctionResponse

Describes a prompt function response.

Properties
Property Type Description Rules
PromptSessionId string The prompt session identifier. Required.
PromptId string The prompt identifier. Required.
Content string The prompt response content. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The prompt response metadata.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChunkType Gets or sets the type. Required.

^ Back to top

PromptSession

Describes a prompt session.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
Request Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionRequest The prompt function request. Required.
Response Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptFunctionResponse? The prompt function response.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.PromptSessionStatus The status. Required.
StatusReason string? The status reason.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair>? The metadata.

^ Back to top

QueryExpression

Describes a query expression.

Properties
Property Type Description Rules
Name string The query expression name. Required.
Operator string The query expression operator. Required.
Value string The query expression value. Required.

^ Back to top

RoleAccessControlRes

Describes a role access control request resource.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
StartDate System.DateTime? The start date.
EndDate System.DateTime? The end date.
RoleKey Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleLevel The role key. Required.
UserEmail string The user email. Required.

^ Back to top

RoleAccessControlResponseRes

Describes a role access control response resource.

Properties
Property Type Description Rules
UserName string? The user name.
CreatedBy string? The created by.
CreatedOn System.DateTime? The entity creation date.
ModifiedBy string? The modified by.
ModifiedOn System.DateTime? The entity last modification date.

^ Back to top

RoleAccessControlResponseResPage

Describes a role access control response resource page.

Properties
Property Type Description Rules
Items System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.RoleAccessControlResponseRes> The items. Required.

^ Back to top

Session

Describes a session.

Properties
Property Type Description Rules
PhysicalKey string The session physical key. Required.
BusinessKey string The session business key. Required.
Title string? The session title. MaxLen(100).
ChatbotId string The chatbot identifier. Required.
UserId string The session user identifier. Required.
Scopes System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The session scopes. Required.
Culture string The session culture. Required.
HasNegativeFeedback bool? Indicates if the session has or has had negative feedback.

^ Back to top

SessionItem

Describes a session item.

Properties
Property Type Description Rules
PhysicalKey string? The physical key.
BusinessKey string? The business key.
SessionId string The session identifier. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.SessionItemType The session item type. Required.
Content System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The session item content. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The session item metadata. Required.
IsValid bool Indicates whether the session item is valid or not. Required.
IsValidReason string? Indicates the reason for the session item to be valid or not.

^ Back to top

SystemEntity

Describes a system entity.

Properties
Property Type Description Rules
CreatedOn System.DateTime? The entity creation date.
ModifiedOn System.DateTime? The entity last modification date.
CreatedBy string? The system component responsible for the creation of a entity.
IsActive bool Indicates whether the entity is active. Required.
IsDeleted bool Indicates whether the entity is deleted. Required.

^ Back to top

TestDefinition

Describes a test definition.

Properties
Property Type Description Rules
PhysicalKey string The test definition physical key. Required.
BusinessKey string The test definition business key. Required.
Name string The test definition name. Required.
Description string The test definition description. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinitionType The test definition type. Required.
Target Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestDefinitionTarget The test definition target. Required.
TargetIds System.Collections.Generic.IList<string> The test definition target ids. Required.Not empty.
Settings System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The test definition settings. Required.
Data System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The test definition data. Required.

^ Back to top

TestExecution

Describes a test execution.

Properties
Property Type Description Rules
PhysicalKey string The test execution physicalkey. Required.
BusinessKey string The test execution business key. Required.
TestDefinitionId string The test definition identifier. Required.
StartDate System.DateTime The test execution start date. Required.
EndDate System.DateTime The test execution end date. Required.
Input System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The test execution input. Required.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.TestExecutionStatus The test execution status. Required.
StatusReason string The test execution status reason. Required.
Output System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The test execution output. Required.
TaskId string Gets or sets the task identifier. Required.

^ Back to top

TestExecutionChatRequest

Describes a test execution chat request.

Properties
Property Type Description Rules
PhysicalKey string The test execution chat request physical key. Required.
BusinessKey string The test execution chat request business key. Required.
SessionId string The test execution chat request session identifier. Required.
UserMessage string The test execution chat request user message. Required.

^ Back to top

TestExecutionChatResponse

Describes a test execution chat response.

Properties
Property Type Description Rules
Content string The test execution chat response content. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The test execution chat response metadata. Required.
Type Cegid.Lithium.ChatbotFactory.Client.Rest.Models.ChunkType Gets or sets the type. Required.

^ Back to top

TestExecutionOutputRes

Describes a test execution output res.

Properties
Property Type Description Rules
Id string Gets or sets the identifier. Required.
Question string Gets or sets the question. Required.
PassedRate double Gets or sets the passed rate. Required.
Correctness double Gets or sets the correctness. Required.
Security double Gets or sets the security. Required.
Coherence double Gets or sets the coherence. Required.
Fluency double Gets or sets the fluency. Required.
OverallScore double Gets or sets the overall score. Required.
ResponseTimeSeconds double Gets or sets the response time seconds. Required.

^ Back to top

TestExecutionRequest

Describes a test execution request.

Properties
Property Type Description Rules
TestDefinitionId string Gets or sets the test definition identifier. Required.

^ Back to top

UsageMetric

Describes an usage metric.

Properties
Property Type Description Rules
PhysicalKey string The usage metric physical key. Required.
BusinessKey string The usage metric business key. Required.
MetricId string The metric identifier. Required.
UsagePlanItemId string The usage plan item id. Required.
Period Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePeriod The usage metric period. Required.
StartDate System.DateTime The usage metric start date. Required.
EndDate System.DateTime? The usage metric end date.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetricStatus The usage metric status. Required.
Value double The usage metric value. Required.> 0.
ReferenceType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageReferenceType The usage reference type. Required.
ReferenceId string The usage reference identifier. Required.

^ Back to top

UsagePlan

Describes an usage plan.

Properties
Property Type Description Rules
PhysicalKey string The usage plan physical key. Required.
BusinessKey string The usage plan business key. Required.
Name string The usage plan name. Required.
Description string The usage plan description. Required.

^ Back to top

UsagePlanItem

Describes an usage plan item.

Properties
Property Type Description Rules
PhysicalKey string The usage plan item physical key. Required.
BusinessKey string The usage plan item business key. Required.
UsagePlanId string The usage plan identifier. Required.
MetricId string The metric identifier. Required.
Period Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePeriod The usage plan item period. Required.
Limit double The usage plan item limit. Required.> 0.
StartDate System.DateTime The usage plan item start date. Required.
EndDate System.DateTime? The usage plan item end date.
Scopes System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The usage plan item scopes. Required.
Unlimited bool Indicates whether the usage plan item, related with the specified metric, has unlimited consumption of resources. Required.

^ Back to top

UsagePlanItemRes

Describes an usage plan item resource.

Properties
Property Type Description Rules
PhysicalKey string The usage plan item physical key. Required.
BusinessKey string The usage plan item business key. Required.
Id string The identifier. Required.
UsagePlanId string The usage plan identifier. Required.
MetricId string The metric identifier. Required.
MetricName string The metric name. Required.
Period Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePeriod The usage plan item period. Required.
Limit double The usage plan item limit. Required.
StartDate System.DateTime The usage plan item start date. Required.
EndDate System.DateTime? The usage plan item end date.
IsActive bool Indicates whether the usage plan item is active. Required.
Unlimited bool Indicates whether the usage plan item, related with the specified metric, has unlimited consumption of resources. Required.

^ Back to top

UsageQuota

Describes a usage quota.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
MetricId string The metric identifier. Required.
MetricKey string The metric key. Required.
Period Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsagePeriod The usage plan item period. Required.
UsagePlanItemId string The usage plan item identifier. Required.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageMetricStatus The usage metrics status. Required.
Value double The usage metrics value. Required.
Limit double The usage plan item limit. Required.
Unlimited bool Indicates whether the usage plan item, related with the specified metric, has unlimited consumption of resources. Required.
UsageMetricStartDate System.DateTime The usage metric start date. Required.
UsageMetricEndDate System.DateTime? The usage metric end date.
UsagePlanItemStartDate System.DateTime The usage plan item start date. Required.
UsagePlanItemEndDate System.DateTime? The usage plan item end date.

^ Back to top

UsageRecord

Describes an usage record.

Properties
Property Type Description Rules
PhysicalKey string The usage record physical key. Required.
BusinessKey string The usage record business key. Required.
MetricId string The metric identifier. Required.
ClientId string The client identifier. Required.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageRecordStatus The usage record status. Required.
Value double The usage record value. Required.> 0.
SourceType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageSourceType The usage source type. Required.
SourceId string The usage source identifier. Required.
ReferenceType Cegid.Lithium.ChatbotFactory.Client.Rest.Models.UsageReferenceType The usage reference type. Required.
ReferenceId string The usage reference identifier. Required.
Timestamp System.DateTime The usage record timestamp. Required.
UsagePlanId string? The usage plan identifier.

^ Back to top

UserInformation

Describes a user information.

Properties
Property Type Description Rules
Id string Gets or sets the identifier. Required.
Name string Gets or sets the name. Required.
DisplayName string Gets or sets the display name. Required.
Email string Gets or sets the email. Required.
IdentityCulture string Gets or sets the identity culture. Required.
Culture string Gets or sets the culture. Required.
Picture string Gets or sets the picture. Required.
UserProfileUrl string Gets or sets the user profile URL. Required.

^ Back to top

WorkflowRun

Describes a workflow run.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
WorkflowId string The workflow identifier. Required.
Status Cegid.Lithium.ChatbotFactory.Client.Rest.Models.WorkflowRunStatus The workflow run status. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The workflow run metadata. Required.

^ Back to top

WorkflowRunItem

Describes a workflow run item.

Properties
Property Type Description Rules
PhysicalKey string The physical key. Required.
BusinessKey string The business key. Required.
WorkflowRunId string The workflow run identifier. Required.
Content System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The workflow run content. Required.
Metadata System.Collections.Generic.IList<Cegid.Lithium.ChatbotFactory.Client.Rest.Models.KeyValuePair> The workflow run metadata. Required.

^ Back to top

Enumerations

AlertDefinitionActionType

Defines the alert action type.

Members
Member Value Description
Email 0 The email action type.

^ Back to top

AlertDefinitionEvaluationType

Defines the alert evaluation type.

Members
Member Value Description
Dynamic 0 The dynamic evaluation type.
Static 1 The static evaluation type.

^ Back to top

AlertDefinitionEventType

Defines the alert event type.

Members
Member Value Description
ChatFeedbackNegative 0 The chat feedback negative event type.
ChatMessageMaintenance 1 The chat message maintenance event type.

^ Back to top

AlertDefinitionReferenceType

Defines the alert reference type.

Members
Member Value Description
Assistant 0 The assistant reference type.

^ Back to top

AlertExecutionStatus

The alert execution status.

Members
Member Value Description
Failed 0 The failed execution status.
Running 1 The running execution status.
Completed 2 The completed execution status.

^ Back to top

AlertJobScheduleStatus

The alert job schedule status.

Members
Member Value Description
Scheduled 0 The scheduled status.
Pending 1 The pending status.
Completed 2 The completed status.
Failed 3 The failed status.

^ Back to top

AssistantTestExecutionStatus

Defines the assistant test execution statuses.

Members
Member Value Description
Pending 0 The pending status.
Completed 1 The completed status.
Failed 2 The failed status.

^ Back to top

AuditSourceType

Defines the audit source types.

Members
Member Value Description
SessionItem 0 The session item reference type.
PromptSession 1 The prompt session reference type.

^ Back to top

AuditType

Defines the audit types.

Members
Member Value Description
Explainability 0 The audit explainability type.
Feedback 1 The audit feedback type.

^ Back to top

ChunkType

Defines a chunk type.

Members
Member Value Description
Content 0 The content type.
SystemNotice 1 The system notice type.
Error 2 The error type.
Metadata 3 The metadata type.
StructuredContent 4 The structured content type.

^ Back to top

DashboardMetricPeriod

Defines the usage periods.

Members
Member Value Description
Daily 0 The daily period.
Monthly 1 The monthly period.
Yearly 2 The yearly period.

^ Back to top

FeedbackSourceType

Defines the feedback source type.

Members
Member Value Description
SessionItem 0 The session item feedback source type.

^ Back to top

FeedbackType

Defines the feedback type.

Members
Member Value Description
Negative 0 The negative feedback type.

^ Back to top

HistoryOrder

Defines the history order.

Members
Member Value Description
Ascending 0 The ascending history order.
Descending 1 The descending history order.

^ Back to top

HistoryType

Defines the history type.

Members
Member Value Description
Conversation 0 The conversation history type.
Lookup 1 The lookup history type.

^ Back to top

MetricType

Defines the metric types.

Members
Member Value Description
Usage 0 The usage type.

^ Back to top

ModelProvider

Defines the providers of a model.

Members
Member Value Description
AzureOpenAI 0 The Azure OpenAI provider.
AzurePromptFlow 1 The Azure PromptFlow provider.
OpenAI 2 The OpenAI provider.
Abacus 3 The Abacus provider.
AgentUserInteraction 4 The agent user interaction.

^ Back to top

PromptFormat

Defines the formats of a prompt.

Members
Member Value Description
Default 0 The default format.
Handlebars 1 The handlebars format.

^ Back to top

PromptSessionStatus

The prompt session status.

Members
Member Value Description
Success 0 The success status.
Failure 1 The failure status.

^ Back to top

PromptType

Defines the types of a prompt.

Members
Member Value Description
Library 0 The library type.
OnDemand 1 The on-demand type.

^ Back to top

RoleLevel

Defines a role level.

Members
Member Value Description
Admin 0 The admin.
Manager 1 The manager.
Integrator 2 The integrator.
Support 3 The support.

^ Back to top

SessionItemType

Defines the types of a session item.

Members
Member Value Description
BasePrompt 0 The base prompt type.
UserMessage 1 The user message type.
AssistantMessage 2 The assistant message type.
ContextData 3 The context data type.
ChatOptions 4 The chat options type.
WorkflowRun 5 The workflow run type.

^ Back to top

TestDefinitionTarget

Defines targets of evaluation.

Members
Member Value Description
Assistant 0 The chatbot target.

^ Back to top

TestDefinitionType

Defines the types of test definition.

Members
Member Value Description
OfflineEvaluation 0 The AI offline evaluation type.
PulseRag 1 The Pulse RAG evaluation type.
PatronusAdversarial 2 The Patronus adversarial evaluation type.

^ Back to top

TestExecutionStatus

Defines the status of test definition execution.

Members
Member Value Description
Pending 0 The Pending Status.
Completed 1 The Finished status.
Failed 2 The failed status.

^ Back to top

UsageMetricStatus

Defines the usage metric status.

Members
Member Value Description
Available 0 Usage limit is available.
Exceeded 1 Usage limit has been exceeded.

^ Back to top

UsagePeriod

Defines the usage periods.

Members
Member Value Description
None 0 The nonexistent period.
Daily 1 The daily period.
Weekly 2 The weekly period.
Monthly 3 The monthly period.
Quarterly 4 The quarterly period.
Yearly 5 The yearly period.

^ Back to top

UsageRecordStatus

Defines the usage record status.

Members
Member Value Description
Pending 0 The usage record processing is pending.
Completed 1 The usage record processing is completed.

^ Back to top

UsageReferenceType

Defines the usage reference type.

Members
Member Value Description
Assistant 0 The assistant reference type.
Prompt 1 The prompt reference type.
Agent 2 The agent reference type.
Other 3 The other reference type.

^ Back to top

UsageSourceType

Defines the usage source type.

Members
Member Value Description
SessionItem 0 The session item source type.
Session 1 The session item source type.
Other 2 The other source type.
PromptSession 3 The prompt session source type.

^ Back to top

WorkflowRunStatus

Defines a workflow run status.

Members
Member Value Description
Queued 0 The queued status.
Running 1 The running status.
HumanInTheLoop 2 The human in the loop status.
Completed 3 The completed status.
Canceled 4 The canceled status.
Failed 5 The failed status.

^ Back to top