Skip to content

Commit f8da2d0

Browse files
authored
Add migration guide for C# (Azure#51023)
* Add migration guide * Fix change log and API refrences
1 parent 7098a2c commit f8da2d0

File tree

5 files changed

+671
-0
lines changed

5 files changed

+671
-0
lines changed

sdk/ai/Azure.AI.Agents.Persistent/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
### Features Added
66

7+
- Expose the `GetVectorStoreFileBatchFiles` and `GetVectorStoreFileBatchFilesAsync` methods.
8+
79
### Breaking Changes
810

911
### Bugs Fixed

sdk/ai/Azure.AI.Agents.Persistent/api/Azure.AI.Agents.Persistent.net8.0.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2917,6 +2917,8 @@ protected VectorStores() { }
29172917
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFile>> GetVectorStoreFileAsync(string vectorStoreId, string fileId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29182918
public virtual Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch> GetVectorStoreFileBatch(string vectorStoreId, string batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29192919
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch>> GetVectorStoreFileBatchAsync(string vectorStoreId, string batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
2920+
public virtual Azure.Pageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFileBatchFiles(string vectorStoreId, string batchId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default(Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter?), int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
2921+
public virtual Azure.AsyncPageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFileBatchFilesAsync(string vectorStoreId, string batchId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default(Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter?), int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29202922
public virtual Azure.Pageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFiles(string vectorStoreId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default(Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter?), int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29212923
public virtual Azure.AsyncPageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFilesAsync(string vectorStoreId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default(Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter?), int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29222924
public virtual Azure.Pageable<Azure.AI.Agents.Persistent.PersistentAgentsVectorStore> GetVectorStores(int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }

sdk/ai/Azure.AI.Agents.Persistent/api/Azure.AI.Agents.Persistent.netstandard2.0.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2917,6 +2917,8 @@ protected VectorStores() { }
29172917
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFile>> GetVectorStoreFileAsync(string vectorStoreId, string fileId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29182918
public virtual Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch> GetVectorStoreFileBatch(string vectorStoreId, string batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29192919
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch>> GetVectorStoreFileBatchAsync(string vectorStoreId, string batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
2920+
public virtual Azure.Pageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFileBatchFiles(string vectorStoreId, string batchId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default(Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter?), int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
2921+
public virtual Azure.AsyncPageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFileBatchFilesAsync(string vectorStoreId, string batchId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default(Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter?), int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29202922
public virtual Azure.Pageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFiles(string vectorStoreId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default(Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter?), int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29212923
public virtual Azure.AsyncPageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFilesAsync(string vectorStoreId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default(Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter?), int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
29222924
public virtual Azure.Pageable<Azure.AI.Agents.Persistent.PersistentAgentsVectorStore> GetVectorStores(int? limit = default(int?), Azure.AI.Agents.Persistent.ListSortOrder? order = default(Azure.AI.Agents.Persistent.ListSortOrder?), string after = null, string before = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }

sdk/ai/Azure.AI.Agents.Persistent/src/Custom/VectorStores.cs

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,56 @@ public virtual Response<VectorStoreFileBatch> CancelVectorStoreFileBatch(string
238238
return _batchFileClient.CancelVectorStoreFileBatch(vectorStoreId: vectorStoreId, batchId: batchId, cancellationToken: cancellationToken);
239239
}
240240

241+
/// <summary> Returns a list of vector store files in a batch. </summary>
242+
/// <param name="vectorStoreId"> Identifier of the vector store. </param>
243+
/// <param name="batchId"> Identifier of the file batch. </param>
244+
/// <param name="filter"> Filter by file status. </param>
245+
/// <param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
246+
/// <param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
247+
/// <param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
248+
/// <param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
249+
/// <param name="cancellationToken"> The cancellation token to use. </param>
250+
/// <exception cref="ArgumentNullException"> <paramref name="vectorStoreId"/> or <paramref name="batchId"/> is null. </exception>
251+
/// <exception cref="ArgumentException"> <paramref name="vectorStoreId"/> or <paramref name="batchId"/> is an empty string, and was expected to be non-empty. </exception>
252+
public virtual AsyncPageable<VectorStoreFile> GetVectorStoreFileBatchFilesAsync(string vectorStoreId, string batchId, VectorStoreFileStatusFilter? filter = null, int? limit = null, ListSortOrder? order = null, string after = null, string before = null, CancellationToken cancellationToken = default)
253+
{
254+
return _batchFileClient.GetVectorStoreFileBatchFilesAsync(
255+
vectorStoreId: vectorStoreId,
256+
batchId: batchId,
257+
filter: filter,
258+
limit: limit,
259+
order: order,
260+
after: after,
261+
before: before,
262+
cancellationToken: cancellationToken
263+
);
264+
}
265+
266+
/// <summary> Returns a list of vector store files in a batch. </summary>
267+
/// <param name="vectorStoreId"> Identifier of the vector store. </param>
268+
/// <param name="batchId"> Identifier of the file batch. </param>
269+
/// <param name="filter"> Filter by file status. </param>
270+
/// <param name="limit"> A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. </param>
271+
/// <param name="order"> Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. </param>
272+
/// <param name="after"> A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. </param>
273+
/// <param name="before"> A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. </param>
274+
/// <param name="cancellationToken"> The cancellation token to use. </param>
275+
/// <exception cref="ArgumentNullException"> <paramref name="vectorStoreId"/> or <paramref name="batchId"/> is null. </exception>
276+
/// <exception cref="ArgumentException"> <paramref name="vectorStoreId"/> or <paramref name="batchId"/> is an empty string, and was expected to be non-empty. </exception>
277+
public virtual Pageable<VectorStoreFile> GetVectorStoreFileBatchFiles(string vectorStoreId, string batchId, VectorStoreFileStatusFilter? filter = null, int? limit = null, ListSortOrder? order = null, string after = null, string before = null, CancellationToken cancellationToken = default)
278+
{
279+
return _batchFileClient.GetVectorStoreFileBatchFiles(
280+
vectorStoreId: vectorStoreId,
281+
batchId: batchId,
282+
filter: filter,
283+
limit: limit,
284+
order: order,
285+
after: after,
286+
before: before,
287+
cancellationToken: cancellationToken
288+
);
289+
}
290+
241291
////////////////////////////////////////////////////////////////////////////
242292
// File client methods
243293
////////////////////////////////////////////////////////////////////////////

0 commit comments

Comments
 (0)