search

package
v1.38.7 Latest Latest
Warning

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

Go to latest
Published: Jul 27, 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 search API

func (*Client) SearchNearText

func (a *Client) SearchNearText(params *SearchNearTextParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchNearTextOK, error)

SearchNearText searches a collection with near text

Performs a semantic (near-text) search over the objects of a collection. The query text is vectorized server-side by the collection's vectorizer module and the closest objects are returned, each as an envelope of its `id`, the selected `properties`, the selected `references` and, when requested, its retrieval `metadata`.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	SearchNearText(params *SearchNearTextParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchNearTextOK, 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 search API client.

type SearchNearTextBadGateway

type SearchNearTextBadGateway struct {
	Payload *models.ErrorResponse
}

SearchNearTextBadGateway describes a response with status code 502, with default header values.

The embedding provider failed to vectorize the query; the search cannot run.

func NewSearchNearTextBadGateway

func NewSearchNearTextBadGateway() *SearchNearTextBadGateway

NewSearchNearTextBadGateway creates a SearchNearTextBadGateway with default headers values

func (*SearchNearTextBadGateway) Code

func (o *SearchNearTextBadGateway) Code() int

Code gets the status code for the search near text bad gateway response

func (*SearchNearTextBadGateway) Error

func (o *SearchNearTextBadGateway) Error() string

func (*SearchNearTextBadGateway) GetPayload

func (*SearchNearTextBadGateway) IsClientError

func (o *SearchNearTextBadGateway) IsClientError() bool

IsClientError returns true when this search near text bad gateway response has a 4xx status code

func (*SearchNearTextBadGateway) IsCode

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

IsCode returns true when this search near text bad gateway response a status code equal to that given

func (*SearchNearTextBadGateway) IsRedirect

func (o *SearchNearTextBadGateway) IsRedirect() bool

IsRedirect returns true when this search near text bad gateway response has a 3xx status code

func (*SearchNearTextBadGateway) IsServerError

func (o *SearchNearTextBadGateway) IsServerError() bool

IsServerError returns true when this search near text bad gateway response has a 5xx status code

func (*SearchNearTextBadGateway) IsSuccess

func (o *SearchNearTextBadGateway) IsSuccess() bool

IsSuccess returns true when this search near text bad gateway response has a 2xx status code

func (*SearchNearTextBadGateway) String

func (o *SearchNearTextBadGateway) String() string

type SearchNearTextBadRequest

type SearchNearTextBadRequest struct {
	Payload *models.ErrorResponse
}

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

An invalid parameter value (e.g. empty query, negative paging, unknown property) or an unparseable request body.

func NewSearchNearTextBadRequest

func NewSearchNearTextBadRequest() *SearchNearTextBadRequest

NewSearchNearTextBadRequest creates a SearchNearTextBadRequest with default headers values

func (*SearchNearTextBadRequest) Code

func (o *SearchNearTextBadRequest) Code() int

Code gets the status code for the search near text bad request response

func (*SearchNearTextBadRequest) Error

func (o *SearchNearTextBadRequest) Error() string

func (*SearchNearTextBadRequest) GetPayload

func (*SearchNearTextBadRequest) IsClientError

func (o *SearchNearTextBadRequest) IsClientError() bool

IsClientError returns true when this search near text bad request response has a 4xx status code

func (*SearchNearTextBadRequest) IsCode

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

IsCode returns true when this search near text bad request response a status code equal to that given

func (*SearchNearTextBadRequest) IsRedirect

func (o *SearchNearTextBadRequest) IsRedirect() bool

IsRedirect returns true when this search near text bad request response has a 3xx status code

func (*SearchNearTextBadRequest) IsServerError

func (o *SearchNearTextBadRequest) IsServerError() bool

IsServerError returns true when this search near text bad request response has a 5xx status code

func (*SearchNearTextBadRequest) IsSuccess

func (o *SearchNearTextBadRequest) IsSuccess() bool

IsSuccess returns true when this search near text bad request response has a 2xx status code

func (*SearchNearTextBadRequest) String

func (o *SearchNearTextBadRequest) String() string

type SearchNearTextForbidden

