import type { GuidedPromptsResponse } from '../models/GuidedPromptsResponse'; import type { LanguagesView } from '../models/LanguagesView'; import type { MemoryStatusRequestView } from '../models/MemoryStatusRequestView'; import type { MemoryStatusView } from '../models/MemoryStatusView'; import type { Metadata } from '../models/Metadata'; import type { PatchedPrompt } from '../models/PatchedPrompt'; import type { Prompt } from '../models/Prompt'; import type { PromptCategory } from '../models/PromptCategory'; import type { StylesView } from '../models/StylesView'; import type { TagsView } from '../models/TagsView'; import type { TonesView } from '../models/TonesView'; import type { UserAllChatMemoryView } from '../models/UserAllChatMemoryView'; import type { UserCatalogItemMemoryView } from '../models/UserCatalogItemMemoryView'; import type { UserChatMemoryStatusRequestView } from '../models/UserChatMemoryStatusRequestView'; import type { UserChatMemoryStatusView } from '../models/UserChatMemoryStatusView'; import type { UserChatMemoryUpdateView } from '../models/UserChatMemoryUpdateView'; import type { UserMemoryContextRequest } from '../models/UserMemoryContextRequest'; import type { UserMemoryContextResponse } from '../models/UserMemoryContextResponse'; import type { CancelablePromise } from '../core/CancelablePromise'; export declare class AiPromptService { /** * Create or update metadata for a prompt. * * Args: * request: The HTTP request containing the metadata. * org: The organization/tenant identifier. * * Returns: * Response: The created or updated prompt metadata. * * Raises: * BadRequest: If the provided data is invalid. * @returns Metadata * @throws ApiError */ static aiPromptOrgsMetadataCreate({ org, requestBody, }: { org: string; requestBody: Metadata; }): CancelablePromise; /** * Retrieve chat memory for a specific user. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user to retrieve chat memory for. * * Returns: * Response: The user's chat memory entries. * * Raises: * NotFound: If no chat memory exists for the user. * @returns UserAllChatMemoryView * @throws ApiError */ static aiPromptOrgsUsersAllChatsMemoryRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Create a new chat memory entry for a user. * * Args: * request: The HTTP request containing the chat memory data. * org: The organization/tenant identifier. * user_id: The ID of the user to create chat memory for. * * Returns: * Response: The created chat memory entry. * * Raises: * BadRequest: If the provided data is invalid. * @returns UserAllChatMemoryView * @throws ApiError */ static aiPromptOrgsUsersAllChatsMemoryCreate({ org, userId, requestBody, }: { org: string; requestBody: UserAllChatMemoryView; }): CancelablePromise; /** * Update chat memory for a specific user. * * Args: * request: The HTTP request containing the updated chat memory data. * org: The organization/tenant identifier. * user_id: The ID of the user to update chat memory for. * * Returns: * Response: A confirmation of the scheduled update task. * * Raises: * BadRequest: If the provided data is invalid. * NotFound: If no chat memory exists for the user. * @returns UserChatMemoryUpdateView * @throws ApiError */ static aiPromptOrgsUsersAllChatsMemoryUpdate({ org, userId, requestBody, }: { org: string; requestBody: UserAllChatMemoryView; }): CancelablePromise; /** * Delete all chat memory for a specific user. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user to delete chat memory for. * * Returns: * Response: A success message if the memory was deleted. * * Raises: * NotFound: If no chat memory exists for the user. * @returns void * @throws ApiError */ static aiPromptOrgsUsersAllChatsMemoryDestroy({ org, userId, }: { org: string; }): CancelablePromise; /** * Update a specific chat memory entry. * * Args: * request: The HTTP request containing the updated chat memory data. * org: The organization/tenant identifier. * user_id: The ID of the user who owns the memory. * memory_id: The ID of the specific memory entry to update. * * Returns: * Response: The updated chat memory entry. * * Raises: * BadRequest: If the provided data is invalid. * NotFound: If the specified memory entry does not exist. * @returns UserAllChatMemoryView * @throws ApiError */ static aiPromptOrgsUsersAllChatsMemoryUpdate2({ memoryId, org, userId, requestBody, }: { memoryId: number; org: string; requestBody: UserAllChatMemoryView; }): CancelablePromise; /** * Delete a specific chat memory entry. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user who owns the memory. * memory_id: The ID of the specific memory entry to delete. * * Returns: * Response: A success message if the memory was deleted. * * Raises: * NotFound: If the specified memory entry does not exist. * @returns void * @throws ApiError */ static aiPromptOrgsUsersAllChatsMemoryDestroy2({ memoryId, org, userId, }: { memoryId: number; org: string; }): CancelablePromise; /** * Retrieve the chat memory status for a specific user. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user to retrieve memory status for. * * Returns: * Response: The user's chat memory status. * * Raises: * NotFound: If no memory status exists for the user. * @returns UserChatMemoryStatusView * @throws ApiError */ static aiPromptOrgsUsersChatMemoryStatusRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Update the chat memory status for a specific user. * * Args: * request: The HTTP request containing the updated status. * org: The organization/tenant identifier. * user_id: The ID of the user to update memory status for. * * Returns: * Response: The updated chat memory status. * * Raises: * BadRequest: If the provided data is invalid. * @returns UserChatMemoryStatusView * @throws ApiError */ static aiPromptOrgsUsersChatMemoryStatusUpdate({ org, userId, requestBody, }: { org: string; requestBody: UserChatMemoryStatusRequestView; }): CancelablePromise; /** * Retrieve all available prompt languages. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user making the request. * * Returns: * Response: A list of available prompt languages. * @returns LanguagesView * @throws ApiError */ static aiPromptOrgsUsersLanguagesRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Create a new prompt language. * * Args: * request: The HTTP request containing the language data. * org: The organization/tenant identifier. * user_id: The ID of the user creating the language. * * Returns: * Response: The created prompt language. * * Raises: * BadRequest: If the provided data is invalid. * @returns LanguagesView * @throws ApiError */ static aiPromptOrgsUsersLanguagesCreate({ org, userId, requestBody, }: { org: string; requestBody: LanguagesView; }): CancelablePromise; /** * Update a specific prompt language. * * Args: * request: The HTTP request containing the updated language data. * org: The organization/tenant identifier. * user_id: The ID of the user making the request. * language_id: The ID of the language to update. * * Returns: * Response: The updated prompt language. * * Raises: * BadRequest: If the provided data is invalid. * NotFound: If the specified language does not exist. * @returns LanguagesView * @throws ApiError */ static aiPromptOrgsUsersLanguagesUpdate({ languageId, org, userId, requestBody, }: { languageId: number; org: string; requestBody: LanguagesView; }): CancelablePromise; /** * Delete a specific prompt language. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user making the request. * language_id: The ID of the language to delete. * * Returns: * Response: A success message if the language was deleted. * * Raises: * NotFound: If the specified language does not exist. * @returns void * @throws ApiError */ static aiPromptOrgsUsersLanguagesDestroy({ languageId, org, userId, }: { languageId: number; org: string; }): CancelablePromise; /** * Retrieve catalog item memory for a specific user. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user to retrieve catalog item memory for. * * Returns: * Response: The user's catalog item memory entries. * * Raises: * NotFound: If no catalog item memory exists for the user. * @returns UserCatalogItemMemoryView * @throws ApiError */ static aiPromptOrgsUsersMemoryRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Create a new catalog item memory entry for a user. * * Args: * request: The HTTP request containing the catalog item memory data. * org: The organization/tenant identifier. * user_id: The ID of the user to create catalog item memory for. * * Returns: * Response: The created catalog item memory entry. * * Raises: * BadRequest: If the provided data is invalid. * @returns UserCatalogItemMemoryView * @throws ApiError */ static aiPromptOrgsUsersMemoryCreate({ org, userId, requestBody, }: { org: string; requestBody: UserCatalogItemMemoryView; }): CancelablePromise; /** * Delete all catalog item memory for a specific user. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user to delete catalog item memory for. * * Returns: * Response: A success message if the memory was deleted. * * Raises: * NotFound: If no catalog item memory exists for the user. * @returns void * @throws ApiError */ static aiPromptOrgsUsersMemoryDestroy({ org, userId, }: { org: string; }): CancelablePromise; /** * Retrieve a user's memory context settings. * @returns UserMemoryContextResponse * @throws ApiError */ static aiPromptOrgsUsersMemoryContextRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Updates the user's memory context settings. * * Returns: * * 200: list of user memory context data. * @returns UserMemoryContextResponse * @throws ApiError */ static aiPromptOrgsUsersMemoryContextUpdate({ org, userId, requestBody, }: { org: string; requestBody?: UserMemoryContextRequest; }): CancelablePromise; /** * Retrieve the memory status for a specific user. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user to retrieve memory status for. * * Returns: * Response: The user's memory status. * * Raises: * NotFound: If no memory status exists for the user. * @returns MemoryStatusView * @throws ApiError */ static aiPromptOrgsUsersMemoryStatusRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Update the memory status for a specific user. * * Args: * request: The HTTP request containing the updated status. * org: The organization/tenant identifier. * user_id: The ID of the user to update memory status for. * * Returns: * Response: The updated memory status. * * Raises: * BadRequest: If the provided data is invalid. * @returns MemoryStatusView * @throws ApiError */ static aiPromptOrgsUsersMemoryStatusUpdate({ org, userId, requestBody, }: { org: string; requestBody: MemoryStatusRequestView; }): CancelablePromise; /** * Update a specific catalog item memory entry. * * Args: * request: The HTTP request containing the updated catalog item memory data. * org: The organization/tenant identifier. * user_id: The ID of the user who owns the memory. * memory_id: The ID of the specific memory entry to update. * * Returns: * Response: The updated catalog item memory entry. * * Raises: * BadRequest: If the provided data is invalid. * NotFound: If the specified memory entry does not exist. * @returns UserCatalogItemMemoryView * @throws ApiError */ static aiPromptOrgsUsersMemoryUpdate({ memoryId, org, userId, requestBody, }: { memoryId: number; org: string; requestBody: UserCatalogItemMemoryView; }): CancelablePromise; /** * Delete a specific catalog item memory entry. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user who owns the memory. * memory_id: The ID of the specific memory entry to delete. * * Returns: * Response: A success message if the memory was deleted. * * Raises: * NotFound: If the specified memory entry does not exist. * @returns void * @throws ApiError */ static aiPromptOrgsUsersMemoryDestroy2({ memoryId, org, userId, }: { memoryId: number; org: string; }): CancelablePromise; /** * Retrieve metadata for a prompt. * * Args: * request: The HTTP request. * org: The organization/tenant identifier. * user_id: The ID of the user making the request. * * Returns: * Response: The prompt metadata. * * Raises: * NotFound: If no metadata exists for the specific prompt * @returns Metadata * @throws ApiError */ static aiPromptOrgsUsersMetadataRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * API viewset for managing prompts. * * This view allows tenant admins and students to create, retrieve, update, * and filter prompts based on various parameters. * * Permissions: * - Accessible to both tenant administrators and students * @returns Prompt * @throws ApiError */ static aiPromptOrgsUsersPromptList({ org, userId, category, createdBy, filterBy, mentorUniqueId, tag, visibility, }: { org: string; /** * Category of the prompt */ category?: number; /** * Option to filter by username of the prompt creators. */ createdBy?: string; /** * Filter options include, date, prompt, default is date */ filterBy?: string; /** * Mentor unique id of the prompt */ mentorUniqueId?: string; /** * Tag of the prompt */ tag?: number; /** * Visibility trype the mentor of the prompt */ visibility?: string; }): CancelablePromise>; /** * Create a new prompt. * * Args: * request: HTTP request containing prompt data. * * Returns: * Response with created prompt details. * * Raises: * ValidationError: If the input data is invalid. * @returns Prompt * @throws ApiError */ static aiPromptOrgsUsersPromptCreate({ org, userId, requestBody, category, createdBy, filterBy, mentorUniqueId, tag, visibility, }: { org: string; requestBody: Prompt; /** * Category of the prompt */ category?: number; /** * Option to filter by username of the prompt creators. */ createdBy?: string; /** * Filter options include, date, prompt, default is date */ filterBy?: string; /** * Mentor unique id of the prompt */ mentorUniqueId?: string; /** * Tag of the prompt */ tag?: number; /** * Visibility trype the mentor of the prompt */ visibility?: string; }): CancelablePromise; /** * API viewset for managing prompts. * * This view allows tenant admins and students to create, retrieve, update, * and filter prompts based on various parameters. * * Permissions: * - Accessible to both tenant administrators and students * @returns Prompt * @throws ApiError */ static aiPromptOrgsUsersPromptRetrieve({ id, org, userId, category, createdBy, filterBy, mentorUniqueId, tag, visibility, }: { /** * A unique integer value identifying this prompt. */ id: number; org: string; /** * Category of the prompt */ category?: number; /** * Option to filter by username of the prompt creators. */ createdBy?: string; /** * Filter options include, date, prompt, default is date */ filterBy?: string; /** * Mentor unique id of the prompt */ mentorUniqueId?: string; /** * Tag of the prompt */ tag?: number; /** * Visibility trype the mentor of the prompt */ visibility?: string; }): CancelablePromise; /** * Update an existing prompt. * * Args: * request: HTTP request containing updated prompt data. * * Returns: * Response with updated prompt details. * * Raises: * ValidationError: If the input data is invalid. * PermissionDenied: If the prompt is system-generated and cannot be edited. * @returns Prompt * @throws ApiError */ static aiPromptOrgsUsersPromptUpdate({ id, org, userId, requestBody, category, createdBy, filterBy, mentorUniqueId, tag, visibility, }: { /** * A unique integer value identifying this prompt. */ id: number; org: string; requestBody: Prompt; /** * Category of the prompt */ category?: number; /** * Option to filter by username of the prompt creators. */ createdBy?: string; /** * Filter options include, date, prompt, default is date */ filterBy?: string; /** * Mentor unique id of the prompt */ mentorUniqueId?: string; /** * Tag of the prompt */ tag?: number; /** * Visibility trype the mentor of the prompt */ visibility?: string; }): CancelablePromise; /** * API viewset for managing prompts. * * This view allows tenant admins and students to create, retrieve, update, * and filter prompts based on various parameters. * * Permissions: * - Accessible to both tenant administrators and students * @returns Prompt * @throws ApiError */ static aiPromptOrgsUsersPromptPartialUpdate({ id, org, userId, category, createdBy, filterBy, mentorUniqueId, tag, visibility, requestBody, }: { /** * A unique integer value identifying this prompt. */ id: number; org: string; /** * Category of the prompt */ category?: number; /** * Option to filter by username of the prompt creators. */ createdBy?: string; /** * Filter options include, date, prompt, default is date */ filterBy?: string; /** * Mentor unique id of the prompt */ mentorUniqueId?: string; /** * Tag of the prompt */ tag?: number; /** * Visibility trype the mentor of the prompt */ visibility?: string; requestBody?: PatchedPrompt; }): CancelablePromise; /** * API viewset for managing prompts. * * This view allows tenant admins and students to create, retrieve, update, * and filter prompts based on various parameters. * * Permissions: * - Accessible to both tenant administrators and students * @returns void * @throws ApiError */ static aiPromptOrgsUsersPromptDestroy({ id, org, userId, category, createdBy, filterBy, mentorUniqueId, tag, visibility, }: { /** * A unique integer value identifying this prompt. */ id: number; org: string; /** * Category of the prompt */ category?: number; /** * Option to filter by username of the prompt creators. */ createdBy?: string; /** * Filter options include, date, prompt, default is date */ filterBy?: string; /** * Mentor unique id of the prompt */ mentorUniqueId?: string; /** * Tag of the prompt */ tag?: number; /** * Visibility trype the mentor of the prompt */ visibility?: string; }): CancelablePromise; /** * Retrieve a list of prompt categories. * * Query Parameters: * - filter_by (optional): Sorts categories by name if set to "name". * * Args: * request: The HTTP request. * org: Organization key identifier. * * Returns: * - 200: List of prompt categories. * - 400: If query parameters are invalid. * @returns PromptCategory * @throws ApiError */ static aiPromptOrgsUsersPromptsCategoryRetrieve({ org, userId, filterBy, }: { org: string; /** * Filter options include, date, name, default is date */ filterBy?: string; }): CancelablePromise; /** * Create a new prompt category. * * Args: * request: The HTTP request containing category information. * org: Organization key identifier. * user_id: User performing the request. * * Returns: * - 201: Created prompt category. * - 401: If the user is not a tenant admin. * - 400: If request data is invalid. * @returns PromptCategory Created prompt category * @throws ApiError */ static aiPromptOrgsUsersPromptsCategoryCreate({ org, userId, requestBody, }: { org: string; requestBody: PromptCategory; }): CancelablePromise; /** * Delete a prompt category. * * Args: * request: The HTTP request containing the category to delete. * org: Organization key identifier. * user_id: User performing the request. * * Returns: * - 204: No Content (successful deletion). * - 401: If the user is not a tenant admin. * - 400: If request data is invalid. * - 404: If the category does not exist. * @returns void * @throws ApiError */ static aiPromptOrgsUsersPromptsCategoryDestroy({ org, userId, }: { org: string; }): CancelablePromise; /** * API viewset for managing prompts. * * This view allows anyone to retrieve, * and filter prompts based on various parameters. * * Permissions: * - Accessible to anyone * @returns Prompt * @throws ApiError */ static aiPromptOrgsUsersPromptsPublicList({ org, userId, category, createdBy, filterBy, mentorUniqueId, tag, visibility, }: { org: string; /** * Category of the prompt */ category?: number; /** * Option to filter by username of the prompt creators. */ createdBy?: string; /** * Filter options include, date, prompt, default is date */ filterBy?: string; /** * Mentor unique id of the prompt */ mentorUniqueId?: string; /** * Tag of the prompt */ tag?: number; /** * Visibility trype the mentor of the prompt */ visibility?: string; }): CancelablePromise>; /** * API viewset for managing prompts. * * This view allows anyone to retrieve, * and filter prompts based on various parameters. * * Permissions: * - Accessible to anyone * @returns Prompt * @throws ApiError */ static aiPromptOrgsUsersPromptsPublicRetrieve({ id, org, userId, category, createdBy, filterBy, mentorUniqueId, tag, visibility, }: { /** * A unique integer value identifying this prompt. */ id: number; org: string; /** * Category of the prompt */ category?: number; /** * Option to filter by username of the prompt creators. */ createdBy?: string; /** * Filter options include, date, prompt, default is date */ filterBy?: string; /** * Mentor unique id of the prompt */ mentorUniqueId?: string; /** * Tag of the prompt */ tag?: number; /** * Visibility trype the mentor of the prompt */ visibility?: string; }): CancelablePromise; /** * Retrieve guided prompts for a chat session * Fetches AI-generated guided prompts for a given session and organization. * @returns GuidedPromptsResponse * @throws ApiError */ static aiPromptOrgsUsersSessionsGuidedPromptsRetrieve({ org, sessionId, userId, count, }: { org: string; sessionId: string; count?: number; }): CancelablePromise; /** * Endpoint for getting prompt styles. * * Accessible to tenant admins and students. * * Returns: * * 200: List of styles. * @returns StylesView * @throws ApiError */ static aiPromptOrgsUsersStylesRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Endpoint for Adding prompt style. * * Accessible to tenant admins only. * * Returns: * * 201: style Object. * * 400: When data is not valid. * @returns StylesView * @throws ApiError */ static aiPromptOrgsUsersStylesCreate({ org, userId, requestBody, }: { org: string; requestBody: StylesView; }): CancelablePromise; /** * Endpoint for Adding prompt style. * * Accessible to tenant admins only. * * Returns: * * 200: style Object. * * 400: When data is not valid. * @returns StylesView * @throws ApiError */ static aiPromptOrgsUsersStylesUpdate({ org, styleId, userId, requestBody, }: { org: string; styleId: number; requestBody: StylesView; }): CancelablePromise; /** * Endpoint for deleting prompt style. * * Accessible to tenant admins and students. * * Returns: * * 204: No response data. * * 400: When data is not valid. * @returns void * @throws ApiError */ static aiPromptOrgsUsersStylesDestroy({ org, styleId, userId, }: { org: string; styleId: number; }): CancelablePromise; /** * Endpoint for getting prompt tags. * * Accessible to tenant admins and students. * * Returns: * * 200: List of tags. * @returns TagsView * @throws ApiError */ static aiPromptOrgsUsersTagsRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Endpoint for Adding prompt tag. * * Accessible to tenant admins and students. * * Returns: * * 201: tag Object. * * 400: When data is not valid. * * * * Example: * * POST: /api/ai-prompt/orgs/main/users/johndoe/tags/ * * Request: Response: { * "name": "Programming", * "description": "tags for programing prompts" * } * * Response: { * "id": 1, * "name": "Programming", * "description": "tags for programing prompts" * } * @returns TagsView * @throws ApiError */ static aiPromptOrgsUsersTagsCreate({ org, userId, requestBody, }: { org: string; requestBody: TagsView; }): CancelablePromise; /** * Endpoint for updating prompt tag. * * Accessible to tenant admins and students. * * Returns: * * 200: tag Object. * * 400: When data is not valid. * @returns TagsView * @throws ApiError */ static aiPromptOrgsUsersTagsUpdate({ org, tagId, userId, requestBody, }: { org: string; tagId: number; requestBody: TagsView; }): CancelablePromise; /** * Endpoint for deleting prompt tag. * * Accessible to tenant admins and students. * * Returns: * * 204: No response data. * * 400: When data is not valid. * @returns void * @throws ApiError */ static aiPromptOrgsUsersTagsDestroy({ org, tagId, userId, }: { org: string; tagId: number; }): CancelablePromise; /** * Endpoint for getting prompt tones. * * Accessible to tenant admins and students. * * Returns: * * 200: List of tones. * @returns TonesView * @throws ApiError */ static aiPromptOrgsUsersTonesRetrieve({ org, userId, }: { org: string; }): CancelablePromise; /** * Endpoint for Adding prompt tone. * * Accessible to tenant admins only. * * Returns: * * 201: tone Object. * * 400: When data is not valid. * @returns TonesView * @throws ApiError */ static aiPromptOrgsUsersTonesCreate({ org, userId, requestBody, }: { org: string; requestBody?: TonesView; }): CancelablePromise; /** * Endpoint for updating prompt tone. * * Accessible to tenant admins only. * * Returns: * * 200: tone Object. * * 400: When data is not valid. * @returns TonesView * @throws ApiError */ static aiPromptOrgsUsersTonesUpdate({ org, toneId, userId, requestBody, }: { org: string; toneId: number; requestBody?: TonesView; }): CancelablePromise; /** * Endpoint for deleting prompt tone. * * Accessible to tenant admins and students. * * Returns: * * 204: No response data. * * 400: When data is not valid. * @returns void * @throws ApiError */ static aiPromptOrgsUsersTonesDestroy({ org, toneId, userId, }: { org: string; toneId: number; }): CancelablePromise; }