Skip to content

doc diff #43479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

doc diff #43479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 39 additions & 46 deletions sdk/ai/azure-ai-agents/azure/ai/agents/models/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# pylint: disable=line-too-long,useless-suppression,too-many-lines
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
Expand Down Expand Up @@ -922,12 +923,11 @@ class BingCustomSearchConfiguration(_Model):
strings displayed in a different language.
:vartype set_lang: str
:ivar count: The number of search results to return in the response. The default is 5 and the
maximum value is 50. The actual number delivered may be less than requested.
maximum value is 50. The actual number delivered may be less than requested.

* It is possible for multiple pages to include some overlap in results.
* This parameter affects only web page results. It's possible that AI model might not use all
search results returned by Bing.

* This parameter affects only web page results. It's possible that AI model might not use
all search results returned by Bing.
:vartype count: int
:ivar freshness: Filter search results by the following case-insensitive age values:

Expand All @@ -937,7 +937,6 @@ class BingCustomSearchConfiguration(_Model):
discovered by Bing during a specific timeframe, specify a date range in the form:
`YYYY-MM-DD..YYYY-MM-DD`. For example, `freshness=2019-02-01..2019-05-30. To limit the results
to a single date, set this parameter to a specific date. For example, freshness=2019-02-04`.

:vartype freshness: str
"""

Expand Down Expand Up @@ -978,21 +977,19 @@ class BingCustomSearchConfiguration(_Model):
count: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"])
"""The number of search results to return in the response. The default is 5 and the maximum value
is 50. The actual number delivered may be less than requested.

* It is possible for multiple pages to include some overlap in results.
* This parameter affects only web page results. It's possible that AI model might not use all
search results returned by Bing.
"""

* It is possible for multiple pages to include some overlap in results.
* This parameter affects only web page results. It's possible that AI model might not use
all search results returned by Bing."""
freshness: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"])
"""Filter search results by the following case-insensitive age values:

* Day: Return webpages that Bing discovered within the last 24 hours.
* Week: Return webpages that Bing discovered within the last 7 days.
* Month: Return webpages that Bing discovered within the last 30 days. To get articles
discovered by Bing during a specific timeframe, specify a date range in the form:
`YYYY-MM-DD..YYYY-MM-DD`. For example, `freshness=2019-02-01..2019-05-30. To limit the results
to a single date, set this parameter to a specific date. For example, freshness=2019-02-04`.
"""

* Day: Return webpages that Bing discovered within the last 24 hours.
* Week: Return webpages that Bing discovered within the last 7 days.
* Month: Return webpages that Bing discovered within the last 30 days. To get articles
discovered by Bing during a specific timeframe, specify a date range in the form:
`YYYY-MM-DD..YYYY-MM-DD`. For example, `freshness=2019-02-01..2019-05-30. To limit the results
to a single date, set this parameter to a specific date. For example, freshness=2019-02-04`."""

@overload
def __init__(
Expand Down Expand Up @@ -1123,12 +1120,11 @@ class BingGroundingSearchConfiguration(_Model):
strings displayed in a different language.
:vartype set_lang: str
:ivar count: The number of search results to return in the response. The default is 5 and the
maximum value is 50. The actual number delivered may be less than requested.
maximum value is 50. The actual number delivered may be less than requested.

* It is possible for multiple pages to include some overlap in results.
* This parameter affects only web page results. It's possible that AI model might not use all
search results returned by Bing.

* This parameter affects only web page results. It's possible that AI model might not use
all search results returned by Bing.
:vartype count: int
:ivar freshness: Filter search results by the following case-insensitive age values:

Expand All @@ -1138,7 +1134,6 @@ class BingGroundingSearchConfiguration(_Model):
discovered by Bing during a specific timeframe, specify a date range in the form:
`YYYY-MM-DD..YYYY-MM-DD`. For example, `freshness=2019-02-01..2019-05-30. To limit the results
to a single date, set this parameter to a specific date. For example, freshness=2019-02-04`.

:vartype freshness: str
"""

Expand Down Expand Up @@ -1177,21 +1172,19 @@ class BingGroundingSearchConfiguration(_Model):
count: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"])
"""The number of search results to return in the response. The default is 5 and the maximum value
is 50. The actual number delivered may be less than requested.

* It is possible for multiple pages to include some overlap in results.
* This parameter affects only web page results. It's possible that AI model might not use all
search results returned by Bing.
"""

* It is possible for multiple pages to include some overlap in results.
* This parameter affects only web page results. It's possible that AI model might not use
all search results returned by Bing."""
freshness: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"])
"""Filter search results by the following case-insensitive age values:

* Day: Return webpages that Bing discovered within the last 24 hours.
* Week: Return webpages that Bing discovered within the last 7 days.
* Month: Return webpages that Bing discovered within the last 30 days. To get articles
discovered by Bing during a specific timeframe, specify a date range in the form:
`YYYY-MM-DD..YYYY-MM-DD`. For example, `freshness=2019-02-01..2019-05-30. To limit the results
to a single date, set this parameter to a specific date. For example, freshness=2019-02-04`.
"""

* Day: Return webpages that Bing discovered within the last 24 hours.
* Week: Return webpages that Bing discovered within the last 7 days.
* Month: Return webpages that Bing discovered within the last 30 days. To get articles
discovered by Bing during a specific timeframe, specify a date range in the form:
`YYYY-MM-DD..YYYY-MM-DD`. For example, `freshness=2019-02-01..2019-05-30. To limit the results
to a single date, set this parameter to a specific date. For example, freshness=2019-02-04`."""

@overload
def __init__(
Expand Down Expand Up @@ -2388,22 +2381,22 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
class FileSearchToolDefinitionDetails(_Model):
"""Options overrides for the file search tool.

:ivar max_num_results: The maximum number of results the file search tool should output. The
default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50
inclusive.
:ivar max_num_results: The maximum number of results the file search tool should output. The
default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50
inclusive.

Note that the file search tool may output fewer than ``max_num_results`` results. See the file
search tool documentation for more information.
:vartype max_num_results: int
:ivar ranking_options: Ranking options for file search.
:vartype ranking_options: ~azure.ai.agents.models.FileSearchRankingOptions
Note that the file search tool may output fewer than ``max_num_results`` results. See the file
search tool documentation for more information.
:vartype max_num_results: int
:ivar ranking_options: Ranking options for file search.
:vartype ranking_options: ~azure.ai.agents.models.FileSearchRankingOptions
"""

max_num_results: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"])
"""The maximum number of results the file search tool should output. The default is 20 for gpt-4*
models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.
Note that the file search tool may output fewer than ``max_num_results`` results. See the file

Note that the file search tool may output fewer than ``max_num_results`` results. See the file
search tool documentation for more information."""
ranking_options: Optional["_models.FileSearchRankingOptions"] = rest_field(
visibility=["read", "create", "update", "delete", "query"]
Expand Down
Loading