type SearchNearTextForbidden struct {
	Payload *models.ErrorResponse
}

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

Forbidden

func NewSearchNearTextForbidden

func NewSearchNearTextForbidden() *SearchNearTextForbidden

NewSearchNearTextForbidden creates a SearchNearTextForbidden with default headers values

func (*SearchNearTextForbidden) Code

func (o *SearchNearTextForbidden) Code() int

Code gets the status code for the search near text forbidden response

func (*SearchNearTextForbidden) Error

func (o *SearchNearTextForbidden) Error() string

func (*SearchNearTextForbidden) GetPayload

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

func (*SearchNearTextForbidden) IsClientError

func (o *SearchNearTextForbidden) IsClientError() bool

IsClientError returns true when this search near text forbidden response has a 4xx status code

func (*SearchNearTextForbidden) IsCode

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

IsCode returns true when this search near text forbidden response a status code equal to that given

func (*SearchNearTextForbidden) IsRedirect

func (o *SearchNearTextForbidden) IsRedirect() bool

IsRedirect returns true when this search near text forbidden response has a 3xx status code

func (*SearchNearTextForbidden) IsServerError

func (o *SearchNearTextForbidden) IsServerError() bool

IsServerError returns true when this search near text forbidden response has a 5xx status code

func (*SearchNearTextForbidden) IsSuccess

func (o *SearchNearTextForbidden) IsSuccess() bool

IsSuccess returns true when this search near text forbidden response has a 2xx status code

func (*SearchNearTextForbidden) String

func (o *SearchNearTextForbidden) String() string

type SearchNearTextInternalServerError

type SearchNearTextInternalServerError struct {
	Payload *models.ErrorResponse
}

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

An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.

func NewSearchNearTextInternalServerError

func NewSearchNearTextInternalServerError() *SearchNearTextInternalServerError

NewSearchNearTextInternalServerError creates a SearchNearTextInternalServerError with default headers values

func (*SearchNearTextInternalServerError) Code

Code gets the status code for the search near text internal server error response

func (*SearchNearTextInternalServerError) Error

func (*SearchNearTextInternalServerError) GetPayload

func (*SearchNearTextInternalServerError) IsClientError

func (o *SearchNearTextInternalServerError) IsClientError() bool

IsClientError returns true when this search near text internal server error response has a 4xx status code

func (*SearchNearTextInternalServerError) IsCode

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

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

func (*SearchNearTextInternalServerError) IsRedirect

func (o *SearchNearTextInternalServerError) IsRedirect() bool

IsRedirect returns true when this search near text internal server error response has a 3xx status code

func (*SearchNearTextInternalServerError) IsServerError

func (o *SearchNearTextInternalServerError) IsServerError() bool

IsServerError returns true when this search near text internal server error response has a 5xx status code

func (*SearchNearTextInternalServerError) IsSuccess

func (o *SearchNearTextInternalServerError) IsSuccess() bool

IsSuccess returns true when this search near text internal server error response has a 2xx status code

func (*SearchNearTextInternalServerError) String

type SearchNearTextNotFound

type SearchNearTextNotFound struct {
	Payload *models.ErrorResponse
}

SearchNearTextNotFound describes a response with status code 404, with default header values.

Unknown collection or tenant.

func NewSearchNearTextNotFound

func NewSearchNearTextNotFound() *SearchNearTextNotFound

NewSearchNearTextNotFound creates a SearchNearTextNotFound with default headers values

func (*SearchNearTextNotFound) Code

func (o *SearchNearTextNotFound) Code() int

Code gets the status code for the search near text not found response

func (*SearchNearTextNotFound) Error

func (o *SearchNearTextNotFound) Error() string

func (*SearchNearTextNotFound) GetPayload

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

func (*SearchNearTextNotFound) IsClientError

func (o *SearchNearTextNotFound) IsClientError() bool

IsClientError returns true when this search near text not found response has a 4xx status code

func (*SearchNearTextNotFound) IsCode

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

IsCode returns true when this search near text not found response a status code equal to that given

func (*SearchNearTextNotFound) IsRedirect

func (o *SearchNearTextNotFound) IsRedirect() bool

