ExBifrost.Api.PromptRepository (ex_bifrost v0.1.0)

@spec commit_prompt_session(
  Tesla.Env.client(),
  integer(),
  ExBifrost.Model.CommitPromptSessionRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreatePromptVersion200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Commit session as version Commits the current session state as a new prompt version.

Parameters

connection (ExBifrost.Connection): Connection to server
id (integer()): Session ID
commit_prompt_session_request (CommitPromptSessionRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePromptVersion200Response.t} on success
{:error, Tesla.Env.t} on failure

create_folder(connection, clone_access_profile_request, opts \\ [])

@spec create_folder(
  Tesla.Env.client(),
  ExBifrost.Model.CloneAccessProfileRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreateFolder200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Create folder Creates a new prompt folder.

Parameters

connection (ExBifrost.Connection): Connection to server
clone_access_profile_request (CloneAccessProfileRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreateFolder200Response.t} on success
{:error, Tesla.Env.t} on failure

create_prompt(connection, create_prompt_request, opts \\ [])

@spec create_prompt(
  Tesla.Env.client(),
  ExBifrost.Model.CreatePromptRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreatePrompt200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Create prompt Creates a new prompt.

Parameters

connection (ExBifrost.Connection): Connection to server
create_prompt_request (CreatePromptRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePrompt200Response.t} on success
{:error, Tesla.Env.t} on failure

create_prompt_session(connection, id, create_prompt_session_request, opts \\ [])

@spec create_prompt_session(
  Tesla.Env.client(),
  String.t(),
  ExBifrost.Model.CreatePromptSessionRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreatePromptSession200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Create prompt session Creates a new playground session for a prompt.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t): Prompt ID
create_prompt_session_request (CreatePromptSessionRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePromptSession200Response.t} on success
{:error, Tesla.Env.t} on failure

create_prompt_version(connection, id, create_prompt_version_request, opts \\ [])

@spec create_prompt_version(
  Tesla.Env.client(),
  String.t(),
  ExBifrost.Model.CreatePromptVersionRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreatePromptVersion200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Create prompt version Creates a new version for a prompt.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t): Prompt ID
create_prompt_version_request (CreatePromptVersionRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePromptVersion200Response.t} on success
{:error, Tesla.Env.t} on failure

delete_folder(connection, id, opts \\ [])

@spec delete_folder(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExBifrost.Model.MessageResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Delete folder Deletes a folder and cascades to contained prompts.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.MessageResponse.t} on success
{:error, Tesla.Env.t} on failure

delete_prompt(connection, id, opts \\ [])

@spec delete_prompt(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExBifrost.Model.MessageResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Delete prompt Deletes a prompt and all its versions and sessions.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.MessageResponse.t} on success
{:error, Tesla.Env.t} on failure

delete_prompt_session(connection, id, opts \\ [])

@spec delete_prompt_session(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, ExBifrost.Model.MessageResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Delete prompt session Deletes a specific session.

Parameters

connection (ExBifrost.Connection): Connection to server
id (integer()): Session ID
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.MessageResponse.t} on success
{:error, Tesla.Env.t} on failure

delete_prompt_version(connection, id, opts \\ [])

@spec delete_prompt_version(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, ExBifrost.Model.MessageResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Delete prompt version Deletes a specific version.

Parameters

connection (ExBifrost.Connection): Connection to server
id (integer()): Version ID
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.MessageResponse.t} on success
{:error, Tesla.Env.t} on failure

get_folder(connection, id, opts \\ [])

@spec get_folder(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExBifrost.Model.CreateFolder200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Get folder Returns a folder by ID.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreateFolder200Response.t} on success
{:error, Tesla.Env.t} on failure

get_prompt(connection, id, opts \\ [])

@spec get_prompt(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExBifrost.Model.CreatePrompt200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Get prompt Returns a prompt by ID with its latest version.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePrompt200Response.t} on success
{:error, Tesla.Env.t} on failure

get_prompt_session(connection, id, opts \\ [])

@spec get_prompt_session(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, ExBifrost.Model.CreatePromptSession200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Get prompt session Returns a specific session by ID.

Parameters

connection (ExBifrost.Connection): Connection to server
id (integer()): Session ID
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePromptSession200Response.t} on success
{:error, Tesla.Env.t} on failure

get_prompt_version(connection, id, opts \\ [])

@spec get_prompt_version(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, ExBifrost.Model.CreatePromptVersion200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Get prompt version Returns a specific version by ID.

Parameters

connection (ExBifrost.Connection): Connection to server
id (integer()): Version ID
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePromptVersion200Response.t} on success
{:error, Tesla.Env.t} on failure

list_folders(connection, opts \\ [])

@spec list_folders(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, ExBifrost.Model.ListFolders200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

List folders Returns all prompt folders.

Parameters

connection (ExBifrost.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.ListFolders200Response.t} on success
{:error, Tesla.Env.t} on failure

list_prompt_sessions(connection, id, opts \\ [])

@spec list_prompt_sessions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExBifrost.Model.ListPromptSessions200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

List prompt sessions Returns all sessions for a prompt.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t): Prompt ID
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.ListPromptSessions200Response.t} on success
{:error, Tesla.Env.t} on failure

list_prompt_versions(connection, id, opts \\ [])

@spec list_prompt_versions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExBifrost.Model.BifrostError.t()}
  | {:ok, ExBifrost.Model.ListPromptVersions200Response.t()}
  | {:error, Tesla.Env.t()}

List prompt versions Returns all versions for a prompt.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t): Prompt ID
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.ListPromptVersions200Response.t} on success
{:error, Tesla.Env.t} on failure

list_prompts(connection, opts \\ [])

@spec list_prompts(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, ExBifrost.Model.ListPrompts200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

List prompts Returns all prompts, optionally filtered by folder.

Parameters

connection (ExBifrost.Connection): Connection to server
opts (keyword): Optional parameters
- :folder_id (String.t): Filter by folder ID

Returns

{:ok, ExBifrost.Model.ListPrompts200Response.t} on success
{:error, Tesla.Env.t} on failure

rename_prompt_session(connection, id, create_team_request, opts \\ [])

@spec rename_prompt_session(
  Tesla.Env.client(),
  integer(),
  ExBifrost.Model.CreateTeamRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreatePromptSession200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Rename prompt session Renames a session.

Parameters

connection (ExBifrost.Connection): Connection to server
id (integer()): Session ID
create_team_request (CreateTeamRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePromptSession200Response.t} on success
{:error, Tesla.Env.t} on failure

update_folder(connection, id, update_folder_request, opts \\ [])

@spec update_folder(
  Tesla.Env.client(),
  String.t(),
  ExBifrost.Model.UpdateFolderRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreateFolder200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Update folder Updates a folder's name or description.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t):
update_folder_request (UpdateFolderRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreateFolder200Response.t} on success
{:error, Tesla.Env.t} on failure

update_prompt(connection, id, update_prompt_request, opts \\ [])

@spec update_prompt(
  Tesla.Env.client(),
  String.t(),
  ExBifrost.Model.UpdatePromptRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreatePrompt200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Update prompt Updates a prompt's name or folder.

Parameters

connection (ExBifrost.Connection): Connection to server
id (String.t):
update_prompt_request (UpdatePromptRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePrompt200Response.t} on success
{:error, Tesla.Env.t} on failure

update_prompt_session(connection, id, update_prompt_session_request, opts \\ [])

@spec update_prompt_session(
  Tesla.Env.client(),
  integer(),
  ExBifrost.Model.UpdatePromptSessionRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.CreatePromptSession200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Update prompt session Updates a session's messages, model params, etc.

Parameters

connection (ExBifrost.Connection): Connection to server
id (integer()): Session ID
update_prompt_session_request (UpdatePromptSessionRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.CreatePromptSession200Response.t} on success
{:error, Tesla.Env.t} on failure