`search_documents`

Search documents · salt-okunur

Find passages inside disclosure attachments and return short snippets with page numbers
    and source_url instead of whole documents. Use for 'what does the report say about X'.

Parametreler

ad	tip	zorunlu	varsayılan	açıklama
`query`	`string` minLength=2	evet	—	Words to find (any word matches; Turkish-insensitive)
`disclosure_id`	`integer`	—	—	Search all attachments of this disclosure
`attachment_id`	`string`	—	—	…or a single attachment
`max_results`	`integer` maximum=50, minimum=1	—	`10`
`context_chars`	`integer` maximum=2000, minimum=80	—	`300`	Snippet length around each match

Girdi şeması

{
  "properties": {
    "query": {
      "description": "Words to find (any word matches; Turkish-insensitive)",
      "minLength": 2,
      "title": "Query",
      "type": "string"
    },
    "disclosure_id": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Search all attachments of this disclosure",
      "title": "Disclosure Id"
    },
    "attachment_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "…or a single attachment",
      "title": "Attachment Id"
    },
    "max_results": {
      "default": 10,
      "maximum": 50,
      "minimum": 1,
      "title": "Max Results",
      "type": "integer"
    },
    "context_chars": {
      "default": 300,
      "description": "Snippet length around each match",
      "maximum": 2000,
      "minimum": 80,
      "title": "Context Chars",
      "type": "integer"
    }
  },
  "required": [
    "query"
  ],
  "title": "search_documentsArguments",
  "type": "object"
}

Çıktı şeması

{
  "additionalProperties": true,
  "title": "search_documentsDictOutput",
  "type": "object"
}