docs

Search User Docs

Searches for documents associated with a specific user.

Parameters: x_developer_id (UUID): The unique identifier of the developer associated with the user. search_params (TextOnlyDocSearchRequest | VectorDocSearchRequest | HybridDocSearchRequest): The parameters for the search. user_id (UUID): The unique identifier of the user associated with the documents. Returns: DocSearchResponse: The search results.

post/users/{user_id}/search

Path parameters

user_idstring uuid required

Query parameters

{"stackTrail":"paths:/users/{user_id}/search:post:parameters:1:schema","oasType":"schema","type":"unknown","title":"Connection Pool"}

Request body

OR
OR

Response

Successful Response

timenumber required

Changes

Changed in 7 of the 44 revisions of this API.4427

    • added the new optional request property anyOf[subschema #1: TextOnlyDocSearchRequest]/include_embeddings

      new-optional-request-property

    • added the new optional request property anyOf[subschema #2: VectorDocSearchRequest]/include_embeddings

      new-optional-request-property

    • added the new optional request property anyOf[subschema #3: HybridDocSearchRequest]/include_embeddings

      new-optional-request-property

  • 55cf66f64607125See the full diff
    • the anyOf[subschema #3: HybridDocSearchRequest]/k_multiplier request property's min was increased to 1.00

      request-property-min-increased

    • the anyOf[subschema #3: HybridDocSearchRequest]/k_multiplier request property's max was set to 10.00

      request-property-max-set

    • removed the request property anyOf[subschema #2: VectorDocSearchRequest]/lang

      request-property-removed

    • the k_multiplier request property default value changed from 7 to 5

      request-property-default-value-changed

    • the trigram_similarity_threshold request property default value 0.6 was removed

      request-property-default-value-removed

    • the trigram_similarity_threshold request property default value 0.6 was removed

      request-property-default-value-removed

    • request property anyOf[subschema #1: TextOnlyDocSearchRequest]/trigram_similarity_threshold list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • request property anyOf[subschema #3: HybridDocSearchRequest]/trigram_similarity_threshold list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property anyOf[subschema #1: TextOnlyDocSearchRequest]/trigram_similarity_threshold

      new-optional-request-property

    • added the new optional request property anyOf[subschema #3: HybridDocSearchRequest]/k_multiplier

      new-optional-request-property

    • added the new optional request property anyOf[subschema #3: HybridDocSearchRequest]/trigram_similarity_threshold

      new-optional-request-property

    • the alpha request property default value changed from 0.75 to 0.5

      request-property-default-value-changed

    • the confidence request property default value changed from 0 to 0.5

      request-property-default-value-changed

    • the confidence request property default value changed from 0 to 0.5

      request-property-default-value-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4d9d1f8b357a15See the full diff
    • removed the request property anyOf[subschema #1: TextOnlyDocSearchRequest]/mmr_strength

      request-property-removed

    • the lang request property const value en-US was removed

      request-property-const-removed

    • the lang request property const value en-US was removed

      request-property-const-removed

    • the lang request property const value en-US was removed

      request-property-const-removed

    • the mmr_strength request property default value changed from 0 to 0.5

      request-property-default-value-changed

    • the mmr_strength request property default value changed from 0 to 0.5

      request-property-default-value-changed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bf9190a8aea033See the full diff
    • the lang request property const value en-US was added

      request-property-const-added

    • the lang request property const value en-US was added

      request-property-const-added

    • the lang request property const value en-US was added

      request-property-const-added

    • added the new optional request property anyOf[subschema #1: TextOnlyDocSearchRequest]/mmr_strength

      new-optional-request-property

    • the mmr_strength request property default value changed from 0.5 to 0

      request-property-default-value-changed

    • the mmr_strength request property default value changed from 0.5 to 0

      request-property-default-value-changed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the lang request property const value en-US was removed

      request-property-const-removed

    • the lang request property const value en-US was removed

      request-property-const-removed

    • the lang request property const value en-US was removed

      request-property-const-removed

  • 0ddb64e7a59812See the full diff
    • removed the request property anyOf[subschema #1: TextOnlyDocSearchRequest]/mmr_strength

      request-property-removed

    • the mmr_strength request property default value changed from 0 to 0.5

      request-property-default-value-changed

    • the mmr_strength request property default value changed from 0 to 0.5

      request-property-default-value-changed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog