@@ -51,7 +51,8 @@ methods:
51
51
unique_key_policy: Dict[str, Any] | None = None, conflict_resolution_policy: Dict[str,
52
52
Any] | None = None, *, session_token: str | None = None, initial_headers: Dict[str,
53
53
str] | None = None, etag: str | None = None, match_condition: MatchConditions
54
- | None = None, analytical_storage_ttl: int | None = None, **kwargs: Any) -> ContainerProxy'
54
+ | None = None, analytical_storage_ttl: int | None = None, vector_embedding_policy:
55
+ Dict[str, Any] | None = None, **kwargs: Any) -> ContainerProxy'
55
56
parameters :
56
57
- name : id
57
58
description : ID (name) of container to create.
@@ -133,6 +134,15 @@ methods:
133
134
*here: https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/query/computed-properties?tabs=dotnet*'
134
135
types :
135
136
- <xref:typing.List>[<xref:typing.Dict>[<xref:str>, <xref:str>]]
137
+ - name : vector_embedding_policy
138
+ description : ' **provisional** The vector embedding policy for the container.
139
+
140
+ Each vector embedding possesses a predetermined number of dimensions, is associated
141
+ with an underlying
142
+
143
+ data type, and is generated for a particular distance function.'
144
+ types :
145
+ - <xref:typing.Dict>[<xref:str>, <xref:typing.Any>]
136
146
return :
137
147
description : A *ContainerProxy* instance representing the new container.
138
148
types :
@@ -145,7 +155,7 @@ methods:
145
155
\ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
146
156
dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
147
157
\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ \
148
- 37\\\\ azure-cosmos-4.6 .0\\\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" \
158
+ 37\\\\ azure-cosmos-4.7 .0\\\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" \
149
159
, \" force\" : false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" \
150
160
: 1}, \" linenos\" : false} -->\n\n ````python\n\n container_name = \" products\" \
151
161
\n try:\n container = database.create_container(\n id=container_name,\
@@ -155,7 +165,7 @@ methods:
155
165
\ key:<!--[!code-python[Main](les\\ examples.py )]-->\n\n <!-- literal_block {\" \
156
166
ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" : [], \" backrefs\" : [],\
157
167
\ \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\\\ Python\\\\ 3.11.9\\\\ x64\\\\ \
158
- Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 37\\\\ azure-cosmos-4.6 .0\\\\ \
168
+ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 37\\\\ azure-cosmos-4.7 .0\\\\ \
159
169
samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" , \" force\" : false, \" language\" \
160
170
: \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" linenos\" : false} -->\n \
161
171
\n ````python\n\n customer_container_name = \" customers\"\n try:\n customer_container\
@@ -179,30 +189,45 @@ methods:
179
189
| None = None, unique_key_policy: Dict[str, Any] | None = None, conflict_resolution_policy:
180
190
Dict[str, Any] | None = None, *, session_token: str | None = None, initial_headers:
181
191
Dict[str, str] | None = None, etag: str | None = None, match_condition: MatchConditions
182
- | None = None, analytical_storage_ttl: int | None = None, **kwargs: Any) -> ContainerProxy'
192
+ | None = None, analytical_storage_ttl: int | None = None, vector_embedding_policy:
193
+ Dict[str, Any] | None = None, **kwargs: Any) -> ContainerProxy'
183
194
parameters :
184
195
- name : id
185
- description : ID (name) of container to read or create.
196
+ description : ID (name) of container to create.
186
197
isRequired : true
198
+ types :
199
+ - <xref:str>
187
200
- name : partition_key
188
201
description : The partition key to use for the container.
189
202
isRequired : true
203
+ types :
204
+ - <xref:azure.cosmos.PartitionKey>
190
205
- name : indexing_policy
191
206
description : The indexing policy to apply to the container.
192
207
isRequired : true
208
+ types :
209
+ - <xref:typing.Dict>[<xref:str>, <xref:typing.Any>]
193
210
- name : default_ttl
194
- description : Default time to live (TTL) for items in the container. If unspecified ,
211
+ description : Default time to live (TTL) for items in the container. If unused ,
195
212
items do not expire.
196
213
isRequired : true
214
+ types :
215
+ - <xref:int>
197
216
- name : offer_throughput
198
217
description : The provisioned throughput for this offer.
199
218
isRequired : true
219
+ types :
220
+ - <xref:typing.Union>[<xref:int>, <xref:azure.cosmos.ThroughputProperties>]
200
221
- name : unique_key_policy
201
222
description : The unique key policy to apply to the container.
202
223
isRequired : true
224
+ types :
225
+ - <xref:typing.Dict>[<xref:str>, <xref:typing.Any>]
203
226
- name : conflict_resolution_policy
204
227
description : The conflict resolution policy to apply to the container.
205
228
isRequired : true
229
+ types :
230
+ - <xref:typing.Dict>[<xref:str>, <xref:typing.Any>]
206
231
keywordOnlyParameters :
207
232
- name : session_token
208
233
description : Token for use with Session consistency.
@@ -247,6 +272,15 @@ methods:
247
272
*here: https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/query/computed-properties?tabs=dotnet*'
248
273
types :
249
274
- <xref:typing.List>[<xref:typing.Dict>[<xref:str>, <xref:str>]]
275
+ - name : vector_embedding_policy
276
+ description : ' The vector embedding policy for the container. Each vector
277
+
278
+ embedding possesses a predetermined number of dimensions, is associated with
279
+ an underlying data type, and
280
+
281
+ is generated for a particular distance function.'
282
+ types :
283
+ - <xref:typing.Dict>[<xref:str>, <xref:typing.Any>]
250
284
return :
251
285
description : A *ContainerProxy* instance representing the container.
252
286
types :
@@ -289,7 +323,7 @@ methods:
289
323
- " Create a database user:<!--[!code-python[Main](les\\ examples.py )]-->\n\n <!--\
290
324
\ literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" : [],\
291
325
\ \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\\\ Python\\ \
292
- \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 37\\\\ azure-cosmos-4.6 .0\\ \
326
+ \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 37\\\\ azure-cosmos-4.7 .0\\ \
293
327
\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" , \" force\" : false, \" \
294
328
language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" linenos\" \
295
329
: false} -->\n\n ````python\n\n try:\n database.create_user(dict(id=\" \
@@ -398,7 +432,7 @@ methods:
398
432
examples.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" \
399
433
: [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\ \
400
434
\\ windows\\\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\ \
401
- \\ 37\\\\ azure-cosmos-4.6 .0\\\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" \
435
+ \\ 37\\\\ azure-cosmos-4.7 .0\\\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" \
402
436
, \" force\" : false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" \
403
437
: 1}, \" linenos\" : false} -->\n\n ````python\n\n database = client.get_database_client(database_name)\n \
404
438
\ container = database.get_container_client(container_name)\n\n ````\n "
@@ -474,7 +508,7 @@ methods:
474
508
\ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
475
509
dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
476
510
\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ \
477
- 37\\\\ azure-cosmos-4.6 .0\\\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" \
511
+ 37\\\\ azure-cosmos-4.7 .0\\\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" \
478
512
, \" force\" : false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" \
479
513
: 1}, \" linenos\" : false} -->\n\n ````python\n\n database = client.get_database_client(database_name)\n \
480
514
\ for container in database.list_containers():\n print(\" Container ID:\
@@ -713,7 +747,7 @@ methods:
713
747
examples.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" \
714
748
: [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\ \
715
749
\\ windows\\\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\ \
716
- \\ 37\\\\ azure-cosmos-4.6 .0\\\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" \
750
+ \\ 37\\\\ azure-cosmos-4.7 .0\\\\ samples\\\\ examples.py\" , \" xml:space\" : \" preserve\" \
717
751
, \" force\" : false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" \
718
752
: 1}, \" linenos\" : false} -->\n\n ````python\n\n # Set the TTL on the container\
719
753
\ to 3600 seconds (one hour)\n database.replace_container(container, partition_key=PartitionKey(path='/productName'),\
0 commit comments