tokenize

package
v1.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 15, 2026 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for tokenize API

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) Tokenize 

func (a *Client) Tokenize(params *TokenizeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*TokenizeOK, error)

Tokenize tokenizes text

Tokenizes the provided text using the specified tokenization method. This is a stateless utility endpoint useful for debugging and understanding how text will be processed during indexing and querying. The response includes both the indexed tokens (as stored in the inverted index) and query tokens (after optional stopword removal).

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	Tokenize(params *TokenizeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*TokenizeOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new tokenize API client.

type TokenizeBadRequest 

type TokenizeBadRequest struct {
}

TokenizeBadRequest describes a response with status code 400, with default header values.

Invalid or malformed request body.

func NewTokenizeBadRequest 

func NewTokenizeBadRequest() *TokenizeBadRequest

NewTokenizeBadRequest creates a TokenizeBadRequest with default headers values

func (*TokenizeBadRequest) Code 

func (o *TokenizeBadRequest) Code() int

Code gets the status code for the tokenize bad request response

func (*TokenizeBadRequest) Error 

func (o *TokenizeBadRequest) Error() string

func (*TokenizeBadRequest) IsClientError 

func (o *TokenizeBadRequest) IsClientError() bool

IsClientError returns true when this tokenize bad request response has a 4xx status code

func (*TokenizeBadRequest) IsCode 

func (o *TokenizeBadRequest) IsCode(code int) bool

IsCode returns true when this tokenize bad request response a status code equal to that given

func (*TokenizeBadRequest) IsRedirect 

func (o *TokenizeBadRequest) IsRedirect() bool

IsRedirect returns true when this tokenize bad request response has a 3xx status code

func (*TokenizeBadRequest) IsServerError 

func (o *TokenizeBadRequest) IsServerError() bool

IsServerError returns true when this tokenize bad request response has a 5xx status code

func (*TokenizeBadRequest) IsSuccess 

func (o *TokenizeBadRequest) IsSuccess() bool

IsSuccess returns true when this tokenize bad request response has a 2xx status code

func (*TokenizeBadRequest) String 

func (o *TokenizeBadRequest) String() string

type TokenizeForbidden 

type TokenizeForbidden struct {
	Payload *models.ErrorResponse
}

TokenizeForbidden describes a response with status code 403, with default header values.

Forbidden

func NewTokenizeForbidden 

func NewTokenizeForbidden() *TokenizeForbidden

NewTokenizeForbidden creates a TokenizeForbidden with default headers values

func (*TokenizeForbidden) Code 

func (o *TokenizeForbidden) Code() int

Code gets the status code for the tokenize forbidden response

func (*TokenizeForbidden) Error 

func (o *TokenizeForbidden) Error() string

func (*TokenizeForbidden) GetPayload 

func (o *TokenizeForbidden) GetPayload() *models.ErrorResponse

func (*TokenizeForbidden) IsClientError 

func (o *TokenizeForbidden) IsClientError() bool

IsClientError returns true when this tokenize forbidden response has a 4xx status code

func (*TokenizeForbidden) IsCode 

func (o *TokenizeForbidden) IsCode(code int) bool

IsCode returns true when this tokenize forbidden response a status code equal to that given

func (*TokenizeForbidden) IsRedirect 

func (o *TokenizeForbidden) IsRedirect() bool

IsRedirect returns true when this tokenize forbidden response has a 3xx status code

func (*TokenizeForbidden) IsServerError 

func (o *TokenizeForbidden) IsServerError() bool

IsServerError returns true when this tokenize forbidden response has a 5xx status code

func (*TokenizeForbidden) IsSuccess 

func (o *TokenizeForbidden) IsSuccess() bool

IsSuccess returns true when this tokenize forbidden response has a 2xx status code

func (*TokenizeForbidden) String 

func (o *TokenizeForbidden) String() string

type TokenizeInternalServerError 

type TokenizeInternalServerError struct {
	Payload *models.ErrorResponse
}

TokenizeInternalServerError describes a response with status code 500, with default header values.

An unexpected error occurred while tokenizing the text. Check the ErrorResponse for details.

func NewTokenizeInternalServerError 

func NewTokenizeInternalServerError() *TokenizeInternalServerError

NewTokenizeInternalServerError creates a TokenizeInternalServerError with default headers values

func (*TokenizeInternalServerError) Code 

func (o *TokenizeInternalServerError) Code() int

Code gets the status code for the tokenize internal server error response

func (*TokenizeInternalServerError) Error 

func (o *TokenizeInternalServerError) Error() string

func (*TokenizeInternalServerError) GetPayload 

func (o *TokenizeInternalServerError) GetPayload() *models.ErrorResponse

func (*TokenizeInternalServerError) IsClientError 

func (o *TokenizeInternalServerError) IsClientError() bool

IsClientError returns true when this tokenize internal server error response has a 4xx status code

func (*TokenizeInternalServerError) IsCode 

func (o *TokenizeInternalServerError) IsCode(code int) bool

IsCode returns true when this tokenize internal server error response a status code equal to that given

func (*TokenizeInternalServerError) IsRedirect 

func (o *TokenizeInternalServerError) IsRedirect() bool

IsRedirect returns true when this tokenize internal server error response has a 3xx status code

func (*TokenizeInternalServerError) IsServerError 

func (o *TokenizeInternalServerError) IsServerError() bool

IsServerError returns true when this tokenize internal server error response has a 5xx status code

func (*TokenizeInternalServerError) IsSuccess 

func (o *TokenizeInternalServerError) IsSuccess() bool

IsSuccess returns true when this tokenize internal server error response has a 2xx status code

func (*TokenizeInternalServerError) String 

func (o *TokenizeInternalServerError) String() string

type TokenizeOK 

type TokenizeOK struct {
	Payload *models.TokenizeResponse
}

TokenizeOK describes a response with status code 200, with default header values.

Successfully tokenized the text.

func NewTokenizeOK 

func NewTokenizeOK() *TokenizeOK

NewTokenizeOK creates a TokenizeOK with default headers values

func (*TokenizeOK) Code 

func (o *TokenizeOK) Code() int

Code gets the status code for the tokenize o k response

func (*TokenizeOK) Error 

func (o *TokenizeOK) Error() string

func (*TokenizeOK) GetPayload 

func (o *TokenizeOK) GetPayload() *models.TokenizeResponse

func (*TokenizeOK) IsClientError 

func (o *TokenizeOK) IsClientError() bool

IsClientError returns true when this tokenize o k response has a 4xx status code

func (*TokenizeOK) IsCode 

func (o *TokenizeOK) IsCode(code int) bool

IsCode returns true when this tokenize o k response a status code equal to that given

func (*TokenizeOK) IsRedirect 

func (o *TokenizeOK) IsRedirect() bool

IsRedirect returns true when this tokenize o k response has a 3xx status code

func (*TokenizeOK) IsServerError 

func (o *TokenizeOK) IsServerError() bool

IsServerError returns true when this tokenize o k response has a 5xx status code

func (*TokenizeOK) IsSuccess 

func (o *TokenizeOK) IsSuccess() bool

IsSuccess returns true when this tokenize o k response has a 2xx status code

func (*TokenizeOK) String 

func (o *TokenizeOK) String() string

type TokenizeParams 

type TokenizeParams struct {

	// Body.
	Body *models.TokenizeRequest

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

TokenizeParams contains all the parameters to send to the API endpoint 

for the tokenize operation.

Typically these are written to a http.Request.

func NewTokenizeParams 

func NewTokenizeParams() *TokenizeParams

NewTokenizeParams creates a new TokenizeParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewTokenizeParamsWithContext 

func NewTokenizeParamsWithContext(ctx context.Context) *TokenizeParams

NewTokenizeParamsWithContext creates a new TokenizeParams object with the ability to set a context for a request.

func NewTokenizeParamsWithHTTPClient 

func NewTokenizeParamsWithHTTPClient(client *http.Client) *TokenizeParams

NewTokenizeParamsWithHTTPClient creates a new TokenizeParams object with the ability to set a custom HTTPClient for a request.

func NewTokenizeParamsWithTimeout 

func NewTokenizeParamsWithTimeout(timeout time.Duration) *TokenizeParams

NewTokenizeParamsWithTimeout creates a new TokenizeParams object with the ability to set a timeout on a request.

func (*TokenizeParams) SetBody 

func (o *TokenizeParams) SetBody(body *models.TokenizeRequest)

SetBody adds the body to the tokenize params

func (*TokenizeParams) SetContext 

func (o *TokenizeParams) SetContext(ctx context.Context)

SetContext adds the context to the tokenize params

func (*TokenizeParams) SetDefaults 

func (o *TokenizeParams) SetDefaults()

SetDefaults hydrates default values in the tokenize params (not the query body).

All values with no default are reset to their zero value.

func (*TokenizeParams) SetHTTPClient 

func (o *TokenizeParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the tokenize params

func (*TokenizeParams) SetTimeout 

func (o *TokenizeParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the tokenize params

func (*TokenizeParams) WithBody 

func (o *TokenizeParams) WithBody(body *models.TokenizeRequest) *TokenizeParams

WithBody adds the body to the tokenize params

func (*TokenizeParams) WithContext 

func (o *TokenizeParams) WithContext(ctx context.Context) *TokenizeParams

WithContext adds the context to the tokenize params

func (*TokenizeParams) WithDefaults 

func (o *TokenizeParams) WithDefaults() *TokenizeParams

WithDefaults hydrates default values in the tokenize params (not the query body).

All values with no default are reset to their zero value.

func (*TokenizeParams) WithHTTPClient 

func (o *TokenizeParams) WithHTTPClient(client *http.Client) *TokenizeParams

WithHTTPClient adds the HTTPClient to the tokenize params

func (*TokenizeParams) WithTimeout 

func (o *TokenizeParams) WithTimeout(timeout time.Duration) *TokenizeParams

WithTimeout adds the timeout to the tokenize params

func (*TokenizeParams) WriteToRequest 

func (o *TokenizeParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type TokenizeReader 

type TokenizeReader struct {
	// contains filtered or unexported fields
}

TokenizeReader is a Reader for the Tokenize structure.

func (*TokenizeReader) ReadResponse 

func (o *TokenizeReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type TokenizeUnauthorized 

type TokenizeUnauthorized struct {
}

TokenizeUnauthorized describes a response with status code 401, with default header values.

Unauthorized or invalid credentials.

func NewTokenizeUnauthorized 

func NewTokenizeUnauthorized() *TokenizeUnauthorized

NewTokenizeUnauthorized creates a TokenizeUnauthorized with default headers values

func (*TokenizeUnauthorized) Code 

func (o *TokenizeUnauthorized) Code() int

Code gets the status code for the tokenize unauthorized response

func (*TokenizeUnauthorized) Error 

func (o *TokenizeUnauthorized) Error() string

func (*TokenizeUnauthorized) IsClientError 

func (o *TokenizeUnauthorized) IsClientError() bool

IsClientError returns true when this tokenize unauthorized response has a 4xx status code

func (*TokenizeUnauthorized) IsCode 

func (o *TokenizeUnauthorized) IsCode(code int) bool

IsCode returns true when this tokenize unauthorized response a status code equal to that given

func (*TokenizeUnauthorized) IsRedirect 

func (o *TokenizeUnauthorized) IsRedirect() bool

IsRedirect returns true when this tokenize unauthorized response has a 3xx status code

func (*TokenizeUnauthorized) IsServerError 

func (o *TokenizeUnauthorized) IsServerError() bool

IsServerError returns true when this tokenize unauthorized response has a 5xx status code

func (*TokenizeUnauthorized) IsSuccess 

func (o *TokenizeUnauthorized) IsSuccess() bool

IsSuccess returns true when this tokenize unauthorized response has a 2xx status code

func (*TokenizeUnauthorized) String 

func (o *TokenizeUnauthorized) String() string

type TokenizeUnprocessableEntity 

type TokenizeUnprocessableEntity struct {
	Payload *models.ErrorResponse
}

TokenizeUnprocessableEntity describes a response with status code 422, with default header values.

Request binding or validation error. Check the ErrorResponse for details.

func NewTokenizeUnprocessableEntity 

func NewTokenizeUnprocessableEntity() *TokenizeUnprocessableEntity

NewTokenizeUnprocessableEntity creates a TokenizeUnprocessableEntity with default headers values

func (*TokenizeUnprocessableEntity) Code 

func (o *TokenizeUnprocessableEntity) Code() int

Code gets the status code for the tokenize unprocessable entity response

func (*TokenizeUnprocessableEntity) Error 

func (o *TokenizeUnprocessableEntity) Error() string

func (*TokenizeUnprocessableEntity) GetPayload 

func (o *TokenizeUnprocessableEntity) GetPayload() *models.ErrorResponse

func (*TokenizeUnprocessableEntity) IsClientError 

func (o *TokenizeUnprocessableEntity) IsClientError() bool

IsClientError returns true when this tokenize unprocessable entity response has a 4xx status code

func (*TokenizeUnprocessableEntity) IsCode 

func (o *TokenizeUnprocessableEntity) IsCode(code int) bool

IsCode returns true when this tokenize unprocessable entity response a status code equal to that given

func (*TokenizeUnprocessableEntity) IsRedirect 

func (o *TokenizeUnprocessableEntity) IsRedirect() bool

IsRedirect returns true when this tokenize unprocessable entity response has a 3xx status code

func (*TokenizeUnprocessableEntity) IsServerError 

func (o *TokenizeUnprocessableEntity) IsServerError() bool

IsServerError returns true when this tokenize unprocessable entity response has a 5xx status code

func (*TokenizeUnprocessableEntity) IsSuccess 

func (o *TokenizeUnprocessableEntity) IsSuccess() bool

IsSuccess returns true when this tokenize unprocessable entity response has a 2xx status code

func (*TokenizeUnprocessableEntity) String 

func (o *TokenizeUnprocessableEntity) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.