Request Body Schema
+ * + *
+ * {@code
+ * {
+ * model: String (Required)
+ * name: String (Optional)
+ * description: String (Optional)
+ * instructions: String (Optional)
+ * tools (Optional): [
+ * (Optional){
+ * type: 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Optional)
+ * top_p: Double (Optional)
+ * response_format: BinaryData (Optional)
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * description: String (Required)
+ * model: String (Required)
+ * instructions: String (Required)
+ * tools (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Required)
+ * top_p: Double (Required)
+ * response_format: BinaryData (Optional)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param createAgentRequest The createAgentRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * description: String (Required)
+ * model: String (Required)
+ * instructions: String (Required)
+ * tools (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Required)
+ * top_p: Double (Required)
+ * response_format: BinaryData (Optional)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of agents that were previously created along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * description: String (Required)
+ * model: String (Required)
+ * instructions: String (Required)
+ * tools (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Required)
+ * top_p: Double (Required)
+ * response_format: BinaryData (Optional)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param assistantId Identifier of the agent.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * model: String (Optional)
+ * name: String (Optional)
+ * description: String (Optional)
+ * instructions: String (Optional)
+ * tools (Optional): [
+ * (Optional){
+ * type: 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Optional)
+ * top_p: Double (Optional)
+ * response_format: BinaryData (Optional)
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * description: String (Required)
+ * model: String (Required)
+ * instructions: String (Required)
+ * tools (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Required)
+ * top_p: Double (Required)
+ * response_format: BinaryData (Optional)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param assistantId The ID of the agent to modify.
+ * @param updateAgentRequest The updateAgentRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param assistantId Identifier of the agent.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of an agent deletion operation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param createThreadRequest The createThreadRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return information about a single thread associated with an agent along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return information about an existing thread along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId The ID of the thread to modify.
+ * @param updateThreadRequest The updateThreadRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return information about a single thread associated with an agent along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of a thread deletion operation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * thread_id: String (Required)
+ * status: String(in_progress/incomplete/completed) (Required)
+ * incomplete_details (Required): {
+ * reason: String(content_filter/max_tokens/run_cancelled/run_failed/run_expired) (Required)
+ * }
+ * completed_at: Long (Required)
+ * incomplete_at: Long (Required)
+ * role: String(user/assistant) (Required)
+ * content (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * assistant_id: String (Required)
+ * run_id: String (Required)
+ * attachments (Required): [
+ * (Required){
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * tools (Required): [
+ * BinaryData (Required)
+ * ]
+ * }
+ * ]
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param createMessageRequest The createMessageRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a single, existing message within an agent thread along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| runId | String | No | Filter messages by the run ID that generated them. |
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * thread_id: String (Required)
+ * status: String(in_progress/incomplete/completed) (Required)
+ * incomplete_details (Required): {
+ * reason: String(content_filter/max_tokens/run_cancelled/run_failed/run_expired) (Required)
+ * }
+ * completed_at: Long (Required)
+ * incomplete_at: Long (Required)
+ * role: String(user/assistant) (Required)
+ * content (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * assistant_id: String (Required)
+ * run_id: String (Required)
+ * attachments (Required): [
+ * (Required){
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * tools (Required): [
+ * BinaryData (Required)
+ * ]
+ * }
+ * ]
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of messages that exist on a thread along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * thread_id: String (Required)
+ * status: String(in_progress/incomplete/completed) (Required)
+ * incomplete_details (Required): {
+ * reason: String(content_filter/max_tokens/run_cancelled/run_failed/run_expired) (Required)
+ * }
+ * completed_at: Long (Required)
+ * incomplete_at: Long (Required)
+ * role: String(user/assistant) (Required)
+ * content (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * assistant_id: String (Required)
+ * run_id: String (Required)
+ * attachments (Required): [
+ * (Required){
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * tools (Required): [
+ * BinaryData (Required)
+ * ]
+ * }
+ * ]
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param messageId Identifier of the message.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an existing message from an existing thread along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * thread_id: String (Required)
+ * status: String(in_progress/incomplete/completed) (Required)
+ * incomplete_details (Required): {
+ * reason: String(content_filter/max_tokens/run_cancelled/run_failed/run_expired) (Required)
+ * }
+ * completed_at: Long (Required)
+ * incomplete_at: Long (Required)
+ * role: String(user/assistant) (Required)
+ * content (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * assistant_id: String (Required)
+ * run_id: String (Required)
+ * attachments (Required): [
+ * (Required){
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * tools (Required): [
+ * BinaryData (Required)
+ * ]
+ * }
+ * ]
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param messageId Identifier of the message.
+ * @param updateMessageRequest The updateMessageRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a single, existing message within an agent thread along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| include[] | List<String> | No | A list of additional fields to include in the + * response. + * Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the + * file search result content. In the form of "," separated string. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * assistant_id: String (Required)
+ * model: String (Optional)
+ * instructions: String (Optional)
+ * additional_instructions: String (Optional)
+ * additional_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)
+ * }
+ * }
+ * ]
+ * tools (Optional): [
+ * (Optional){
+ * type: String (Required)
+ * }
+ * ]
+ * 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
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param createRunRequest The createRunRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of runs for a specified thread along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an existing run from an existing thread along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param updateRunRequest The updateRunRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * tool_outputs (Required): [
+ * (Required){
+ * tool_call_id: String (Optional)
+ * output: String (Optional)
+ * }
+ * ]
+ * stream: Boolean (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param submitToolOutputsToRunRequest The submitToolOutputsToRunRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * model: String (Optional)
+ * instructions: String (Optional)
+ * tools (Optional): [
+ * (Optional){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Optional): {
+ * code_interpreter (Optional): {
+ * file_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): (recursive schema, see azure_ai_search 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
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param createThreadAndRunRequest The createThreadAndRunRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| include[] | List<String> | No | A list of additional fields to include in the + * response. + * Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the + * file search result content. In the form of "," separated string. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * type: String(message_creation/tool_calls) (Required)
+ * assistant_id: String (Required)
+ * thread_id: String (Required)
+ * run_id: String (Required)
+ * status: String(in_progress/cancelled/failed/completed/expired) (Required)
+ * step_details (Required): {
+ * type: String(message_creation/tool_calls) (Required)
+ * }
+ * last_error (Required): {
+ * code: String(server_error/rate_limit_exceeded) (Required)
+ * message: String (Required)
+ * }
+ * created_at: long (Required)
+ * expired_at: Long (Required)
+ * completed_at: Long (Required)
+ * cancelled_at: Long (Required)
+ * failed_at: Long (Required)
+ * usage (Optional): {
+ * completion_tokens: long (Required)
+ * prompt_tokens: long (Required)
+ * total_tokens: long (Required)
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param stepId Identifier of the run step.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a single run step from a thread run along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| include[] | List<String> | No | A list of additional fields to include in the + * response. + * Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the + * file search result content. In the form of "," separated string. |
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * type: String(message_creation/tool_calls) (Required)
+ * assistant_id: String (Required)
+ * thread_id: String (Required)
+ * run_id: String (Required)
+ * status: String(in_progress/cancelled/failed/completed/expired) (Required)
+ * step_details (Required): {
+ * type: String(message_creation/tool_calls) (Required)
+ * }
+ * last_error (Required): {
+ * code: String(server_error/rate_limit_exceeded) (Required)
+ * message: String (Required)
+ * }
+ * created_at: long (Required)
+ * expired_at: Long (Required)
+ * completed_at: Long (Required)
+ * cancelled_at: Long (Required)
+ * failed_at: Long (Required)
+ * usage (Optional): {
+ * completion_tokens: long (Required)
+ * prompt_tokens: long (Required)
+ * total_tokens: long (Required)
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of run steps from a thread run along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| purpose | String | No | The purpose of the file. Allowed values: "fine-tune", + * "fine-tune-results", "assistants", "assistants_output", "batch", "batch_output", "vision". |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * object: String (Required)
+ * id: String (Required)
+ * bytes: int (Required)
+ * filename: String (Required)
+ * created_at: long (Required)
+ * purpose: String(fine-tune/fine-tune-results/assistants/assistants_output/batch/batch_output/vision) (Required)
+ * status: String(uploaded/pending/running/processed/error/deleting/deleted) (Optional)
+ * status_details: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of previously uploaded files along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * id: String (Required)
+ * bytes: int (Required)
+ * filename: String (Required)
+ * created_at: long (Required)
+ * purpose: String(fine-tune/fine-tune-results/assistants/assistants_output/batch/batch_output/vision) (Required)
+ * status: String(uploaded/pending/running/processed/error/deleting/deleted) (Optional)
+ * status_details: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param body Multipart body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param fileId The ID of the file to delete.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a status response from a file deletion operation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * id: String (Required)
+ * bytes: int (Required)
+ * filename: String (Required)
+ * created_at: long (Required)
+ * purpose: String(fine-tune/fine-tune-results/assistants/assistants_output/batch/batch_output/vision) (Required)
+ * status: String(uploaded/pending/running/processed/error/deleting/deleted) (Optional)
+ * status_details: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param fileId The ID of the file to retrieve.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param fileId The ID of the file to retrieve.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * usage_bytes: int (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * status: String(expired/in_progress/completed) (Required)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * expires_at: Long (Optional)
+ * last_active_at: Long (Required)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response data for a requested list of items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * file_ids (Optional): [
+ * String (Optional)
+ * ]
+ * name: String (Optional)
+ * configuration (Optional): {
+ * data_sources (Required): [
+ * (Required){
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * ]
+ * }
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * chunking_strategy (Optional): {
+ * type: String(auto/static) (Required)
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * usage_bytes: int (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * status: String(expired/in_progress/completed) (Required)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * expires_at: Long (Optional)
+ * last_active_at: Long (Required)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param createVectorStoreRequest The createVectorStoreRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a vector store is a collection of processed files can be used by the `file_search` tool along with
+ * {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * usage_bytes: int (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * status: String(expired/in_progress/completed) (Required)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * expires_at: Long (Optional)
+ * last_active_at: Long (Required)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a vector store is a collection of processed files can be used by the `file_search` tool along with
+ * {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Optional)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * usage_bytes: int (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * status: String(expired/in_progress/completed) (Required)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * expires_at: Long (Optional)
+ * last_active_at: Long (Required)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param modifyVectorStoreRequest The modifyVectorStoreRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a vector store is a collection of processed files can be used by the `file_search` tool along with
+ * {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response object for deleting a vector store along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | Filter by file status. Allowed values: "in_progress", + * "completed", "failed", "cancelled". |
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * usage_bytes: int (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/failed/cancelled) (Required)
+ * last_error (Required): {
+ * code: String(server_error/invalid_file/unsupported_file) (Required)
+ * message: String (Required)
+ * }
+ * chunking_strategy (Required): {
+ * type: String(other/static) (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response data for a requested list of items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * chunking_strategy (Optional): {
+ * type: String(auto/static) (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * usage_bytes: int (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/failed/cancelled) (Required)
+ * last_error (Required): {
+ * code: String(server_error/invalid_file/unsupported_file) (Required)
+ * message: String (Required)
+ * }
+ * chunking_strategy (Required): {
+ * type: String(other/static) (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param createVectorStoreFileRequest The createVectorStoreFileRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return description of a file attached to a vector store along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * usage_bytes: int (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/failed/cancelled) (Required)
+ * last_error (Required): {
+ * code: String(server_error/invalid_file/unsupported_file) (Required)
+ * message: String (Required)
+ * }
+ * chunking_strategy (Required): {
+ * type: String(other/static) (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param fileId Identifier of the file.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return description of a file attached to a vector store along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param fileId Identifier of the file.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response object for deleting a vector store file relationship along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * file_ids (Optional): [
+ * String (Optional)
+ * ]
+ * data_sources (Optional): [
+ * (Optional){
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * ]
+ * chunking_strategy (Optional): {
+ * type: String(auto/static) (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/cancelled/failed) (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param createVectorStoreFileBatchRequest The createVectorStoreFileBatchRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a batch of files attached to a vector store along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/cancelled/failed) (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param batchId Identifier of the file batch.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a batch of files attached to a vector store along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/cancelled/failed) (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param batchId Identifier of the file batch.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a batch of files attached to a vector store along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | Filter by file status. Allowed values: "in_progress", + * "completed", "failed", "cancelled". |
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * usage_bytes: int (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/failed/cancelled) (Required)
+ * last_error (Required): {
+ * code: String(server_error/invalid_file/unsupported_file) (Required)
+ * message: String (Required)
+ * }
+ * chunking_strategy (Required): {
+ * type: String(other/static) (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param batchId Identifier of the file batch.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response data for a requested list of items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of threads that were previously created along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * model: String (Required)
+ * name: String (Optional)
+ * description: String (Optional)
+ * instructions: String (Optional)
+ * tools (Optional): [
+ * (Optional){
+ * type: 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Optional)
+ * top_p: Double (Optional)
+ * response_format: BinaryData (Optional)
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * description: String (Required)
+ * model: String (Required)
+ * instructions: String (Required)
+ * tools (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Required)
+ * top_p: Double (Required)
+ * response_format: BinaryData (Optional)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param createAgentRequest The createAgentRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * description: String (Required)
+ * model: String (Required)
+ * instructions: String (Required)
+ * tools (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Required)
+ * top_p: Double (Required)
+ * response_format: BinaryData (Optional)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of agents that were previously created along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * description: String (Required)
+ * model: String (Required)
+ * instructions: String (Required)
+ * tools (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Required)
+ * top_p: Double (Required)
+ * response_format: BinaryData (Optional)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param assistantId Identifier of the agent.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * model: String (Optional)
+ * name: String (Optional)
+ * description: String (Optional)
+ * instructions: String (Optional)
+ * tools (Optional): [
+ * (Optional){
+ * type: 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Optional)
+ * top_p: Double (Optional)
+ * response_format: BinaryData (Optional)
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * description: String (Required)
+ * model: String (Required)
+ * instructions: String (Required)
+ * tools (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * temperature: Double (Required)
+ * top_p: Double (Required)
+ * response_format: BinaryData (Optional)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param assistantId The ID of the agent to modify.
+ * @param updateAgentRequest The updateAgentRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param assistantId Identifier of the agent.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of an agent deletion operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param createThreadRequest The createThreadRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return information about a single thread associated with an agent along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return information about an existing thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId The ID of the thread to modify.
+ * @param updateThreadRequest The updateThreadRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return information about a single thread associated with an agent along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of a thread deletion operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * thread_id: String (Required)
+ * status: String(in_progress/incomplete/completed) (Required)
+ * incomplete_details (Required): {
+ * reason: String(content_filter/max_tokens/run_cancelled/run_failed/run_expired) (Required)
+ * }
+ * completed_at: Long (Required)
+ * incomplete_at: Long (Required)
+ * role: String(user/assistant) (Required)
+ * content (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * assistant_id: String (Required)
+ * run_id: String (Required)
+ * attachments (Required): [
+ * (Required){
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * tools (Required): [
+ * BinaryData (Required)
+ * ]
+ * }
+ * ]
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param createMessageRequest The createMessageRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a single, existing message within an agent thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| runId | String | No | Filter messages by the run ID that generated them. |
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * thread_id: String (Required)
+ * status: String(in_progress/incomplete/completed) (Required)
+ * incomplete_details (Required): {
+ * reason: String(content_filter/max_tokens/run_cancelled/run_failed/run_expired) (Required)
+ * }
+ * completed_at: Long (Required)
+ * incomplete_at: Long (Required)
+ * role: String(user/assistant) (Required)
+ * content (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * assistant_id: String (Required)
+ * run_id: String (Required)
+ * attachments (Required): [
+ * (Required){
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * tools (Required): [
+ * BinaryData (Required)
+ * ]
+ * }
+ * ]
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of messages that exist on a thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * thread_id: String (Required)
+ * status: String(in_progress/incomplete/completed) (Required)
+ * incomplete_details (Required): {
+ * reason: String(content_filter/max_tokens/run_cancelled/run_failed/run_expired) (Required)
+ * }
+ * completed_at: Long (Required)
+ * incomplete_at: Long (Required)
+ * role: String(user/assistant) (Required)
+ * content (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * assistant_id: String (Required)
+ * run_id: String (Required)
+ * attachments (Required): [
+ * (Required){
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * tools (Required): [
+ * BinaryData (Required)
+ * ]
+ * }
+ * ]
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param messageId Identifier of the message.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an existing message from an existing thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * thread_id: String (Required)
+ * status: String(in_progress/incomplete/completed) (Required)
+ * incomplete_details (Required): {
+ * reason: String(content_filter/max_tokens/run_cancelled/run_failed/run_expired) (Required)
+ * }
+ * completed_at: Long (Required)
+ * incomplete_at: Long (Required)
+ * role: String(user/assistant) (Required)
+ * content (Required): [
+ * (Required){
+ * type: String (Required)
+ * }
+ * ]
+ * assistant_id: String (Required)
+ * run_id: String (Required)
+ * attachments (Required): [
+ * (Required){
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * tools (Required): [
+ * BinaryData (Required)
+ * ]
+ * }
+ * ]
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param messageId Identifier of the message.
+ * @param updateMessageRequest The updateMessageRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a single, existing message within an agent thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| include[] | List<String> | No | A list of additional fields to include in the + * response. + * Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the + * file search result content. In the form of "," separated string. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * assistant_id: String (Required)
+ * model: String (Optional)
+ * instructions: String (Optional)
+ * additional_instructions: String (Optional)
+ * additional_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)
+ * }
+ * }
+ * ]
+ * tools (Optional): [
+ * (Optional){
+ * type: String (Required)
+ * }
+ * ]
+ * 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
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param createRunRequest The createRunRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of runs for a specified thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an existing run from an existing thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param updateRunRequest The updateRunRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * tool_outputs (Required): [
+ * (Required){
+ * tool_call_id: String (Optional)
+ * output: String (Optional)
+ * }
+ * ]
+ * stream: Boolean (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param submitToolOutputsToRunRequest The submitToolOutputsToRunRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * model: String (Optional)
+ * instructions: String (Optional)
+ * tools (Optional): [
+ * (Optional){
+ * type: String (Required)
+ * }
+ * ]
+ * tool_resources (Optional): {
+ * code_interpreter (Optional): {
+ * file_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): (recursive schema, see azure_ai_search 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
+ * + *
+ * {@code
+ * {
+ * 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)
+ * ]
+ * }
+ * file_search (Optional): {
+ * vector_store_ids (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * azure_ai_search (Optional): {
+ * indexes (Optional): [
+ * (Optional){
+ * index_connection_id: String (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * parallel_tool_calls: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param createThreadAndRunRequest The createThreadAndRunRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return data representing a single evaluation run of an agent thread along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| include[] | List<String> | No | A list of additional fields to include in the + * response. + * Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the + * file search result content. In the form of "," separated string. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * type: String(message_creation/tool_calls) (Required)
+ * assistant_id: String (Required)
+ * thread_id: String (Required)
+ * run_id: String (Required)
+ * status: String(in_progress/cancelled/failed/completed/expired) (Required)
+ * step_details (Required): {
+ * type: String(message_creation/tool_calls) (Required)
+ * }
+ * last_error (Required): {
+ * code: String(server_error/rate_limit_exceeded) (Required)
+ * message: String (Required)
+ * }
+ * created_at: long (Required)
+ * expired_at: Long (Required)
+ * completed_at: Long (Required)
+ * cancelled_at: Long (Required)
+ * failed_at: Long (Required)
+ * usage (Optional): {
+ * completion_tokens: long (Required)
+ * prompt_tokens: long (Required)
+ * total_tokens: long (Required)
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param stepId Identifier of the run step.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a single run step from a thread run along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| include[] | List<String> | No | A list of additional fields to include in the + * response. + * Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the + * file search result content. In the form of "," separated string. |
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * type: String(message_creation/tool_calls) (Required)
+ * assistant_id: String (Required)
+ * thread_id: String (Required)
+ * run_id: String (Required)
+ * status: String(in_progress/cancelled/failed/completed/expired) (Required)
+ * step_details (Required): {
+ * type: String(message_creation/tool_calls) (Required)
+ * }
+ * last_error (Required): {
+ * code: String(server_error/rate_limit_exceeded) (Required)
+ * message: String (Required)
+ * }
+ * created_at: long (Required)
+ * expired_at: Long (Required)
+ * completed_at: Long (Required)
+ * cancelled_at: Long (Required)
+ * failed_at: Long (Required)
+ * usage (Optional): {
+ * completion_tokens: long (Required)
+ * prompt_tokens: long (Required)
+ * total_tokens: long (Required)
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param threadId Identifier of the thread.
+ * @param runId Identifier of the run.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of run steps from a thread run along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| purpose | String | No | The purpose of the file. Allowed values: "fine-tune", + * "fine-tune-results", "assistants", "assistants_output", "batch", "batch_output", "vision". |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * object: String (Required)
+ * id: String (Required)
+ * bytes: int (Required)
+ * filename: String (Required)
+ * created_at: long (Required)
+ * purpose: String(fine-tune/fine-tune-results/assistants/assistants_output/batch/batch_output/vision) (Required)
+ * status: String(uploaded/pending/running/processed/error/deleting/deleted) (Optional)
+ * status_details: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of previously uploaded files along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * id: String (Required)
+ * bytes: int (Required)
+ * filename: String (Required)
+ * created_at: long (Required)
+ * purpose: String(fine-tune/fine-tune-results/assistants/assistants_output/batch/batch_output/vision) (Required)
+ * status: String(uploaded/pending/running/processed/error/deleting/deleted) (Optional)
+ * status_details: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param body Multipart body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param fileId The ID of the file to delete.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a status response from a file deletion operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * id: String (Required)
+ * bytes: int (Required)
+ * filename: String (Required)
+ * created_at: long (Required)
+ * purpose: String(fine-tune/fine-tune-results/assistants/assistants_output/batch/batch_output/vision) (Required)
+ * status: String(uploaded/pending/running/processed/error/deleting/deleted) (Optional)
+ * status_details: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param fileId The ID of the file to retrieve.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represents an agent that can call the model and use tools along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param fileId The ID of the file to retrieve.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * usage_bytes: int (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * status: String(expired/in_progress/completed) (Required)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * expires_at: Long (Optional)
+ * last_active_at: Long (Required)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response data for a requested list of items along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * file_ids (Optional): [
+ * String (Optional)
+ * ]
+ * name: String (Optional)
+ * configuration (Optional): {
+ * data_sources (Required): [
+ * (Required){
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * ]
+ * }
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * chunking_strategy (Optional): {
+ * type: String(auto/static) (Required)
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * usage_bytes: int (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * status: String(expired/in_progress/completed) (Required)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * expires_at: Long (Optional)
+ * last_active_at: Long (Required)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param createVectorStoreRequest The createVectorStoreRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a vector store is a collection of processed files can be used by the `file_search` tool along with
+ * {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * usage_bytes: int (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * status: String(expired/in_progress/completed) (Required)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * expires_at: Long (Optional)
+ * last_active_at: Long (Required)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a vector store is a collection of processed files can be used by the `file_search` tool along with
+ * {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Optional)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * metadata (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * name: String (Required)
+ * usage_bytes: int (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * status: String(expired/in_progress/completed) (Required)
+ * expires_after (Optional): {
+ * anchor: String(last_active_at) (Required)
+ * days: int (Required)
+ * }
+ * expires_at: Long (Optional)
+ * last_active_at: Long (Required)
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param modifyVectorStoreRequest The modifyVectorStoreRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a vector store is a collection of processed files can be used by the `file_search` tool along with
+ * {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response object for deleting a vector store along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | Filter by file status. Allowed values: "in_progress", + * "completed", "failed", "cancelled". |
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * usage_bytes: int (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/failed/cancelled) (Required)
+ * last_error (Required): {
+ * code: String(server_error/invalid_file/unsupported_file) (Required)
+ * message: String (Required)
+ * }
+ * chunking_strategy (Required): {
+ * type: String(other/static) (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response data for a requested list of items along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * file_id: String (Optional)
+ * data_source (Optional): {
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * chunking_strategy (Optional): {
+ * type: String(auto/static) (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * usage_bytes: int (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/failed/cancelled) (Required)
+ * last_error (Required): {
+ * code: String(server_error/invalid_file/unsupported_file) (Required)
+ * message: String (Required)
+ * }
+ * chunking_strategy (Required): {
+ * type: String(other/static) (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param createVectorStoreFileRequest The createVectorStoreFileRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return description of a file attached to a vector store along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * usage_bytes: int (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/failed/cancelled) (Required)
+ * last_error (Required): {
+ * code: String(server_error/invalid_file/unsupported_file) (Required)
+ * message: String (Required)
+ * }
+ * chunking_strategy (Required): {
+ * type: String(other/static) (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param fileId Identifier of the file.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return description of a file attached to a vector store along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * deleted: boolean (Required)
+ * object: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param fileId Identifier of the file.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response object for deleting a vector store file relationship along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * file_ids (Optional): [
+ * String (Optional)
+ * ]
+ * data_sources (Optional): [
+ * (Optional){
+ * uri: String (Required)
+ * type: String(uri_asset/id_asset) (Required)
+ * }
+ * ]
+ * chunking_strategy (Optional): {
+ * type: String(auto/static) (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/cancelled/failed) (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param createVectorStoreFileBatchRequest The createVectorStoreFileBatchRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a batch of files attached to a vector store along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/cancelled/failed) (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param batchId Identifier of the file batch.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a batch of files attached to a vector store along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/cancelled/failed) (Required)
+ * file_counts (Required): {
+ * in_progress: int (Required)
+ * completed: int (Required)
+ * failed: int (Required)
+ * cancelled: int (Required)
+ * total: int (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param batchId Identifier of the file batch.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a batch of files attached to a vector store along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | Filter by file status. Allowed values: "in_progress", + * "completed", "failed", "cancelled". |
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * usage_bytes: int (Required)
+ * created_at: long (Required)
+ * vector_store_id: String (Required)
+ * status: String(in_progress/completed/failed/cancelled) (Required)
+ * last_error (Required): {
+ * code: String(server_error/invalid_file/unsupported_file) (Required)
+ * message: String (Required)
+ * }
+ * chunking_strategy (Required): {
+ * type: String(other/static) (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param vectorStoreId Identifier of the vector store.
+ * @param batchId Identifier of the file batch.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response data for a requested list of items along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Integer | No | A limit on the number of objects to be returned. Limit can range + * between 1 and 100, and the default is 20. |
| order | String | No | Sort order by the created_at timestamp of the objects. asc for + * ascending order and desc for descending order. Allowed values: "asc", "desc". |
| after | String | No | 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. |
| before | String | No | 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * object: String (Required)
+ * data (Required): [
+ * (Required){
+ * id: String (Required)
+ * object: String (Required)
+ * created_at: long (Required)
+ * tool_resources (Required): {
+ * 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 (Required)
+ * index_name: String (Required)
+ * query_type: String(simple/semantic/vector/vector_simple_hybrid/vector_semantic_hybrid) (Optional)
+ * top_k: Integer (Optional)
+ * filter: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ * metadata (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * ]
+ * first_id: String (Required)
+ * last_id: String (Required)
+ * has_more: boolean (Required)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a list of threads that were previously created along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * applicationInsights: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the properties of the specified machine learning workspace along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| category | String | No | Category of the workspace connection. Allowed values: + * "AzureOpenAI", "Serverless", "AzureBlob", "AIServices", "CognitiveSearch", "ApiKey", "CustomKeys", + * "CognitiveService". |
| includeAll | Boolean | No | Indicates whether to list datastores. Service default: do + * not list datastores. |
| target | String | No | Target of the workspace connection. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * authType: String(ApiKey/AAD/SAS/CustomKeys/None) (Required)
+ * category: String(AzureOpenAI/Serverless/AzureBlob/AIServices/CognitiveSearch/ApiKey/CustomKeys/CognitiveService) (Required)
+ * target: String (Required)
+ * }
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response from the list operation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * authType: String(ApiKey/AAD/SAS/CustomKeys/None) (Required)
+ * category: String(AzureOpenAI/Serverless/AzureBlob/AIServices/CognitiveSearch/ApiKey/CustomKeys/CognitiveService) (Required)
+ * target: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param connectionName Connection Name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the details of a single connection, without credentials along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * ignored: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * authType: String(ApiKey/AAD/SAS/CustomKeys/None) (Required)
+ * category: String(AzureOpenAI/Serverless/AzureBlob/AIServices/CognitiveSearch/ApiKey/CustomKeys/CognitiveService) (Required)
+ * target: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param connectionName Connection Name.
+ * @param getConnectionWithSecretsRequest The getConnectionWithSecretsRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the details of a single connection, including credentials (if available) along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * applicationInsights: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the properties of the specified machine learning workspace along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| category | String | No | Category of the workspace connection. Allowed values: + * "AzureOpenAI", "Serverless", "AzureBlob", "AIServices", "CognitiveSearch", "ApiKey", "CustomKeys", + * "CognitiveService". |
| includeAll | Boolean | No | Indicates whether to list datastores. Service default: do + * not list datastores. |
| target | String | No | Target of the workspace connection. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * authType: String(ApiKey/AAD/SAS/CustomKeys/None) (Required)
+ * category: String(AzureOpenAI/Serverless/AzureBlob/AIServices/CognitiveSearch/ApiKey/CustomKeys/CognitiveService) (Required)
+ * target: String (Required)
+ * }
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response from the list operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * authType: String(ApiKey/AAD/SAS/CustomKeys/None) (Required)
+ * category: String(AzureOpenAI/Serverless/AzureBlob/AIServices/CognitiveSearch/ApiKey/CustomKeys/CognitiveService) (Required)
+ * target: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param connectionName Connection Name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the details of a single connection, without credentials along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * ignored: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * authType: String(ApiKey/AAD/SAS/CustomKeys/None) (Required)
+ * category: String(AzureOpenAI/Serverless/AzureBlob/AIServices/CognitiveSearch/ApiKey/CustomKeys/CognitiveService) (Required)
+ * target: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param connectionName Connection Name.
+ * @param getConnectionWithSecretsRequest The getConnectionWithSecretsRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the details of a single connection, including credentials (if available) along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param id Identifier of the evaluation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Definition along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param evaluation Evaluation to run.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Definition along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Evaluation items as paginated response with {@link PagedFlux}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param id Identifier of the evaluation.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Definition along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * data (Required): {
+ * type: String (Required)
+ * resourceId: String (Optional, Required on create)
+ * query: String (Optional, Required on create)
+ * serviceName: String (Optional)
+ * connectionString: String (Optional)
+ * }
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * provisioningState: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * isEnabled: String (Optional)
+ * evaluators (Required): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * trigger (Required): {
+ * type: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param name Name of the schedule, which also serves as the unique identifier for the evaluation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Schedule Definition along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * data (Required): {
+ * type: String (Required)
+ * resourceId: String (Optional, Required on create)
+ * query: String (Optional, Required on create)
+ * serviceName: String (Optional)
+ * connectionString: String (Optional)
+ * }
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * provisioningState: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * isEnabled: String (Optional)
+ * evaluators (Required): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * trigger (Required): {
+ * type: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * data (Required): {
+ * type: String (Required)
+ * resourceId: String (Optional, Required on create)
+ * query: String (Optional, Required on create)
+ * serviceName: String (Optional)
+ * connectionString: String (Optional)
+ * }
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * provisioningState: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * isEnabled: String (Optional)
+ * evaluators (Required): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * trigger (Required): {
+ * type: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param name Name of the schedule, which also serves as the unique identifier for the evaluation.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Schedule Definition along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * data (Required): {
+ * type: String (Required)
+ * resourceId: String (Optional, Required on create)
+ * query: String (Optional, Required on create)
+ * serviceName: String (Optional)
+ * connectionString: String (Optional)
+ * }
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * provisioningState: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * isEnabled: String (Optional)
+ * evaluators (Required): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * trigger (Required): {
+ * type: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of EvaluationSchedule items as paginated response with {@link PagedFlux}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param id Identifier of the evaluation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Definition along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param evaluation Evaluation to run.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Definition along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Evaluation items as paginated response with {@link PagedIterable}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * data (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * target (Optional): {
+ * systemMessage: String (Optional, Required on create)
+ * modelConfig (Optional, Required on create): {
+ * type: String (Required)
+ * }
+ * modelParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * displayName: String (Optional)
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * status: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * evaluators (Optional, Required on create): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param id Identifier of the evaluation.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Definition along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * data (Required): {
+ * type: String (Required)
+ * resourceId: String (Optional, Required on create)
+ * query: String (Optional, Required on create)
+ * serviceName: String (Optional)
+ * connectionString: String (Optional)
+ * }
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * provisioningState: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * isEnabled: String (Optional)
+ * evaluators (Required): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * trigger (Required): {
+ * type: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param name Name of the schedule, which also serves as the unique identifier for the evaluation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Schedule Definition along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * data (Required): {
+ * type: String (Required)
+ * resourceId: String (Optional, Required on create)
+ * query: String (Optional, Required on create)
+ * serviceName: String (Optional)
+ * connectionString: String (Optional)
+ * }
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * provisioningState: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * isEnabled: String (Optional)
+ * evaluators (Required): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * trigger (Required): {
+ * type: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * data (Required): {
+ * type: String (Required)
+ * resourceId: String (Optional, Required on create)
+ * query: String (Optional, Required on create)
+ * serviceName: String (Optional)
+ * connectionString: String (Optional)
+ * }
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * provisioningState: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * isEnabled: String (Optional)
+ * evaluators (Required): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * trigger (Required): {
+ * type: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param name Name of the schedule, which also serves as the unique identifier for the evaluation.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return evaluation Schedule Definition along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * data (Required): {
+ * type: String (Required)
+ * resourceId: String (Optional, Required on create)
+ * query: String (Optional, Required on create)
+ * serviceName: String (Optional)
+ * connectionString: String (Optional)
+ * }
+ * description: String (Optional)
+ * systemData (Optional): {
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * }
+ * provisioningState: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * properties (Optional): {
+ * String: String (Required)
+ * }
+ * isEnabled: String (Optional)
+ * evaluators (Required): {
+ * String (Required): {
+ * id: String (Optional, Required on create)
+ * initParams (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * dataMapping (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * trigger (Required): {
+ * type: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of EvaluationSchedule items as paginated response with {@link PagedIterable}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * name: String (Required)
+ * properties (Required): {
+ * ConnectionString: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param appInsightsResourceUrl The AppInsights Azure resource Url. It should have the format:
+ * '/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/microsoft.insights/components/{resourcename}'.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the properties of the specified Application Insights resource along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ Mono