IsRedirect returns true when this search near text not found response has a 3xx status code

func (*SearchNearTextNotFound) IsServerError

func (o *SearchNearTextNotFound) IsServerError() bool

IsServerError returns true when this search near text not found response has a 5xx status code

func (*SearchNearTextNotFound) IsSuccess

func (o *SearchNearTextNotFound) IsSuccess() bool

IsSuccess returns true when this search near text not found response has a 2xx status code

func (*SearchNearTextNotFound) String

func (o *SearchNearTextNotFound) String() string

type SearchNearTextOK

type SearchNearTextOK struct {
	Payload *models.SearchResponse
}

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

Search performed successfully.

func NewSearchNearTextOK

func NewSearchNearTextOK() *SearchNearTextOK

NewSearchNearTextOK creates a SearchNearTextOK with default headers values

func (*SearchNearTextOK) Code

func (o *SearchNearTextOK) Code() int

Code gets the status code for the search near text o k response

func (*SearchNearTextOK) Error

func (o *SearchNearTextOK) Error() string

func (*SearchNearTextOK) GetPayload

func (o *SearchNearTextOK) GetPayload() *models.SearchResponse

func (*SearchNearTextOK) IsClientError

func (o *SearchNearTextOK) IsClientError() bool

IsClientError returns true when this search near text o k response has a 4xx status code

func (*SearchNearTextOK) IsCode

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

IsCode returns true when this search near text o k response a status code equal to that given

func (*SearchNearTextOK) IsRedirect

func (o *SearchNearTextOK) IsRedirect() bool

IsRedirect returns true when this search near text o k response has a 3xx status code

func (*SearchNearTextOK) IsServerError

func (o *SearchNearTextOK) IsServerError() bool

IsServerError returns true when this search near text o k response has a 5xx status code

func (*SearchNearTextOK) IsSuccess

func (o *SearchNearTextOK) IsSuccess() bool

IsSuccess returns true when this search near text o k response has a 2xx status code

func (*SearchNearTextOK) String

func (o *SearchNearTextOK) String() string

type SearchNearTextParams

