DocumentsClient Class

A client for interacting with the Documents API.

Definition

Namespace: GenerativeAI.Clients
Assembly: GenerativeAI (in GenerativeAI.dll) Version: 2.0.2+aa51399cad6d90cc71158d589a6268608b3c1893
C#
public class DocumentsClient : BaseClient
Inheritance
Object    ApiBase    BaseClient    DocumentsClient

Constructors

DocumentsClientInitializes a new instance of the DocumentsClient class

Properties

HttpClient
(Inherited from ApiBase)
Logger
(Inherited from ApiBase)
Platform
(Inherited from BaseClient)
SerializerOptions JSON serialization options used for API requests and responses.
(Inherited from ApiBase)

Methods

AddAuthorizationHeader
(Overrides BaseClientAddAuthorizationHeader(HttpRequestMessage, Boolean, CancellationToken))
CheckAndHandleErrors
(Inherited from ApiBase)
CreateDocumentAsync Creates a new Document resource.
DeleteAsync Sends a DELETE request to the specified URL.
(Inherited from ApiBase)
DeleteDocumentAsync Deletes a Document resource.
DeserializeT(HttpResponseMessage) Deserializes a JSON string into an object of the specified type.
(Inherited from ApiBase)
DeserializeT(String) Deserializes a JSON string into an object of the specified type.
(Inherited from ApiBase)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetAsyncT Sends a GET request to the specified URL.
(Inherited from ApiBase)
GetDocumentAsync Gets information about a specific Document resource.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
ListDocumentsAsync Lists all Document resources in a Corpus.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
QueryDocumentAsync Performs semantic search over a Document.
SendAsyncTRequest, TResponse Sends an HTTP request (e.g., POST, PUT, or PATCH) to the specified URL.
(Inherited from ApiBase)
StreamAsyncTRequest, TResponse Streams responses by sending an HTTP request with a JSON payload and yielding the deserialized items as they arrive.
(Inherited from ApiBase)
ToStringReturns a string that represents the current object.
(Inherited from Object)
UpdateDocumentAsync Updates a Document resource.
UploadFileWithProgressAsync(String, String, ActionDouble, DictionaryString, String, CancellationToken) Uploads a file to the specified URL with progress reporting.
(Inherited from ApiBase)
UploadFileWithProgressAsync(Stream, String, String, String, ActionDouble, DictionaryString, String, CancellationToken)
(Inherited from ApiBase)

Fields

_platform
(Inherited from BaseClient)

See Also