export type LooselyBrandedString = string & { __LOOSE_BRAND?: T; }; /** * An action tool configured on the Agent references an action type that could not be found. This can surface at runtime if the action type was deleted or is not accessible to the calling token. Verify the action type exists and is accessible, then review the Agent's tools in AIP Chatbot Studio. * * Log Safety: SAFE */ export interface ActionTypeNotFound { errorCode: "INVALID_ARGUMENT"; errorName: "ActionTypeNotFound"; errorDescription: "An action tool configured on the Agent references an action type that could not be found. This can surface at runtime if the action type was deleted or is not accessible to the calling token. Verify the action type exists and is accessible, then review the Agent's tools in AIP Chatbot Studio."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; actionRid: unknown; }; } /** * The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. Try a different query or review the Agent configuration in AIP Chatbot Studio. * * Log Safety: UNSAFE */ export interface AgentIterationsExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "AgentIterationsExceededLimit"; errorDescription: "The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. Try a different query or review the Agent configuration in AIP Chatbot Studio."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * The given Agent could not be found. * * Log Safety: SAFE */ export interface AgentNotFound { errorCode: "NOT_FOUND"; errorName: "AgentNotFound"; errorDescription: "The given Agent could not be found."; errorInstanceId: string; parameters: { agentRid: unknown; }; } /** * The given AgentVersion could not be found. * * Log Safety: SAFE */ export interface AgentVersionNotFound { errorCode: "NOT_FOUND"; errorName: "AgentVersionNotFound"; errorDescription: "The given AgentVersion could not be found."; errorInstanceId: string; parameters: { agentRid: unknown; agentVersionString: unknown; }; } /** * Could not blockingContinue the Session. * * Log Safety: SAFE */ export interface BlockingContinueSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "BlockingContinueSessionPermissionDenied"; errorDescription: "Could not blockingContinue the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * Unable to cancel the requested session exchange as no in-progress exchange was found for the provided message identifier. This is expected if no exchange was initiated with the provided message identifier through a streamingContinue request, or if the exchange for this identifier has already completed and cannot be canceled, or if the exchange has already been canceled. This error can also occur if the cancellation was requested immediately after requesting the exchange through a streamingContinue request, and the exchange has not started yet. Clients should handle these errors gracefully, and can reload the session content to get the latest conversation state. * * Log Safety: SAFE */ export interface CancelSessionFailedMessageNotInProgress { errorCode: "INVALID_ARGUMENT"; errorName: "CancelSessionFailedMessageNotInProgress"; errorDescription: "Unable to cancel the requested session exchange as no in-progress exchange was found for the provided message identifier. This is expected if no exchange was initiated with the provided message identifier through a streamingContinue request, or if the exchange for this identifier has already completed and cannot be canceled, or if the exchange has already been canceled. This error can also occur if the cancellation was requested immediately after requesting the exchange through a streamingContinue request, and the exchange has not started yet. Clients should handle these errors gracefully, and can reload the session content to get the latest conversation state."; errorInstanceId: string; parameters: { messageId: unknown; agentRid: unknown; sessionRid: unknown; }; } /** * Could not cancel the Session. * * Log Safety: SAFE */ export interface CancelSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CancelSessionPermissionDenied"; errorDescription: "Could not cancel the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * The given Content could not be found. * * Log Safety: SAFE */ export interface ContentNotFound { errorCode: "NOT_FOUND"; errorName: "ContentNotFound"; errorDescription: "The given Content could not be found."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * Failed to generate a response for a session because the context size of the LLM has been exceeded. Clients should either retry with a shorter message or create a new session and try re-sending the message. * * Log Safety: UNSAFE */ export interface ContextSizeExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "ContextSizeExceededLimit"; errorDescription: "Failed to generate a response for a session because the context size of the LLM has been exceeded. Clients should either retry with a shorter message or create a new session and try re-sending the message."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * Could not create the Session. * * Log Safety: SAFE */ export interface CreateSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateSessionPermissionDenied"; errorDescription: "Could not create the Session."; errorInstanceId: string; parameters: { agentRid: unknown; }; } /** * Could not delete the Session. * * Log Safety: SAFE */ export interface DeleteSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteSessionPermissionDenied"; errorDescription: "Could not delete the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. * * Log Safety: UNSAFE */ export interface FunctionLocatorNotFound { errorCode: "NOT_FOUND"; errorName: "FunctionLocatorNotFound"; errorDescription: "The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; functionRid: unknown; functionVersion: unknown; }; } /** * The calling user does not have permission to list all sessions across all Agents. Listing all sessions across all agents requires the api:aip-agents-write scope. * * Log Safety: SAFE */ export interface GetAllSessionsAgentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetAllSessionsAgentsPermissionDenied"; errorDescription: "The calling user does not have permission to list all sessions across all Agents. Listing all sessions across all agents requires the api:aip-agents-write scope."; errorInstanceId: string; parameters: {}; } /** * Could not ragContext the Session. * * Log Safety: SAFE */ export interface GetRagContextForSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetRagContextForSessionPermissionDenied"; errorDescription: "Could not ragContext the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * The provided version string is not a valid format for an Agent version. * * Log Safety: SAFE */ export interface InvalidAgentVersion { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAgentVersion"; errorDescription: "The provided version string is not a valid format for an Agent version."; errorInstanceId: string; parameters: { agentRid: unknown; version: unknown; }; } /** * The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the parameters property, and version through the API with getAgent, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with getSession. * * Log Safety: UNSAFE */ export interface InvalidParameter { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameter"; errorDescription: "The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the parameters property, and version through the API with getAgent, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with getSession."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; parameter: unknown; }; } /** * The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the parameters property, and version through the API with getAgent, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with getSession. * * Log Safety: UNSAFE */ export interface InvalidParameterType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameterType"; errorDescription: "The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the parameters property, and version through the API with getAgent, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with getSession."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; parameter: unknown; expectedType: unknown; receivedType: unknown; }; } /** * Could not allSessions the Agent. * * Log Safety: SAFE */ export interface ListSessionsForAgentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListSessionsForAgentsPermissionDenied"; errorDescription: "Could not allSessions the Agent."; errorInstanceId: string; parameters: {}; } /** * Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. * * Log Safety: SAFE */ export interface NoPublishedAgentVersion { errorCode: "INVALID_ARGUMENT"; errorName: "NoPublishedAgentVersion"; errorDescription: "Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use."; errorInstanceId: string; parameters: { agentRid: unknown; }; } /** * Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in Ontology Manager. * * Log Safety: UNSAFE */ export interface ObjectTypeIdsNotFound { errorCode: "NOT_FOUND"; errorName: "ObjectTypeIdsNotFound"; errorDescription: "Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in Ontology Manager."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; objectTypeIds: unknown; }; } /** * Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in Ontology Manager. * * Log Safety: SAFE */ export interface ObjectTypeRidsNotFound { errorCode: "NOT_FOUND"; errorName: "ObjectTypeRidsNotFound"; errorDescription: "Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in Ontology Manager."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; objectTypeRids: unknown; }; } /** * Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in Ontology Manager. * * Log Safety: SAFE */ export interface OntologyEntitiesNotFound { errorCode: "NOT_FOUND"; errorName: "OntologyEntitiesNotFound"; errorDescription: "Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in Ontology Manager."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; objectTypeRids: unknown; linkTypeRids: unknown; }; } /** * Failed to generate a response as the model rate limits were exceeded. Clients should wait and retry. * * Log Safety: UNSAFE */ export interface RateLimitExceeded { errorCode: "CUSTOM_CLIENT"; errorName: "RateLimitExceeded"; errorDescription: "Failed to generate a response as the model rate limits were exceeded. Clients should wait and retry."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * Failed to generate a response after retrying up to the configured number of retry attempts. Clients should wait and retry. * * Log Safety: UNSAFE */ export interface RetryAttemptsExceeded { errorCode: "CUSTOM_CLIENT"; errorName: "RetryAttemptsExceeded"; errorDescription: "Failed to generate a response after retrying up to the configured number of retry attempts. Clients should wait and retry."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * Failed to generate a response after retrying up to the configured retry deadline. Clients should wait and retry. * * Log Safety: UNSAFE */ export interface RetryDeadlineExceeded { errorCode: "CUSTOM_CLIENT"; errorName: "RetryDeadlineExceeded"; errorDescription: "Failed to generate a response after retrying up to the configured retry deadline. Clients should wait and retry."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * Failed to generate a response for a session due to an unexpected error. * * Log Safety: UNSAFE */ export interface SessionExecutionFailed { errorCode: "INTERNAL"; errorName: "SessionExecutionFailed"; errorDescription: "Failed to generate a response for a session due to an unexpected error."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; message: unknown; details: unknown; }; } /** * The given Session could not be found. * * Log Safety: SAFE */ export interface SessionNotFound { errorCode: "NOT_FOUND"; errorName: "SessionNotFound"; errorDescription: "The given Session could not be found."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * The provided trace ID already exists for the session and cannot be reused. * * Log Safety: SAFE */ export interface SessionTraceIdAlreadyExists { errorCode: "INVALID_ARGUMENT"; errorName: "SessionTraceIdAlreadyExists"; errorDescription: "The provided trace ID already exists for the session and cannot be reused."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; sessionTraceId: unknown; }; } /** * The given SessionTrace could not be found. * * Log Safety: SAFE */ export interface SessionTraceNotFound { errorCode: "NOT_FOUND"; errorName: "SessionTraceNotFound"; errorDescription: "The given SessionTrace could not be found."; errorInstanceId: string; parameters: { sessionTraceId: unknown; agentRid: unknown; sessionRid: unknown; }; } /** * Could not streamingContinue the Session. * * Log Safety: SAFE */ export interface StreamingContinueSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "StreamingContinueSessionPermissionDenied"; errorDescription: "Could not streamingContinue the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * The Agent is configured with a language model that is not supported or could not be resolved. This can surface at runtime if the model was deprecated or is not accessible to the calling token. Update the Agent's language model in AIP Chatbot Studio. * * Log Safety: SAFE */ export interface UnsupportedLanguageModelRid { errorCode: "INVALID_ARGUMENT"; errorName: "UnsupportedLanguageModelRid"; errorDescription: "The Agent is configured with a language model that is not supported or could not be resolved. This can surface at runtime if the model was deprecated or is not accessible to the calling token. Update the Agent's language model in AIP Chatbot Studio."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; languageModelRid: unknown; modelPurpose: unknown; }; } /** * Could not updateTitle the Session. * * Log Safety: SAFE */ export interface UpdateSessionTitlePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UpdateSessionTitlePermissionDenied"; errorDescription: "Could not updateTitle the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } //# sourceMappingURL=_errors.d.ts.map