Struct UnstructuredClient

pub struct UnstructuredClient { /* private fields */ }

Implementations

impl UnstructuredClient

pub fn new(base_url: &str) -> Result<Self>

Creates a new UnstructuredClient with a specified base URL.

Arguments

• base_url: A string slice that holds the base URL for the client.

returns: Result<UnstructuredClient, ClientError> - On success, returns an instance of UnstructuredClient. On failure, returns a ClientError explaining what went wrong.

Examples

let client = UnstructuredClient::new("https://example.com");
match client {
    Ok(client) => println!("Client created successfully."),
    Err(e) => println!("Failed to create client: {:?}", e),
}

pub fn with_api_key(self, api_key: &str) -> Self

Sets the API key for the UnstructuredClient.

This method allows you to provide an API key that will be included in the headers of requests made by the client.

Arguments

• api_key: A string slice that holds the API key.

Returns

Self with the API key set.

pub async fn partition_file( &self, file_path: &Path, params: PartitionParameters, ) -> Result<PartitionResponse>

Partitions the content of a given file using Unstructured’s API.

This asynchronous function reads the content of a specified file, creates a multipart form along with given parameters, and sends a POST request to the Unstructured API route. The result is a text representation of the file’s content, partitioned by the type of the text element.

Arguments

• file_path: The path to the file that needs to be partitioned.
• params: Parameters for partitioning which are defined by the PartitionParameters type.

Returns: Result<ElementList, ClientError> - On success, returns a [ElementList]; otherwise returns a ClientError.

Trait Implementations

impl Clone for UnstructuredClient

fn clone(&self) -> UnstructuredClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnstructuredClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.