SearchRecordsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchRecordsRequest",
  "title": "SearchRecordsRequest",
  "example": {
    "fields": [
      "chunk_text"
    ],
    "query": {
      "inputs": {
        "text": "your query text"
      },
      "top_k": 10
    }
  },
  "description": "A search request for records in a specific namespace.",
  "type": "object",
  "properties": {
    "query": {
      "description": ".",
      "type": "object",
      "properties": {
        "top_k": {
          "example": 10,
          "description": "The number of similar records to return.",
          "type": "integer",
          "format": "int32"
        },
        "filter": {
          "description": "The filter to apply. You can use vector metadata to limit your search. See [Understanding metadata](https://docs.pinecone.io/guides/index-data/indexing-overview#metadata).",
          "type": "object"
        },
        "inputs": {
          "$ref": "#/components/schemas/EmbedInputs"
        },
        "vector": {
          "$ref": "#/components/schemas/SearchRecordsVector"
        },
        "id": {
          "example": "example-vector-1",
          "description": "The unique ID of the vector to be used as a query vector.",
          "type": "string",
          "maxLength": 512
        },
        "match_terms": {
          "$ref": "#/components/schemas/SearchMatchTerms"
        }
      },
      "required": [
        "top_k"
      ]
    },
    "fields": {
      "example": [
        "chunk_text"
      ],
      "description": "The fields to return in the search results. If not specified, the response will include all fields.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 100
    },
    "rerank": {
      "description": "Parameters for reranking the initial search results.",
      "type": "object",
      "properties": {
        "model": {
          "example": "bge-reranker-v2-m3",
          "description": "The name of the [reranking model](https://docs.pinecone.io/guides/search/rerank-results#reranking-models) to use.",
          "type": "string"
        },
        "rank_fields": {
          "example": [
            "chunk_text",
            "title"
          ],
          "description": "The field(s) to consider for reranking. If not provided, the default is `[\"text\"]`.\n\nThe number of fields supported is [model-specific](https://docs.pinecone.io/guides/search/rerank-results#reranking-models).\n",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "top_n": {
          "example": 5,
          "description": "The number of top results to return after reranking. Defaults to top_k.",
          "type": "integer",
          "format": "int32"
        },
        "parameters": {
          "example": {
            "truncate": "END"
          },
          "description": "Additional model-specific parameters. Refer to the [model guide](https://docs.pinecone.io/guides/search/rerank-results#reranking-models) for available model parameters.",
          "type": "object",
          "additionalProperties": true
        },
        "query": {
          "example": "What is the capital of France?",
          "description": "The query to rerank documents against. If a specific rerank query is specified,  it overwrites the query input that was provided at the top level.",
          "type": "string"
        }
      },
      "required": [
        "model",
        "rank_fields"
      ]
    }
  },
  "required": [
    "query"
  ]
}