Skip to content
Wink

Query Property Embeddings

POST
/api/property-embeddings/external/query
 
curl --request POST \
  --url https://api.wink.travel/api/property-embeddings/external/query \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Query the vector store for a property using an external identifier. Results are filtered to PUBLIC sensitivity only.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Request Body required

Section titled “Request Body required ”
Media type application/json

Query property embeddings using an external identifier

object
namespace
required

Identifier namespace

string
""
Allowed values: HOTEL_CODE URL_NAME PLACE_ID PARTNER
externalId
required

External identifier value

string
"" >= 1 characters
Example 
IN00011
query
required

Natural language query

string
"" >= 1 characters
Example 
What amenities does this hotel offer?
topK

Number of results

integer format: int32
default: 5 >= 1 <= 20
factTypes

Optional fact type filter

Array<string>
""
Allowed values: HOTEL_DESCRIPTION AMENITY EXPERIENCE INVENTORY POLICY LOCATION GUEST_REVIEW RATE_SUMMARY SOCIAL_POST_GENERATED STAFF_NOTE COMPETITOR_INSIGHT PARTNER_KNOWLEDGE PARTNER_LOCAL_INSIGHT

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
Array<object>
object
key
additional properties
Example generated
[
  {
    "additionalProperty": "example"
  }
]

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}