OpenApiTypesense.Conversations (OpenApiTypesense v0.6.5)
View SourceProvides API endpoints related to conversations
Summary
Functions
post /conversations/models
Either one of
Either one of
Delete a conversation model
Either one of
Either one of
List all conversation models
Either one of
Either one of
Retrieve a conversation model
Either one of
Either one of
Update a conversation model
Either one of
Either one of
Functions
@spec create_conversation_model(map()) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
post /conversations/models
Create a Conversation Model
@spec create_conversation_model( map() | OpenApiTypesense.Connection.t(), map() | keyword() ) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
create_conversation_model(body, opts)
create_conversation_model(%{api_key: xyz, host: ...}, body)
create_conversation_model(Connection.new(), body)
@spec create_conversation_model( map() | OpenApiTypesense.Connection.t(), map(), keyword() ) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
create_conversation_model(%{api_key: xyz, host: ...}, body, opts)
create_conversation_model(Connection.new(), body, opts)
@spec delete_conversation_model(String.t()) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Delete a conversation model
Delete a conversation model
Either one of:
delete_conversation_model(modelId, opts)
delete_conversation_model(%{api_key: xyz, host: ...}, modelId)
delete_conversation_model(Connection.new(), modelId)
@spec delete_conversation_model( map() | OpenApiTypesense.Connection.t(), String.t(), String.t() | keyword() ) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec delete_conversation_model( map() | OpenApiTypesense.Connection.t(), String.t(), keyword() ) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
delete_conversation_model(%{api_key: xyz, host: ...}, modelId, opts)
delete_conversation_model(Connection.new(), modelId, opts)
@spec retrieve_all_conversation_models() :: {:ok, [OpenApiTypesense.ConversationModelSchema.t()]} | {:error, OpenApiTypesense.ApiResponse.t()}
List all conversation models
Retrieve all conversation models
@spec retrieve_all_conversation_models( map() | OpenApiTypesense.Connection.t() | keyword() ) :: {:ok, [OpenApiTypesense.ConversationModelSchema.t()]} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_all_conversation_models(opts)
retrieve_all_conversation_models(%{api_key: xyz, host: ...})
retrieve_all_conversation_models(Connection.new())
@spec retrieve_all_conversation_models( map() | OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, [OpenApiTypesense.ConversationModelSchema.t()]} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_all_conversation_models(%{api_key: xyz, host: ...}, opts)
retrieve_all_conversation_models(Connection.new(), opts)
@spec retrieve_conversation_model(String.t()) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieve a conversation model
Retrieve a conversation model
@spec retrieve_conversation_model( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | keyword() ) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_conversation_model(modelId, opts)
retrieve_conversation_model(%{api_key: xyz, host: ...}, modelId)
retrieve_conversation_model(Connection.new(), modelId)
@spec retrieve_conversation_model( map() | OpenApiTypesense.Connection.t(), String.t(), keyword() ) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_conversation_model(%{api_key: xyz, host: ...}, modelId, opts)
retrieve_conversation_model(Connection.new(), modelId, opts)
@spec update_conversation_model(String.t(), map()) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Update a conversation model
Update a conversation model
@spec update_conversation_model( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | map(), map() | keyword() ) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
update_conversation_model(modelId, body, opts)
update_conversation_model(%{api_key: xyz, host: ...}, modelId, body)
update_conversation_model(Connection.new(), modelId, body)
@spec update_conversation_model( map() | OpenApiTypesense.Connection.t(), String.t(), map(), keyword() ) :: {:ok, OpenApiTypesense.ConversationModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
update_conversation_model(%{api_key: xyz, host: ...}, modelId, body, opts)
update_conversation_model(Connection.new(), modelId, body, opts)