PersistentAgentsClient Class

Package:

com.azure.ai.agents.persistent

Maven Artifact:

com.azure:azure-ai-agents-persistent:1.0.0-beta.2

• java.lang.Object
• • com.azure.ai.agents.persistent.PersistentAgentsClient

public final class PersistentAgentsClient

Initializes a new instance of the synchronous PersistentAgentsClient type.

Method Summary

Modifier and Type	Method and Description
ThreadRun	createThreadAndRun(CreateThreadAndRunOptions options) Creates a new agent thread and immediately starts a run using that new thread.
Response<BinaryData>	createThreadAndRunWithResponse(BinaryData createThreadAndRunRequest, RequestOptions requestOptions) Creates a new agent thread and immediately starts a run using that new thread.
FilesClient	getFilesClient() Gets an instance of FilesClient class.
MessagesClient	getMessagesClient() Gets an instance of MessagesClient class.
PersistentAgentsAdministrationClient	getPersistentAgentsAdministrationClient() Gets an instance of PersistentAgentsAdministrationClient class.
RunsClient	getRunsClient() Gets an instance of RunsClient class.
ThreadsClient	getThreadsClient() Gets an instance of ThreadsClient class.
VectorStoresClient	getVectorStoresClient() Gets an instance of VectorStoresClient class.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createThreadAndRun

public ThreadRun createThreadAndRun(CreateThreadAndRunOptions options)

Creates a new agent thread and immediately starts a run using that new thread.

Parameters:

options - Options for createThreadAndRun API.

Returns:

data representing a single evaluation run of an agent thread.

createThreadAndRunWithResponse

public Response<BinaryData> createThreadAndRunWithResponse(BinaryData createThreadAndRunRequest, RequestOptions requestOptions)

Creates a new agent thread and immediately starts a run using that new thread.

Request Body Schema

{
     assistant_id: String (Required)
     thread (Optional): {
         messages (Optional): [
              (Optional){
                 role: String(user/assistant) (Required)
                 content: BinaryData (Required)
                 attachments (Optional): [
                      (Optional){
                         file_id: String (Optional)
                         data_source (Optional): {
                             uri: String (Required)
                             type: String(uri_asset/id_asset) (Required)
                         }
                         tools (Required): [
                             BinaryData (Required)
                         ]
                     }
                 ]
                 metadata (Optional): {
                     String: String (Required)
                 }
             }
         ]
         tool_resources (Optional): {
             code_interpreter (Optional): {
                 file_ids (Optional): [
                     String (Optional)
                 ]
                 data_sources (Optional): [
                     (recursive schema, see above)
                 ]
             }
             file_search (Optional): {
                 vector_store_ids (Optional): [
                     String (Optional)
                 ]
                 vector_stores (Optional): [
                      (Optional){
                         name: String (Required)
                         configuration (Required): {
                             data_sources (Required): [
                                 (recursive schema, see above)
                             ]
                         }
                     }
                 ]
             }
             azure_ai_search (Optional): {
                 indexes (Optional): [
                      (Optional){
                         index_connection_id: String (Optional)
                         index_name: String (Optional)
                         query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
                         top_k: Integer (Optional)
                         filter: String (Optional)
                         index_asset_id: String (Optional)
                     }
                 ]
             }
         }
         metadata (Optional): {
             String: String (Required)
         }
     }
     model: String (Optional)
     instructions: String (Optional)
     tools (Optional): [
          (Optional){
             type: String (Required)
         }
     ]
     tool_resources (Optional): (recursive schema, see tool_resources above)
     stream: Boolean (Optional)
     temperature: Double (Optional)
     top_p: Double (Optional)
     max_prompt_tokens: Integer (Optional)
     max_completion_tokens: Integer (Optional)
     truncation_strategy (Optional): {
         type: String(auto/last_messages) (Required)
         last_messages: Integer (Optional)
     }
     tool_choice: BinaryData (Optional)
     response_format: BinaryData (Optional)
     parallel_tool_calls: Boolean (Optional)
     metadata (Optional): {
         String: String (Required)
     }
 }

Response Body Schema

{
     id: String (Required)
     object: String (Required)
     thread_id: String (Required)
     assistant_id: String (Required)
     status: String(queued/in_progress/requires_action/cancelling/cancelled/failed/completed/expired) (Required)
     required_action (Optional): {
         type: String (Required)
     }
     last_error (Required): {
         code: String (Required)
         message: String (Required)
     }
     model: String (Required)
     instructions: String (Required)
     tools (Required): [
          (Required){
             type: String (Required)
         }
     ]
     created_at: long (Required)
     expires_at: Long (Required)
     started_at: Long (Required)
     completed_at: Long (Required)
     cancelled_at: Long (Required)
     failed_at: Long (Required)
     incomplete_details (Required): {
         reason: String(max_completion_tokens/max_prompt_tokens) (Required)
     }
     usage (Required): {
         completion_tokens: long (Required)
         prompt_tokens: long (Required)
         total_tokens: long (Required)
     }
     temperature: Double (Optional)
     top_p: Double (Optional)
     max_prompt_tokens: Integer (Required)
     max_completion_tokens: Integer (Required)
     truncation_strategy (Required): {
         type: String(auto/last_messages) (Required)
         last_messages: Integer (Optional)
     }
     tool_choice: BinaryData (Required)
     response_format: BinaryData (Required)
     metadata (Required): {
         String: String (Required)
     }
     tool_resources (Optional): {
         code_interpreter (Optional): {
             file_ids (Optional): [
                 String (Optional)
             ]
             data_sources (Optional): [
                  (Optional){
                     uri: String (Required)
                     type: String(uri_asset/id_asset) (Required)
                 }
             ]
         }
         file_search (Optional): {
             vector_store_ids (Optional): [
                 String (Optional)
             ]
             vector_stores (Optional): [
                  (Optional){
                     name: String (Required)
                     configuration (Required): {
                         data_sources (Required): [
                             (recursive schema, see above)
                         ]
                     }
                 }
             ]
         }
         azure_ai_search (Optional): {
             indexes (Optional): [
                  (Optional){
                     index_connection_id: String (Optional)
                     index_name: String (Optional)
                     query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
                     top_k: Integer (Optional)
                     filter: String (Optional)
                     index_asset_id: String (Optional)
                 }
             ]
         }
     }
     parallel_tool_calls: boolean (Required)
 }

Parameters:

createThreadAndRunRequest - The createThreadAndRunRequest parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

data representing a single evaluation run of an agent thread along with Response<T>.

getFilesClient

public FilesClient getFilesClient()

Gets an instance of FilesClient class.

Returns:

an instance of FilesClient class.

getMessagesClient

public MessagesClient getMessagesClient()

Gets an instance of MessagesClient class.

Returns:

an instance of MessagesClient class.

getPersistentAgentsAdministrationClient

public PersistentAgentsAdministrationClient getPersistentAgentsAdministrationClient()

Gets an instance of PersistentAgentsAdministrationClient class.

Returns:

an instance of PersistentAgentsAdministrationClient class.

getRunsClient

public RunsClient getRunsClient()

Gets an instance of RunsClient class.

Returns:

an instance of RunsClient class.

getThreadsClient

public ThreadsClient getThreadsClient()

Gets an instance of ThreadsClient class.

Returns:

an instance of ThreadsClient class.

getVectorStoresClient

public VectorStoresClient getVectorStoresClient()

Gets an instance of VectorStoresClient class.

Returns:

an instance of VectorStoresClient class.