Skip to content

LLM helpers and Parakeet methods

Get Information about a model

1
llm.ShowModelInformation(url, model string) (llm.ModelInformation, int, error)

ShowModelInformation retrieves information about a model from the specified URL.

Parameters:

  • url: the base URL of the API.
  • model: the name of the model to retrieve information for.

Returns:

  • ModelInformation: the information about the model.
  • int: the HTTP status code of the response.
  • error: an error if the request fails.

✋ Remark: if the model does not exist, it will return an error with a status code of 404.

If you use a protected Ollama endpoint, use this function:

1
llm.ShowModelInformationWithToken(url, model , tokenHeaderName, tokenHeaderValue string) (llm.ModelInformation, int, error)

Pull a model

1
llm.PullModel(url, model string) (llm.PullResult, int, error)

PullModel sends a POST request to the specified URL to pull a model with the given name.

Parameters:

  • url: The URL to send the request to.
  • model: The name of the model to pull.

Returns:

  • PullResult: The result of the pull operation.
  • int: The HTTP status code of the response.
  • error: An error if the request fails.

If you use a protected Ollama endpoint, use this function:

1
llm.PullModelWithToken(url, model , tokenHeaderName, tokenHeaderValue string) (llm.PullResult, int, error)

Get the list of the installed models

1
llm.GetModelsList(url string) (llm.ModelList, int, error)

GetModelsList sends a GET request to the specified URL to fetch the list of the installed models.

Parameters:

  • url: The URL to send the request to.

Returns:

  • ModelList: The result of the reques, use the models property to get the list.
  • int: The HTTP status code of the response.
  • error: An error if the request fails.

If you use a protected Ollama endpoint, use this function:

1
llm.GetModelsList(url , tokenHeaderName, tokenHeaderValue string) (llm.ModelList, int, error)

Note

👀 you will find a complete example in: