LettaAPI.Api.Sources (letta_api v1.0.0)

API calls for all endpoints tagged Sources.

Summary

Functions

Count Sources Count all data sources created by a user.

Create Source Create a new data source.

Delete File From Source Delete a data source.

Delete Source Delete a data source.

Get Source Id By Name Get a source by name

List Source Files List paginated files associated with a data source.

List Source Passages List all passages associated with a data source.

List Sources List all data sources created by a user.

Modify Source Update the name or documentation of an existing data source.

Retrieve Source Get all sources

Upload File To Source Upload a file to a data source.

Functions

count_sources(connection, opts \\ [])

@spec count_sources(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, integer()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Count Sources Count all data sources created by a user.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, integer()} on success
  • {:error, Tesla.Env.t} on failure

create_source(connection, source_create, opts \\ [])

Create Source Create a new data source.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_create (SourceCreate):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, LettaAPI.Model.Source.t} on success
  • {:error, Tesla.Env.t} on failure

delete_file_from_source(connection, source_id, file_id, opts \\ [])

@spec delete_file_from_source(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Delete File From Source Delete a data source.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_id (String.t):
  • file_id (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

delete_source(connection, source_id, opts \\ [])

@spec delete_source(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, any()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Delete Source Delete a data source.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_id (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, any()} on success
  • {:error, Tesla.Env.t} on failure

get_source_id_by_name(connection, source_name, opts \\ [])

@spec get_source_id_by_name(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Get Source Id By Name Get a source by name

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_name (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, String.t} on success
  • {:error, Tesla.Env.t} on failure

list_source_files(connection, source_id, opts \\ [])

@spec list_source_files(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:ok, [LettaAPI.Model.FileMetadata.t()]}
  | {:error, Tesla.Env.t()}

List Source Files List paginated files associated with a data source.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_id (String.t):
  • opts (keyword): Optional parameters
    • :limit (integer()): Number of files to return
    • :after (String.t): Pagination cursor to fetch the next set of results
    • :user_id (String.t):

Returns

  • {:ok, [%FileMetadata{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

list_source_passages(connection, source_id, opts \\ [])

@spec list_source_passages(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [LettaAPI.Model.Passage.t()]}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

List Source Passages List all passages associated with a data source.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_id (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, [%Passage{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

list_sources(connection, opts \\ [])

@spec list_sources(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [LettaAPI.Model.Source.t()]}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

List Sources List all data sources created by a user.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, [%Source{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

modify_source(connection, source_id, source_update, opts \\ [])

Modify Source Update the name or documentation of an existing data source.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_id (String.t):
  • source_update (SourceUpdate):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, LettaAPI.Model.Source.t} on success
  • {:error, Tesla.Env.t} on failure

retrieve_source(connection, source_id, opts \\ [])

@spec retrieve_source(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, LettaAPI.Model.Source.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Retrieve Source Get all sources

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_id (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, LettaAPI.Model.Source.t} on success
  • {:error, Tesla.Env.t} on failure

upload_file_to_source(connection, source_id, file, opts \\ [])

@spec upload_file_to_source(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, LettaAPI.Model.Job.t()}
  | {:ok, LettaAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Upload File To Source Upload a file to a data source.

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • source_id (String.t):
  • file (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, LettaAPI.Model.Job.t} on success
  • {:error, Tesla.Env.t} on failure