NlpServerClient

aristech_nlp_client::nlp_service::nlp_server_client

Struct NlpServerClient

pub struct NlpServerClient<T> { /* private fields */ }

Expand description

NLPServer provides the interface for various NLP functionalities. These functions include text processing, content management in projects, and interaction with vectorized data structures.

Implementations§

impl NlpServerClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error>
where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Attempt to create a new client by connecting to a given endpoint.

impl<T> NlpServerClient<T>
where T: GrpcService<Body>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> NlpServerClient<InterceptedService<T, F>>
where F: Interceptor, T::ResponseBody: Default, T: Service<Request<Body>, Response = Response<<T as GrpcService<Body>>::ResponseBody>>, <T as Service<Request<Body>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn get_functions( &mut self, request: impl IntoRequest<FunctionRequest>, ) -> Result<Response<Streaming<Function>>, Status>

§GetFunctions

Returns all available processing functions (models) of the server. Each function includes a unique ID, a descriptive name, a description, and a list of possible arguments.

Request: FunctionRequest Response: stream Function

pub async fn run_functions( &mut self, request: impl IntoRequest<RunFunctionsRequest>, ) -> Result<Response<RunFunctionsResponse>, Status>

§RunFunctions

Processes the provided raw text using the specified functions. Multiple functions can be applied sequentially.

Request: RunFunctionsRequest

functions: List of functions to apply.
input: The raw text to process.
arguments: Additional parameters. Response: RunFunctionsResponse (contains the processed text result)

pub async fn update_content( &mut self, request: impl IntoRequest<UpdateContentRequest>, ) -> Result<Response<UpdateContentResponse>, Status>

§UpdateContent

Adds new content or updates existing content.

Request: UpdateContentRequest Response: UpdateContentResponse

pub async fn remove_content( &mut self, request: impl IntoRequest<RemoveContentRequest>, ) -> Result<Response<RemoveContentResponse>, Status>

§RemoveContent

Removes the specified content.

Request: RemoveContentRequest Response: RemoveContentResponse

pub async fn get_content( &mut self, request: impl IntoRequest<GetContentRequest>, ) -> Result<Response<Streaming<GetContentResponse>>, Status>

§GetContent

Retrieves content that is available both as vectorized data and as plain text.

Request: GetContentRequest Response: stream GetContentResponse

pub async fn add_project( &mut self, request: impl IntoRequest<AddProjectRequest>, ) -> Result<Response<AddProjectResponse>, Status>

§AddProject

Initializes a new project.

Request: AddProjectRequest Response: AddProjectResponse

pub async fn remove_project( &mut self, request: impl IntoRequest<RemoveProjectRequest>, ) -> Result<Response<RemoveProjectResponse>, Status>

§RemoveProject

Removes an existing project and all associated content.

Request: RemoveProjectRequest Response: RemoveProjectResponse

pub async fn update_project( &mut self, request: impl IntoRequest<UpdateProjectRequest>, ) -> Result<Response<UpdateProjectResponse>, Status>

§UpdateProject

Updates the settings or configuration of an existing project.

Request: UpdateProjectRequest Response: UpdateProjectResponse

pub async fn get_projects( &mut self, request: impl IntoRequest<GetProjectsRequest>, ) -> Result<Response<Streaming<Project>>, Status>

§GetProjects

Returns a list of all projects.

Request: GetProjectsRequest Response: stream Project

pub async fn get_intents( &mut self, request: impl IntoRequest<GetIntentsRequest>, ) -> Result<Response<Streaming<Intent>>, Status>

§GetIntents

Retrieves all intents of a project.

Request: GetIntentsRequest Response: stream Intent

pub async fn get_score_limits( &mut self, request: impl IntoRequest<GetScoreLimitsRequest>, ) -> Result<Response<GetScoreLimitsResponse>, Status>

§GetScoreLimits

Determines score limits for a project based on test inputs.

Request: GetScoreLimitsRequest Response: GetScoreLimitsResponse

pub async fn get_embedding_models( &mut self, request: impl IntoRequest<GetEmbeddingModelsRequest>, ) -> Result<Response<Streaming<EmbeddingModel>>, Status>

§GetEmbeddingModels

Returns a list of available embedding models for similarity searches.

Request: GetEmbeddingModelsRequest Response: stream EmbeddingModel

pub async fn sync_d_bs( &mut self, request: impl IntoRequest<SyncDBsRequest>, ) -> Result<Response<SyncDBsResponse>, Status>

Trait Implementations§

impl<T: Clone> Clone for NlpServerClient<T>

fn clone(&self) -> NlpServerClient<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for NlpServerClient<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T> !Freeze for NlpServerClient<T>

impl<T> RefUnwindSafe for NlpServerClient<T>
where T: RefUnwindSafe,

impl<T> Send for NlpServerClient<T>
where T: Send,

impl<T> Sync for NlpServerClient<T>
where T: Sync,

impl<T> Unpin for NlpServerClient<T>
where T: Unpin,

impl<T> UnwindSafe for NlpServerClient<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more