Azure / Azure/azure-sdk-for-python
azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest exposes max_output_documents in docs, but nothing on documentation
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 3.4k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 193
Description
### Type of issue
Code doesn't work
### Description
Trying to query an Az AI Search KnowledgeBase, using **max_output_documents** parameter (see attached image). It doesn't work, responses are restricted to 8 items in output list.
Further, this option and a host of other options from this screenshot are not even visible in documentation at: [KnowledgeBaseRetrievalRequest Class](https://learn.microsoft.com/en-us/python/api/azure-search-documents/azure.search.documents.knowledgebases.models.knowledgebaseretrievalrequest?view=azure-python)
We are using
> azure-search-documents 12.1.0b1
### Page URL
https://learn.microsoft.com/en-us/python/api/azure-search-documents/azure.search.documents.knowledgebases.models.knowledgebaseretrievalrequest?view=azure-python
### Content source URL
https://github.com/MicrosoftDocs/azure-docs-sdk-python/blob/main/docs-ref-autogen/azure-search-documents/azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.yml
### Document Version Independent Id
a41b5505-fffb-320a-4896-4f3cf7523d13
### Platform Id
9fd583f0-23f7-3148-e325-b2d4037397cc
### Article author
@lmazuel
### Metadata
* ID: 0fb3656f-e3c9-38d5-f7f4-e7f454536535
* PlatformId: 9fd583f0-23f7-3148-e325-b2d4037397cc
Contributor guide
Research direction
Start with the KnowledgeBaseRetrievalRequest documentation page and its content source, docs-ref-autogen/azure-search-documents/azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.yml. Compare the documented properties with azure-search-documents 12.1.0b1, focusing on max_output_documents and the other options shown in the report. Done means the available request options are accurately exposed in the generated documentation and the reported eight-item behavior is clarified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100