type SearchNearTextParams struct {

	/* Body.

	   The near-text search request.
	*/
	Body *models.SearchNearTextRequest

	/* Collection.

	   The name (or alias) of the collection to search. A lowercase first letter is normalized to the canonical uppercase form.
	*/
	Collection string

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

SearchNearTextParams contains all the parameters to send to the API endpoint

for the search near text operation.

Typically these are written to a http.Request.

func NewSearchNearTextParams

func NewSearchNearTextParams() *SearchNearTextParams

NewSearchNearTextParams creates a new SearchNearTextParams 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 NewSearchNearTextParamsWithContext

func NewSearchNearTextParamsWithContext(ctx context.Context) *SearchNearTextParams

NewSearchNearTextParamsWithContext creates a new SearchNearTextParams object with the ability to set a context for a request.

func NewSearchNearTextParamsWithHTTPClient

func NewSearchNearTextParamsWithHTTPClient(client *http.Client) *SearchNearTextParams

NewSearchNearTextParamsWithHTTPClient creates a new SearchNearTextParams object with the ability to set a custom HTTPClient for a request.

func NewSearchNearTextParamsWithTimeout

func NewSearchNearTextParamsWithTimeout(timeout time.Duration) *SearchNearTextParams

NewSearchNearTextParamsWithTimeout creates a new SearchNearTextParams object with the ability to set a timeout on a request.

func (*SearchNearTextParams) SetBody

SetBody adds the body to the search near text params

func (*SearchNearTextParams) SetCollection

func (o *SearchNearTextParams) SetCollection(collection string)

SetCollection adds the collection to the search near text params

func (*SearchNearTextParams) SetContext

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

SetContext adds the context to the search near text params

func (*SearchNearTextParams) SetDefaults

func (o *SearchNearTextParams) SetDefaults()

SetDefaults hydrates default values in the search near text params (not the query body).

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

func (*SearchNearTextParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the search near text params

func (*SearchNearTextParams) SetTimeout

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

SetTimeout adds the timeout to the search near text params

func (*SearchNearTextParams) WithBody

WithBody adds the body to the search near text params

func (*SearchNearTextParams) WithCollection

func (o *SearchNearTextParams) WithCollection(collection string) *SearchNearTextParams

WithCollection adds the collection to the search near text params

func (*SearchNearTextParams) WithContext

WithContext adds the context to the search near text params

func (*SearchNearTextParams) WithDefaults

func (o *SearchNearTextParams) WithDefaults() *SearchNearTextParams

WithDefaults hydrates default values in the search near text params (not the query body).

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

func (*SearchNearTextParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the search near text params

func (*SearchNearTextParams) WithTimeout

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

WithTimeout adds the timeout to the search near text params

func (*SearchNearTextParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type SearchNearTextReader

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

SearchNearTextReader is a Reader for the SearchNearText structure.

func (*SearchNearTextReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type SearchNearTextServiceUnavailable

type SearchNearTextServiceUnavailable struct {
	Payload *models.ErrorResponse
}

SearchNearTextServiceUnavailable describes a response with status code 503, with default header values.

The server is in an operational mode that blocks searches (e.g. WRITE_ONLY); retry once the server returns to normal operation.

func NewSearchNearTextServiceUnavailable

func NewSearchNearTextServiceUnavailable() *SearchNearTextServiceUnavailable

NewSearchNearTextServiceUnavailable creates a SearchNearTextServiceUnavailable with default headers values

func (*SearchNearTextServiceUnavailable) Code

Code gets the status code for the search near text service unavailable response

func (*SearchNearTextServiceUnavailable) Error

func (*SearchNearTextServiceUnavailable) GetPayload

func (*SearchNearTextServiceUnavailable) IsClientError

func (o *SearchNearTextServiceUnavailable) IsClientError() bool

IsClientError returns true when this search near text service unavailable response has a 4xx status code

func (*SearchNearTextServiceUnavailable) IsCode

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

IsCode returns true when this search near text service unavailable response a status code equal to that given

func (*SearchNearTextServiceUnavailable) IsRedirect

func (o *SearchNearTextServiceUnavailable) IsRedirect() bool

IsRedirect returns true when this search near text service unavailable response has a 3xx status code

func (*SearchNearTextServiceUnavailable) IsServerError

func (o *SearchNearTextServiceUnavailable) IsServerError() bool

IsServerError returns true when this search near text service unavailable response has a 5xx status code

func (*SearchNearTextServiceUnavailable) IsSuccess

func (o *SearchNearTextServiceUnavailable) IsSuccess() bool

IsSuccess returns true when this search near text service unavailable response has a 2xx status code

func (*SearchNearTextServiceUnavailable) String

type SearchNearTextTooManyRequests

type SearchNearTextTooManyRequests struct {
	Payload *models.ErrorResponse
}

SearchNearTextTooManyRequests describes a response with status code 429, with default header values.

The server's query rate limit was reached; retry later.

func NewSearchNearTextTooManyRequests

func NewSearchNearTextTooManyRequests() *SearchNearTextTooManyRequests

NewSearchNearTextTooManyRequests creates a SearchNearTextTooManyRequests with default headers values

func (*SearchNearTextTooManyRequests) Code

Code gets the status code for the search near text too many requests response

func (*SearchNearTextTooManyRequests) Error

func (*SearchNearTextTooManyRequests) GetPayload

func (*SearchNearTextTooManyRequests) IsClientError

func (o *SearchNearTextTooManyRequests) IsClientError() bool

IsClientError returns true when this search near text too many requests response has a 4xx status code

func (*SearchNearTextTooManyRequests) IsCode

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

IsCode returns true when this search near text too many requests response a status code equal to that given

func (*SearchNearTextTooManyRequests) IsRedirect

func (o *SearchNearTextTooManyRequests) IsRedirect() bool

IsRedirect returns true when this search near text too many requests response has a 3xx status code

func (*SearchNearTextTooManyRequests) IsServerError

func (o *SearchNearTextTooManyRequests) IsServerError() bool

IsServerError returns true when this search near text too many requests response has a 5xx status code

func (*SearchNearTextTooManyRequests) IsSuccess

func (o *SearchNearTextTooManyRequests) IsSuccess() bool

IsSuccess returns true when this search near text too many requests response has a 2xx status code

func (*SearchNearTextTooManyRequests) String

type SearchNearTextUnauthorized

type SearchNearTextUnauthorized struct {
	Payload *models.ErrorResponse
}

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

Unauthorized or invalid credentials.

func NewSearchNearTextUnauthorized

func NewSearchNearTextUnauthorized() *SearchNearTextUnauthorized

NewSearchNearTextUnauthorized creates a SearchNearTextUnauthorized with default headers values

func (*SearchNearTextUnauthorized) Code

func (o *SearchNearTextUnauthorized) Code() int

Code gets the status code for the search near text unauthorized response

func (*SearchNearTextUnauthorized) Error

func (*SearchNearTextUnauthorized) GetPayload

func (*SearchNearTextUnauthorized) IsClientError

func (o *SearchNearTextUnauthorized) IsClientError() bool

IsClientError returns true when this search near text unauthorized response has a 4xx status code

func (*SearchNearTextUnauthorized) IsCode

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

IsCode returns true when this search near text unauthorized response a status code equal to that given

func (*SearchNearTextUnauthorized) IsRedirect

func (o *SearchNearTextUnauthorized) IsRedirect() bool

IsRedirect returns true when this search near text unauthorized response has a 3xx status code

func (*SearchNearTextUnauthorized) IsServerError

func (o *SearchNearTextUnauthorized) IsServerError() bool

IsServerError returns true when this search near text unauthorized response has a 5xx status code

func (*SearchNearTextUnauthorized) IsSuccess

func (o *SearchNearTextUnauthorized) IsSuccess() bool

IsSuccess returns true when this search near text unauthorized response has a 2xx status code

func (*SearchNearTextUnauthorized) String

func (o *SearchNearTextUnauthorized) String() string

type SearchNearTextUnprocessableEntity

type SearchNearTextUnprocessableEntity struct {
	Payload *models.ErrorResponse
}

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

Either a request-schema violation (a missing required field such as `query`, or an invalid enum value), or a well-formed request that cannot run: no vectorizer module is configured for the collection, targetVector is missing on a multi-named-vector collection, certainty is used on a non-cosine index, a reserved (not yet supported) parameter is present, the tenant usage does not match the collection's multi-tenancy configuration, a where filter targets a property whose inverted index is disabled, or the experimental REST Search API is not enabled (set EXPERIMENTAL_REST_SEARCH_ENABLED=true).

func NewSearchNearTextUnprocessableEntity

func NewSearchNearTextUnprocessableEntity() *SearchNearTextUnprocessableEntity

NewSearchNearTextUnprocessableEntity creates a SearchNearTextUnprocessableEntity with default headers values

func (*SearchNearTextUnprocessableEntity) Code

Code gets the status code for the search near text unprocessable entity response

func (*SearchNearTextUnprocessableEntity) Error

func (*SearchNearTextUnprocessableEntity) GetPayload

func (*SearchNearTextUnprocessableEntity) IsClientError

func (o *SearchNearTextUnprocessableEntity) IsClientError() bool

IsClientError returns true when this search near text unprocessable entity response has a 4xx status code

func (*SearchNearTextUnprocessableEntity) IsCode

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

IsCode returns true when this search near text unprocessable entity response a status code equal to that given

func (*SearchNearTextUnprocessableEntity) IsRedirect

func (o *SearchNearTextUnprocessableEntity) IsRedirect() bool

IsRedirect returns true when this search near text unprocessable entity response has a 3xx status code

func (*SearchNearTextUnprocessableEntity) IsServerError

func (o *SearchNearTextUnprocessableEntity) IsServerError() bool

IsServerError returns true when this search near text unprocessable entity response has a 5xx status code

func (*SearchNearTextUnprocessableEntity) IsSuccess

func (o *SearchNearTextUnprocessableEntity) IsSuccess() bool

IsSuccess returns true when this search near text unprocessable entity response has a 2xx status code

func (*SearchNearTextUnprocessableEntity) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL