Twilio.Knowledge.V2.ControlPlane.KnowledgeBaseService (twilio_elixir v0.1.3)

Copy Markdown View Source

Service for KnowledgeBase API operations.

Operations: list, create, fetch, delete

Summary

Functions

Delete a Knowledge Base and all associated knowledge resources. This action cannot be undone.

Retrieve the details of a specific Knowledge Base by its unique ID.

Get a list of knowledge bases for the Twilio account.

Stream: Get a list of knowledge bases for the Twilio account. (lazy auto-pagination).

Functions

create(client, params \\ %{}, opts \\ [])

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Knowledge.V2.ControlPlane.KnowledgeBase.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

Create a new Knowledge Base for the Twilio account. Accounts can have multiple knowledge bases. Each knowledge base can contain multiple knowledge resources such as documents, websites, or text content that can be used for context and information retrieval.

Operation: CreateKnowledgeBase | Tags: KnowledgeBases

delete(client, sid, opts \\ [])

@spec delete(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()}

Delete a Knowledge Base and all associated knowledge resources. This action cannot be undone.

Operation: DeleteKnowledgeBase | Tags: KnowledgeBases

fetch(client, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Knowledge.V2.ControlPlane.KnowledgeBase.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Retrieve the details of a specific Knowledge Base by its unique ID.

Operation: FetchKnowledgeBase | Tags: KnowledgeBases

list(client, params \\ %{}, opts \\ [])

@spec list(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Get a list of knowledge bases for the Twilio account.

Operation: ListKnowledgeBases | Tags: KnowledgeBases

stream(client, params \\ %{}, opts \\ [])

@spec stream(Twilio.Client.t(), map(), keyword()) :: Enumerable.t()

Stream: Get a list of knowledge bases for the Twilio account. (lazy auto-pagination).