OpenApiTypesense.NlSearchModels
(OpenApiTypesense v1.3.2)
View Source
Provides API endpoints related to nl search models
Summary
Functions
Create a NL search model
Delete a NL search model
List all NL search models
Retrieve a NL search model
Update a NL search model
Functions
@spec create_nl_search_model( body :: OpenApiTypesense.NLSearchModelCreateSchema.t(), opts :: keyword() ) :: {:ok, OpenApiTypesense.NLSearchModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Create a NL search model
Create a new NL search model.
Request Body
Content Types: application/json
The NL search model to be created
@spec delete_nl_search_model(model_id :: String.t(), opts :: keyword()) :: {:ok, OpenApiTypesense.NLSearchModelDeleteSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Delete a NL search model
Delete a specific NL search model by its ID.
@spec retrieve_all_nl_search_models(opts :: keyword()) :: {:ok, [OpenApiTypesense.NLSearchModelSchema.t()]} | {:error, OpenApiTypesense.ApiResponse.t()}
List all NL search models
Retrieve all NL search models.
@spec retrieve_nl_search_model(model_id :: String.t(), opts :: keyword()) :: {:ok, OpenApiTypesense.NLSearchModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieve a NL search model
Retrieve a specific NL search model by its ID.
@spec update_nl_search_model( model_id :: String.t(), body :: OpenApiTypesense.NLSearchModelCreateSchema.t(), opts :: keyword() ) :: {:ok, OpenApiTypesense.NLSearchModelSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Update a NL search model
Update an existing NL search model.
Request Body
Content Types: application/json
The NL search model fields to update