> ## Documentation Index > Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt > Use this file to discover all available pages before exploring further. # Search notes (full-text) > Full-text search across all notes for the carrier, ranked by Postgres `ts_rank`. Returns ``-highlighted snippets via `ts_headline`. The index strips `<>` reference token wrappers and normalizes hashtag-group syntax (`#group(content)`) so chip text and automation-written hashtag content are searchable as plain words. ## OpenAPI ````yaml /user-docs/api-reference/service.swagger.json post /v1/notes/search openapi: 3.0.1 info: title: protobuf/linda/service.proto version: version not set servers: - description: Production (US) url: https://api.linda.cedarai.com - description: Production (EU) url: https://api.linda.cedarai.se security: [] tags: - name: LindaService paths: /v1/notes/search: post: tags: - LindaService summary: Search notes (full-text) description: >- Full-text search across all notes for the carrier, ranked by Postgres `ts_rank`. Returns ``-highlighted snippets via `ts_headline`. The index strips `<>` reference token wrappers and normalizes hashtag-group syntax (`#group(content)`) so chip text and automation-written hashtag content are searchable as plain words. operationId: SearchNotes parameters: - description: Carrier ID the request is scoped to. in: header name: Carrier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/lindaSearchNotesReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/lindaSearchNotesResp' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. security: - ApiKeyAuth: [] AssumeUserAuth: [] components: schemas: lindaSearchNotesReq: properties: entity_type: description: |- Restrict results to one entity type (e.g. `shipment`). Empty string searches all entity types for the carrier. type: string page_size: description: Page size for cursor pagination. Defaults to 20 if unset or zero. format: int32 type: integer page_token: description: Opaque cursor from a previous response's `next_page_token`. type: string query: description: |- Free-text query. Tokenized via Postgres `plainto_tsquery('english', ...)`. Entity reference chips and `#group(content)` hashtag syntax are normalized server-side so chip text and automation-written hashtag content are searchable as plain words. Empty query returns an empty result set. type: string type: object lindaSearchNotesResp: properties: next_page_token: description: |- Opaque cursor for the next page. Empty when there are no more results. Pass back as `page_token` on the next request. type: string results: description: Matching notes ordered by `score` descending. items: $ref: '#/components/schemas/lindaSearchNoteResult' type: array total_count: description: |- Total matching notes across all pages — useful for displaying "showing X of Y results" labels. format: int32 type: integer type: object rpcStatus: properties: code: format: int32 type: integer details: items: $ref: '#/components/schemas/protobufAny' type: array message: type: string type: object lindaSearchNoteResult: description: One match returned from `SearchNotes`. properties: content_snippet: description: |- Highlighted snippet from `ts_headline` containing only `` tags around matched terms. **Sanitize before rendering as HTML**: escape all other HTML, then re-allow `` tags only. type: string created_at: format: date-time type: string created_by_name: description: Display name of the note's author at the time the note was written. type: string entity_id: description: Host entity ID the note was attached to. type: string entity_type: description: Host entity type the note was attached to. type: string note_id: description: ID of the matched note. type: string score: description: Postgres `ts_rank` relevance score (higher is more relevant). format: float type: number type: object protobufAny: additionalProperties: type: object description: >- `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } properties: '@type': description: >- A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. type: string type: object securitySchemes: ApiKeyAuth: in: header name: x-arms-api-key type: apiKey AssumeUserAuth: in: header name: x-arms-assume-user type: apiKey ````