ChatKittyPlatformAPI.Api.Functions (chatkitty_platform_sdk v0.1.0)
API calls for all endpoints tagged Functions
.
Link to this section Summary
Functions
Create a chat function version Creates a new version of this chat function
List chat function invocations Returns a page of invocations of this chat function. A log of previous runs of the function
List chat function versions Returns a page of versions of this chat function
Retrieve a chat function Returns a chat function by ID
Retrieve chat function current version Returns the version of this chat function currently deployed
Link to this section Functions
create_function_version(connection, id, create_chat_function_version_resource, opts \\ [])
@spec create_function_version( Tesla.Env.client(), integer(), ChatKittyPlatformAPI.Model.CreateChatFunctionVersionResource.t(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ChatFunctionVersionResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Create a chat function version Creates a new version of this chat function
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- id (integer()): Chat function ID
- create_chat_function_version_resource (CreateChatFunctionVersionResource):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
list_function_invocations(connection, id, opts \\ [])
@spec list_function_invocations(Tesla.Env.client(), integer(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.PagedModelChatFunctionInvocationResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
List chat function invocations Returns a page of invocations of this chat function. A log of previous runs of the function
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- id (integer()): Chat function ID
- opts (KeywordList): [optional] Optional parameters
- :page (integer()): Zero-based page index (0..N)
- :size (integer()): The size of the page to be returned
- :sort ([String.t]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
returns
Returns
on success {:error, Tesla.Env.t} on failure
list_function_versions(connection, id, opts \\ [])
@spec list_function_versions(Tesla.Env.client(), integer(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.PagedModelChatFunctionVersionResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
List chat function versions Returns a page of versions of this chat function
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- id (integer()): Chat function ID
- opts (KeywordList): [optional] Optional parameters
- :page (integer()): Zero-based page index (0..N)
- :size (integer()): The size of the page to be returned
- :sort ([String.t]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
returns
Returns
on success {:error, Tesla.Env.t} on failure
retrieve_function(connection, id, opts \\ [])
@spec retrieve_function(Tesla.Env.client(), integer(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ChatFunctionResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Retrieve a chat function Returns a chat function by ID
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- id (integer()): Chat function ID
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
retrieve_function_current_version(connection, id, opts \\ [])
@spec retrieve_function_current_version(Tesla.Env.client(), integer(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ChatFunctionVersionResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Retrieve chat function current version Returns the version of this chat function currently deployed
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- id (integer()): Chat function ID
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure