> ## 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 referenceable entities for mentions > Searches across all configured entity types in parallel and returns the top N matches per type. Used by the note editor's `@`-mention typeahead to look up equipment, shipments, customers, waybills, work orders, invoices, etc. by identifier or display text. ## OpenAPI ````yaml /user-docs/api-reference/service.swagger.json post /v1/notes/search-references 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-references: post: tags: - LindaService summary: Search referenceable entities for mentions description: >- Searches across all configured entity types in parallel and returns the top N matches per type. Used by the note editor's `@`-mention typeahead to look up equipment, shipments, customers, waybills, work orders, invoices, etc. by identifier or display text. operationId: SearchReferences 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/lindaSearchReferencesReq' description: >- Request for the `@`-mention typeahead. Searches across configured entity types in parallel and returns the top N matches per type. Use the result fields to construct the inline `<>` token in your note's `content` and the matching `NoteReference` entry in `references`. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/lindaSearchReferencesResp' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. security: - ApiKeyAuth: [] AssumeUserAuth: [] components: schemas: lindaSearchReferencesReq: description: |- Request for the `@`-mention typeahead. Searches across configured entity types in parallel and returns the top N matches per type. Use the result fields to construct the inline `<>` token in your note's `content` and the matching `NoteReference` entry in `references`. properties: entity_types: description: |- Restrict to specific entity types. Empty array searches every searchable type. Pass e.g. `["equipment", "shipment"]` to scope. items: type: string type: array limit: description: Per-type result cap. Defaults to 5. format: int64 type: integer query: description: |- Free-text query — typically the characters typed after `@` in the editor (e.g. `BNSF 543`, `acme`, `WB-1842`). type: string type: object lindaSearchReferencesResp: properties: results: description: |- Top matches across all (or the requested) entity types. Per-type results are flattened and sorted by score; clients typically re-group by `entity_type` for display. items: $ref: '#/components/schemas/lindaReferenceSearchResultEntry' type: array type: object rpcStatus: properties: code: format: int32 type: integer details: items: $ref: '#/components/schemas/protobufAny' type: array message: type: string type: object lindaReferenceSearchResultEntry: description: |- One match from `SearchReferences`. The fields map directly onto a `NoteReference`: copy `entity_type`, `entity_id`, and `display_text` when building a request to `CreateNote`/`UpdateNote`, and embed the inline token `<>` in the note `content` at the cursor position. properties: display_text: description: |- Primary label for the chip (e.g. `BNSF 54321`, `Acme Corp`). Copy verbatim into `NoteReference.display_text`. type: string entity_id: description: >- ID of the matched entity. Copy verbatim into `NoteReference.entity_id`. type: string entity_type: description: >- Type of the matched entity (e.g. `equipment`, `shipment`, `customer`). Copy verbatim into `NoteReference.entity_type`. type: string score: description: |- Provider-supplied relevance score (higher = better match). Results are returned in descending score order. format: float type: number subtitle: description: |- Secondary line shown under `display_text` in the typeahead (e.g. equipment ICHR time, carrier code, or grouping type). type: string url: description: Optional pre-resolved URL for the entity's detail page. type: string 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 ````