docs: adjust docs to new .post() behaviour

[JohannesMessner]

No description provided.

[github-actions]

Latency summary

Current PR yields:

• 😶 index QPS at 1156, delta to last 2 avg.: -2%
• 🐎🐎🐎🐎 query QPS at 51, delta to last 2 avg.: +41%
• 🐢🐢 avg flow time within 1.4672 seconds, delta to last 2 avg.: -10%
• 🐢🐢 import jina within 0.3528 seconds, delta to last 2 avg.: -11%

Breakdown

Version	Index QPS	Query QPS	Avg Flow Time (s)	Import Time (s)
current	1156	51	1.4672	0.3528
2.7.0	1195	51	1.7288	0.3509
2.6.4	1185	20	1.5656	0.4457

Backed by latency-tracking. Further commits will update this comment.

[JoanFM]

Make sure that request_size parameter is explained and considered also

[JoanFM]

Should we also explain the return_responses or we should not? Also we are missing docs about the Response object right?

[JohannesMessner]

Should we also explain the return_responses or we should not?

It is explained under 'returning results from .post()', does it need more explanation?

Also we are missing docs about the Response object right?

I need to change that, it should say DataRequest and not Response. But I don't think we wanted to only give a broad overview, without explaining every detail

[JoanFM]

Should we also explain the return_responses or we should not?

It is explained under 'returning results from .post()', does it need more explanation?

Also we are missing docs about the Response object right?

I need to change that, it should say DataRequest and not Response. But I don't think we wanted to only give a broad overview, without explaining every detail

It needs to be clear what can be found in the response object (not sure now what is the exact class). But the user needs to understand the attributes

[JoanFM]

what is meant by this?

[JoanFM]

I would mention, it allows to asyncrhonously iterate over responses as they come

[JohannesMessner]

what is meant by this?

That the async version doesn't hide its async-ness, unlike the normal client. To be honest, I don't know all the details about this async client myself, i just kept this more or less unchanged from Tobi's version. Changed it slightly, let me know if it makes more sense to you.

[JohannesMessner]

Otherwise feel free to suggest and apply changes yourself of course

[JoanFM]

@jacobowitz what is meant with client also being async?

[github-actions]

📝 Docs are deployed on https://docs-post-return--jina-docs.netlify.app 🎉